@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UITooltip extends AbstractTooltip implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxProps, CoreProps, EventsMouseProps, EventsPopupsBeforeProps, EventsPopupsProps, I18nProps, PopupsProps, PositionProps, AbstractDivPanel, MetaComponentEncoder, MetaComponentResolver
The <r:tooltip> component provides an informational tool-tip. The tool-tip can be attached to any control and is displayed when hovering the mouse cursor over the control.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UITooltip.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
CONTENT_META_COMPONENT_IDATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
UITooltip() |
| Modifier and Type | Method and Description |
|---|---|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
String |
getDir()
Direction indication for text that does not inherit directionality.
|
Positioning |
getDirection()
Set the direction of the popup.
|
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
int |
getHideDelay()
Delay in milliseconds before tooltip will be hidden.
|
String |
getHideEvent()
Event that triggers the tooltip disappearance.
|
int |
getHorizontalOffset()
Sets the horizontal offset between pop-up list and mouse pointer.
|
Positioning |
getJointPoint()
Set the corner attachment point with which the popup should be connected.
|
String |
getLang()
Code describing the language used in the generated markup for this component.
|
TooltipLayout |
getLayout()
Block/inline mode flag.
|
TooltipMode |
getMode()
Controls the way of data loading to a tooltip.
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbeforehide()
The client-side code executed before the popup disappears.
|
String |
getOnbeforeshow()
The client-side code executed before this component is shown.
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnhide()
The client-side code executed after the popup disappears.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOnshow()
The client-side code executed after the popup is shown.
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
int |
getShowDelay()
Delay in milliseconds before tooltip will be displayed.
|
String |
getShowEvent()
Event that triggers the tooltip.
|
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
int |
getVerticalOffset()
Sets the vertical offset between pop-up list and mouse pointer.
|
int |
getZindex()
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content.
|
boolean |
isAttached()
If the value of the "attached" attribute is "true", a component is attached to the parent component; if "false",
component does not listen to activating browser events, but could be activated externally.
|
boolean |
isFollowMouse()
If "true" tooltip should follow the mouse while it moves over the parent element.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
void |
setAttached(boolean attached) |
void |
setData(Object data) |
void |
setDir(String dir) |
void |
setDirection(Positioning direction) |
void |
setExecute(Object execute) |
void |
setFollowMouse(boolean followMouse) |
void |
setHideDelay(int hideDelay) |
void |
setHideEvent(String hideEvent) |
void |
setHorizontalOffset(int horizontalOffset) |
void |
setJointPoint(Positioning jointPoint) |
void |
setLang(String lang) |
void |
setLayout(TooltipLayout layout) |
void |
setLimitRender(boolean limitRender) |
void |
setMode(TooltipMode mode) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbeforehide(String onbeforehide) |
void |
setOnbeforeshow(String onbeforeshow) |
void |
setOnbegin(String onbegin) |
void |
setOnclick(String onclick) |
void |
setOncomplete(String oncomplete) |
void |
setOndblclick(String ondblclick) |
void |
setOnhide(String onhide) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOnshow(String onshow) |
void |
setRender(Object render) |
void |
setShowDelay(int showDelay) |
void |
setShowEvent(String showEvent) |
void |
setStatus(String status) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTitle(String title) |
void |
setVerticalOffset(int verticalOffset) |
void |
setZindex(int zindex) |
encodeMetaComponent, getContentClientId, getTarget, resolveClientId, setTarget, substituteUnresolvedClientId, visitTreeclearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValueaddClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpressionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsencodeMetaComponentresolveClientId, substituteUnresolvedClientIdpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class AbstractTooltippublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic boolean isAttached()
AbstractTooltipisAttached in class AbstractTooltippublic void setAttached(boolean attached)
public Object getData()
AjaxPropspublic void setData(Object data)
public String getDir()
I18nPropspublic void setDir(String dir)
public Positioning getDirection()
PositionPropsSet the direction of the popup. Possible values are:
AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft),
RA (autoRight), AT (topAuto), AB (bottomAuto)
Default value is auto
getDirection in interface PositionPropsgetDirection in class AbstractTooltippublic void setDirection(Positioning direction)
public Object getExecute()
AjaxPropsgetExecute in interface AjaxPropsgetExecute in class AbstractTooltippublic void setExecute(Object execute)
public boolean isFollowMouse()
AbstractTooltipisFollowMouse in class AbstractTooltippublic void setFollowMouse(boolean followMouse)
public int getHideDelay()
AbstractTooltipgetHideDelay in class AbstractTooltippublic void setHideDelay(int hideDelay)
public String getHideEvent()
AbstractTooltipgetHideEvent in class AbstractTooltippublic void setHideEvent(String hideEvent)
public int getHorizontalOffset()
AbstractTooltipgetHorizontalOffset in interface PositionPropsgetHorizontalOffset in class AbstractTooltippublic void setHorizontalOffset(int horizontalOffset)
public Positioning getJointPoint()
PositionPropsSet the corner attachment point with which the popup should be connected. Possible values are:
AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft),
RA (autoRight), AT (topAuto), AB (bottomAuto)
Default value is auto
getJointPoint in interface PositionPropsgetJointPoint in class AbstractTooltippublic void setJointPoint(Positioning jointPoint)
public String getLang()
I18nPropspublic void setLang(String lang)
public TooltipLayout getLayout()
AbstractTooltipgetLayout in class AbstractTooltippublic void setLayout(TooltipLayout layout)
public boolean isLimitRender()
AjaxPropsisLimitRender in interface AjaxPropspublic void setLimitRender(boolean limitRender)
public TooltipMode getMode()
AbstractTooltipgetMode in class AbstractTooltippublic void setMode(TooltipMode mode)
public String getOnbeforedomupdate()
AjaxEventsPropsgetOnbeforedomupdate in interface AjaxEventsPropspublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforehide()
EventsPopupsBeforePropsgetOnbeforehide in interface EventsPopupsBeforePropsgetOnbeforehide in class AbstractTooltippublic void setOnbeforehide(String onbeforehide)
public String getOnbeforeshow()
EventsPopupsBeforePropsgetOnbeforeshow in interface EventsPopupsBeforePropsgetOnbeforeshow in class AbstractTooltippublic void setOnbeforeshow(String onbeforeshow)
public String getOnbegin()
AjaxEventsPropsgetOnbegin in interface AjaxEventsPropspublic void setOnbegin(String onbegin)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOncomplete()
AjaxEventsPropsgetOncomplete in interface AjaxEventsPropspublic void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnhide()
EventsPopupsPropsgetOnhide in interface EventsPopupsPropsgetOnhide in class AbstractTooltippublic void setOnhide(String onhide)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getOnshow()
EventsPopupsPropsgetOnshow in interface EventsPopupsPropsgetOnshow in class AbstractTooltippublic void setOnshow(String onshow)
public Object getRender()
AjaxPropspublic void setRender(Object render)
public int getShowDelay()
AbstractTooltipgetShowDelay in class AbstractTooltippublic void setShowDelay(int showDelay)
public String getShowEvent()
AbstractTooltipgetShowEvent in class AbstractTooltippublic void setShowEvent(String showEvent)
public String getStatus()
AjaxPropspublic void setStatus(String status)
public String getStyle()
CorePropsgetStyle in interface CorePropsgetStyle in class AbstractTooltippublic void setStyle(String style)
public String getStyleClass()
CorePropsgetStyleClass in interface CorePropsgetStyleClass in class AbstractTooltippublic void setStyleClass(String styleClass)
public String getTitle()
CorePropspublic void setTitle(String title)
public int getVerticalOffset()
AbstractTooltipgetVerticalOffset in interface PositionPropsgetVerticalOffset in class AbstractTooltippublic void setVerticalOffset(int verticalOffset)
public int getZindex()
PopupsPropsgetZindex in interface PopupsPropsgetZindex in class AbstractTooltippublic void setZindex(int zindex)
Copyright © 2014 JBoss by Red Hat. All rights reserved.