@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UITooltip extends AbstractTooltip implements javax.faces.component.behavior.ClientBehaviorHolder, AbstractDivPanel, MetaComponentEncoder, MetaComponentResolver, AjaxProps, CoreProps, EventsMouseProps, EventsPopupsBeforeProps, EventsPopupsProps, I18nProps, PopupsProps, PositionProps
The <rich: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_ID
ATTRS_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_KEY
META_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
|
boolean |
isResetValues()
If true, indicate that this particular Ajax transaction is a value reset transaction.
|
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 |
setResetValues(boolean resetValues) |
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, visitTree
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
addClientBehavior, 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, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
encodeMetaComponent
resolveClientId, substituteUnresolvedClientId
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class AbstractTooltip
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public boolean isAttached()
AbstractTooltip
isAttached
in class AbstractTooltip
public void setAttached(boolean attached)
public Object getData()
AjaxActivatorProps
getData
in interface AjaxActivatorProps
public void setData(Object data)
public String getDir()
I18nProps
public void setDir(String dir)
public Positioning getDirection()
PositionProps
Set the direction of the popup. Possible values are:
auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft,
autoRight, topAuto, bottomAuto
Default value is auto
getDirection
in interface PositionProps
getDirection
in class AbstractTooltip
public void setDirection(Positioning direction)
public Object getExecute()
AjaxProps
getExecute
in interface AjaxProps
getExecute
in class AbstractTooltip
public void setExecute(Object execute)
public boolean isFollowMouse()
AbstractTooltip
isFollowMouse
in class AbstractTooltip
public void setFollowMouse(boolean followMouse)
public int getHideDelay()
AbstractTooltip
getHideDelay
in class AbstractTooltip
public void setHideDelay(int hideDelay)
public String getHideEvent()
AbstractTooltip
getHideEvent
in class AbstractTooltip
public void setHideEvent(String hideEvent)
public int getHorizontalOffset()
AbstractTooltip
getHorizontalOffset
in interface PositionProps
getHorizontalOffset
in class AbstractTooltip
public void setHorizontalOffset(int horizontalOffset)
public Positioning getJointPoint()
PositionProps
Set the corner attachment point with which the popup should be connected. Possible values are:
auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft,
autoRight, topAuto, bottomAuto
Default value is auto
getJointPoint
in interface PositionProps
getJointPoint
in class AbstractTooltip
public void setJointPoint(Positioning jointPoint)
public String getLang()
I18nProps
public void setLang(String lang)
public TooltipLayout getLayout()
AbstractTooltip
getLayout
in class AbstractTooltip
public void setLayout(TooltipLayout layout)
public boolean isLimitRender()
AjaxActivatorProps
isLimitRender
in interface AjaxActivatorProps
public void setLimitRender(boolean limitRender)
public TooltipMode getMode()
AbstractTooltip
getMode
in class AbstractTooltip
public void setMode(TooltipMode mode)
public String getOnbeforedomupdate()
AjaxActivatorProps
getOnbeforedomupdate
in interface AjaxActivatorProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforehide()
EventsPopupsBeforeProps
getOnbeforehide
in interface EventsPopupsBeforeProps
public void setOnbeforehide(String onbeforehide)
public String getOnbeforeshow()
EventsPopupsBeforeProps
getOnbeforeshow
in interface EventsPopupsBeforeProps
public void setOnbeforeshow(String onbeforeshow)
public String getOnbegin()
AjaxProps
getOnbegin
in interface AjaxProps
public void setOnbegin(String onbegin)
public String getOnclick()
EventsMouseProps
getOnclick
in interface EventsMouseProps
public void setOnclick(String onclick)
public String getOncomplete()
AjaxActivatorProps
getOncomplete
in interface AjaxActivatorProps
public void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMouseProps
getOndblclick
in interface EventsMouseProps
public void setOndblclick(String ondblclick)
public String getOnhide()
EventsPopupsProps
getOnhide
in interface EventsPopupsProps
public void setOnhide(String onhide)
public String getOnmousedown()
EventsMouseProps
getOnmousedown
in interface EventsMouseProps
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMouseProps
getOnmousemove
in interface EventsMouseProps
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMouseProps
getOnmouseout
in interface EventsMouseProps
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMouseProps
getOnmouseover
in interface EventsMouseProps
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMouseProps
getOnmouseup
in interface EventsMouseProps
public void setOnmouseup(String onmouseup)
public String getOnshow()
EventsPopupsProps
getOnshow
in interface EventsPopupsProps
public void setOnshow(String onshow)
public Object getRender()
AjaxActivatorProps
getRender
in interface AjaxActivatorProps
public void setRender(Object render)
public boolean isResetValues()
AjaxActivatorProps
isResetValues
in interface AjaxActivatorProps
public void setResetValues(boolean resetValues)
public int getShowDelay()
AbstractTooltip
getShowDelay
in class AbstractTooltip
public void setShowDelay(int showDelay)
public String getShowEvent()
AbstractTooltip
getShowEvent
in class AbstractTooltip
public void setShowEvent(String showEvent)
public String getStatus()
AjaxProps
public void setStatus(String status)
public String getStyle()
CoreProps
public void setStyle(String style)
public String getStyleClass()
CoreProps
getStyleClass
in interface CoreProps
public void setStyleClass(String styleClass)
public String getTitle()
CoreProps
public void setTitle(String title)
public int getVerticalOffset()
AbstractTooltip
getVerticalOffset
in interface PositionProps
getVerticalOffset
in class AbstractTooltip
public void setVerticalOffset(int verticalOffset)
public int getZindex()
PopupsProps
getZindex
in interface PopupsProps
getZindex
in class AbstractTooltip
public void setZindex(int zindex)
Copyright © 2015 JBoss by Red Hat. All Rights Reserved.