public abstract class AbstractTooltip extends javax.faces.component.UIOutput implements AbstractDivPanel, MetaComponentResolver, MetaComponentEncoder, AjaxProps, CoreProps, EventsMouseProps, EventsPopupsProps, EventsPopupsBeforeProps, 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 | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
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_KEYMETA_COMPONENT_SEPARATOR_CHAR| Modifier | Constructor and Description |
|---|---|
protected |
AbstractTooltip() |
| Modifier and Type | Method and Description |
|---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
String |
getContentClientId(javax.faces.context.FacesContext context) |
abstract Positioning |
getDirection()
Set the direction of the popup.
|
abstract Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
abstract int |
getHideDelay()
Delay in milliseconds before tooltip will be hidden.
|
abstract String |
getHideEvent()
Event that triggers the tooltip disappearance.
|
abstract int |
getHorizontalOffset()
Sets the horizontal offset between pop-up list and mouse pointer.
|
abstract Positioning |
getJointPoint()
Set the corner attachment point with which the popup should be connected.
|
abstract TooltipLayout |
getLayout()
Block/inline mode flag.
|
abstract TooltipMode |
getMode()
Controls the way of data loading to a tooltip.
|
abstract int |
getShowDelay()
Delay in milliseconds before tooltip will be displayed.
|
abstract String |
getShowEvent()
Event that triggers the tooltip.
|
String |
getTarget()
Component ID of the target component or "null" if the component should be attached to the parent component.
|
abstract int |
getVerticalOffset()
Sets the vertical offset between pop-up list and mouse pointer.
|
abstract 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.
|
abstract boolean |
isFollowMouse()
If "true" tooltip should follow the mouse while it moves over the parent element.
|
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Resolves and returns string identifying supported meta-component or
null if provided meta-component name is
not a supported one. |
void |
setTarget(String target) |
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Provides replacement for unresolved meta-component names.
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback) |
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValueaddClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, 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, waitgetStyle, getStyleClass, getTitlegetOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseupgetData, getOnbeforedomupdate, getOnbegin, getOncomplete, getRender, getStatus, isLimitRendergetOnhide, getOnshowgetOnbeforehide, getOnbeforeshowgetZindexpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String CONTENT_META_COMPONENT_ID
public String getFamily()
getFamily in class javax.faces.component.UIOutputpublic String getTarget()
public void setTarget(String target)
public abstract TooltipLayout getLayout()
public abstract boolean isAttached()
public abstract 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 PositionPropspublic abstract 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 PositionPropspublic abstract boolean isFollowMouse()
public abstract int getHideDelay()
public abstract String getHideEvent()
public abstract int getHorizontalOffset()
getHorizontalOffset in interface PositionPropspublic abstract TooltipMode getMode()
public abstract int getShowDelay()
public abstract String getShowEvent()
public abstract int getVerticalOffset()
getVerticalOffset in interface PositionPropspublic abstract Object getExecute()
AjaxPropsgetExecute in interface AjaxPropspublic boolean visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
visitTree in class javax.faces.component.UIComponentpublic void encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
throws IOException
encodeMetaComponent in interface MetaComponentEncoderIOExceptionpublic String getContentClientId(javax.faces.context.FacesContext context)
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolvernull if provided meta-component name is
not a supported one.resolveClientId in interface MetaComponentResolverfacesContext - - current instance of FacesContextcontextComponent - - instance of UIComponent that requested resolution of meta-componentmetaComponentId - - name of meta-component (without leading '@' sign)nullpublic String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolvernullsubstituteUnresolvedClientId in interface MetaComponentResolverfacesContext - - current instance of FacesContextcontextComponent - - instance of UIComponent that requested resolution of meta-componentmetaComponentId - - name of meta-component (without leading '@' sign)nullCopyright © 2014 JBoss by Red Hat. All Rights Reserved.