public final class InfoTip
extends java.lang.Object
Hoverable InfoTips are created by an instance of InfoTipHover once the hover mechanism detects the mouse hovering over a registered component. Hoverable infoTips will also close automatically once the mouse moves away. Hoverable InfoTips are not created directly, See InfoTipHover for how to create a hoverable InfoTip type.
Plain non-hoverable InfoTips act like 'balloons' and float next to a component offering extra detail, until they are closed by the user or programatically. The current location of the mouse is irrelevant to this type of InfoTip.
The content of an InfoTip is formatted and contained byone of the templates from the templates subpackage.
A component in an infotip can look different to how the same component would look in a regular window. The look must be manually adjusted to follow the guidelines for an InfoTip by using the appropriate methods in InfoTipStyles.
Modifier and Type | Field and Description |
---|---|
static int |
DISPLAY_TIME_ACTION_FAILURE
Recommended time to live for a balloon showing notification of a failed
action.
|
static int |
DISPLAY_TIME_ACTION_SUCCESS
Recommended time to live for a balloon showing notification of a successful
action.
|
static int |
DISPLAY_TIME_OPTIONAL_USER_TASK
Recommended time to live for a balloon showing notification of an optional
user task.
|
static java.lang.String |
PROPERTY_VISIBLE
Property name for event fired when the info tip is shown or hidden.
|
Constructor and Description |
---|
InfoTip()
Create an InfoTip.
|
InfoTip(Template template)
Create an InfoTip.
|
InfoTip(Template template,
InfoTipStyles style)
Create an InfoTip.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l) |
void |
ensureVisible()
Ensure the InfoTip is fully visible.
|
java.awt.Rectangle |
getBounds() |
InfoTipOrientation |
getOrientation() |
void |
hide()
Remove the InfoTip from the screen.
|
boolean |
isShowBounds() |
boolean |
isShowing() |
void |
pack()
Packs the infotip so that it sizes to the preferred size of it's contents (or as close as possible).
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l) |
void |
setContent(Template template)
Set the base component that is the content of an infotip.
|
void |
setDisplayTime(int displayTime)
Set the time to display the InfoTip before automatically closing it.
|
void |
setLocation(java.awt.Rectangle location)
Set the location of the InfoTip (in parent coords).
|
void |
setOrientation(InfoTipOrientation orientation)
Describe how the InfoTip should be placed next to the location it points to.
|
void |
setShowBounds(boolean showBounds)
Set to true to render a highlight around the location of the infotip.
|
void |
show(javax.swing.JComponent component)
Show the InfoTip pointing to the nearest edge of the given parent component.
|
void |
show(javax.swing.JComponent component,
java.awt.Point location)
Show the InfoTip pointing to the given location in the given component.
|
void |
show(javax.swing.JComponent component,
java.awt.Rectangle location)
Show the infotip pointing to the given area.
|
public static final java.lang.String PROPERTY_VISIBLE
public static final int DISPLAY_TIME_ACTION_SUCCESS
public static final int DISPLAY_TIME_ACTION_FAILURE
public static final int DISPLAY_TIME_OPTIONAL_USER_TASK
public InfoTip()
public InfoTip(Template template)
template
- the template containing the contents to be shown in the InfoTippublic InfoTip(Template template, InfoTipStyles style)
template
- the template containing the contents to be shown in the InfoTipstyle
- the style of the InfoTip. The look of the content should match the style.public void setContent(Template template)
template
- the infotip.templates.Template that contains the contentpublic InfoTipOrientation getOrientation()
public void setOrientation(InfoTipOrientation orientation)
orientation
- public void setShowBounds(boolean showBounds)
showBounds
- public boolean isShowBounds()
public void setLocation(java.awt.Rectangle location)
public java.awt.Rectangle getBounds()
public void show(javax.swing.JComponent component, java.awt.Point location)
component
- the component the tip points to.location
- public void show(javax.swing.JComponent component)
component
- the component the tip points to.public boolean isShowing()
public void show(javax.swing.JComponent component, java.awt.Rectangle location)
component
- the component the tip points to.location
- public void pack()
public void ensureVisible()
public void hide()
public void setDisplayTime(int displayTime)
If the InfoTip is already showing then the tip will show for the new time from starting from the moment of this call.
It is recommended that theh display time (if set) is one of the standard display times declared by this class (DISPLAY_TIME_*)
displayTime
- (in milliseconds), or -1 for no timed auto close.public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)