|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.widget.tips.ToolTipConfig
public class ToolTipConfig
Configuration information for a tool tip.
Constructor Summary | |
---|---|
ToolTipConfig()
Creates a new tool tip config. |
|
ToolTipConfig(java.lang.String text)
Creates a new tool tip config with the given text. |
|
ToolTipConfig(java.lang.String title,
java.lang.String text)
Creates a new tool tip config with the given title and text. |
Method Summary | |
---|---|
java.lang.String |
getAnchor()
Returns the anchor position. |
int |
getAnchorOffset()
Returns the distance in pixels of the tooltip and target element. |
int |
getDismissDelay()
Returns the dismiss delay. |
int |
getHideDelay()
Returns the hide delay in milliseconds. |
int |
getMaxWidth()
Returns the tooltip's maximum width. |
int |
getMinWidth()
Returns the tooltip's minimum width. |
int[] |
getMouseOffset()
Returns the mouse offset. |
Params |
getParams()
Returns the params. |
int |
getShowDelay()
Returns the show delay in milliseconds. |
Template |
getTemplate()
Returns the template. |
java.lang.String |
getText()
Returns the tool tip text. |
java.lang.String |
getTitle()
Returns the tool tip title. |
boolean |
isAnchorToTarget()
Returns true if the tooltip is anchored to the target. |
boolean |
isAutoHide()
Returns true if auto hide is enabled. |
boolean |
isCloseable()
Returns true if the tip is closable. |
boolean |
isEnabled()
Returns true if the tool tip is enabled. |
boolean |
isTrackMouse()
Returns true if mouse tracking is enabled. |
void |
setAnchor(java.lang.String anchor)
Sets the anchor position (defaults to "bottom"). |
void |
setAnchorOffset(int anchorOffset)
A numeric pixel value used to offset the default position of the anchor arrow (defaults to 0). |
void |
setAnchorToTarget(boolean anchorToTarget)
True to anchor the tooltip to the target element, false to anchor it relative to the mouse coordinates (defaults to true). |
void |
setAutoHide(boolean autoHide)
True to automatically hide the tooltip after the mouse exits the target element or after the dismissDelay has expired if set (defaults to
true). |
void |
setCloseable(boolean closeable)
True to render a close tool button into the tooltip header (defaults to false). |
void |
setDismissDelay(int dismissDelay)
Delay in milliseconds before the tooltip automatically hides (defaults to 5000). |
void |
setEnabled(boolean enabled)
Sets whether the tool tip is enabled (defaults to true). |
void |
setHideDelay(int hideDelay)
Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200). |
void |
setMaxWidth(int maxWidth)
Sets the tooltip's maximum width (defaults to 300). |
void |
setMinWidth(int minWidth)
Sets the tooltip's minimum width (defaults to 40). |
void |
setMouseOffset(int[] mouseOffset)
An XY offset from the mouse position where the tooltip should be shown (defaults to [15,18]). |
void |
setParams(Params params)
The parameters to be used when a custom a template is specified. |
void |
setShowDelay(int showDelay)
Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500). |
void |
setTemplate(Template template)
A optional template to be used to render the tool tip. |
void |
setText(java.lang.String text)
The tool tip text. |
void |
setTitle(java.lang.String title)
Sets the tool tip title. |
void |
setTrackMouse(boolean trackMouse)
True to have the tooltip follow the mouse as it moves over the target element (defaults to false). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ToolTipConfig()
public ToolTipConfig(java.lang.String text)
text
- the tool tip textpublic ToolTipConfig(java.lang.String title, java.lang.String text)
title
- the tool tip titletext
- the tool tip textMethod Detail |
---|
public java.lang.String getAnchor()
public int getAnchorOffset()
public int getDismissDelay()
public int getHideDelay()
public int getMaxWidth()
public int getMinWidth()
public int[] getMouseOffset()
public Params getParams()
public int getShowDelay()
public Template getTemplate()
public java.lang.String getText()
public java.lang.String getTitle()
public boolean isAnchorToTarget()
public boolean isAutoHide()
public boolean isCloseable()
public boolean isEnabled()
public boolean isTrackMouse()
public void setAnchor(java.lang.String anchor)
anchor
- the anchor position (top, bottom, left, right)public void setAnchorOffset(int anchorOffset)
anchorOffset
will be used as a horizontal offset.
Likewise, when the anchor position is on the left or right side,
anchorOffset
will be used as a vertical offset.
anchorOffset
- the offset in pixelspublic void setAnchorToTarget(boolean anchorToTarget)
anchorToTarget
- true to anchor the tooltip to the target elementpublic void setAutoHide(boolean autoHide)
dismissDelay
has expired if set (defaults to
true).
autoHide
- the auto hide statepublic void setCloseable(boolean closeable)
closeable
- the closable statepublic void setDismissDelay(int dismissDelay)
dismissDelay
- the dismiss delaypublic void setEnabled(boolean enabled)
enabled
- true to enablepublic void setHideDelay(int hideDelay)
hideDelay
- the hide delaypublic void setMaxWidth(int maxWidth)
maxWidth
- the maximum width in pixelspublic void setMinWidth(int minWidth)
minWidth
- the minimum widthpublic void setMouseOffset(int[] mouseOffset)
mouseOffset
- the offsetpublic void setParams(Params params)
template
is specified.
params
- the parameterspublic void setShowDelay(int showDelay)
showDelay
- the show delaypublic void setTemplate(Template template)
params
will be applied to the template. If specified, title
and
text
will be added to the params before being applied to the
template.
template
- the templatepublic void setText(java.lang.String text)
text
- the textpublic void setTitle(java.lang.String title)
title
- the titlepublic void setTrackMouse(boolean trackMouse)
trackMouse
- the track mouse state
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |