Package com.explodingpixels.macwidgets
Class HudWindow
- java.lang.Object
-
- com.explodingpixels.macwidgets.HudWindow
-
public class HudWindow extends java.lang.Object
An implementation of an OS X Transparent Panel, also known as a Heads Up Display (HUD). For a full descrption of what a Transparent Panel is, see the Transparent Panels section of Apple's Human Interface Guidelines.
HUD's are designed to offer a lightweight way to unobtrusivley offer controls to the user. The window looks like this:
As Apple points out, this component is not appropriate for all situations and should be used judiciously.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.swing.JComponent
getContentPane()
Gets theJComponent
to add content to.javax.swing.JDialog
getJDialog()
Gets theJDialog
backing thisHudWindow
.void
hideCloseButton()
Hides the close button on this HUD's title bar.void
makeResizeable()
Makes this HUD resizeable.void
setContentPane(javax.swing.JComponent contentPane)
Sets theJComponent
to use as the container for thisHudWindow
's content.
-
-
-
Constructor Detail
-
HudWindow
public HudWindow()
Creates a Heads Up Display style window.
-
HudWindow
public HudWindow(java.lang.String title)
Creates a Heads Up Display style window.- Parameters:
title
- the title to use for this window.
-
HudWindow
public HudWindow(java.lang.String title, java.awt.Frame owner)
Creates a Heads Up Display style window.- Parameters:
title
- the title to use for this window.owner
- theFrame
that this HUD is parented to. Can be null.
-
-
Method Detail
-
getJDialog
public javax.swing.JDialog getJDialog()
Gets theJDialog
backing thisHudWindow
.- Returns:
- the
JDialog
backing thisHudWindow
.
-
hideCloseButton
public void hideCloseButton()
Hides the close button on this HUD's title bar.
-
makeResizeable
public void makeResizeable()
Makes this HUD resizeable. Note that there is currently a bug in the Mac JRE which causes a very bad flicker when a window is programmatically resized. For now, it's suggested that you do not use this method unless you are on a non-Mac platform.
-
getContentPane
public javax.swing.JComponent getContentPane()
Gets theJComponent
to add content to.- Returns:
- the container to add content to.
-
setContentPane
public void setContentPane(javax.swing.JComponent contentPane)
Sets theJComponent
to use as the container for thisHudWindow
's content.- Parameters:
contentPane
- the container for thisHudWindow
's content.
-
-