public abstract class AbstractTooltip extends javax.faces.component.UIOutput implements AbstractDivPanel, MetaComponentResolver, MetaComponentEncoder
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 | 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_KEY
META_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() |
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() |
abstract TooltipLayout |
getLayout()
Block/inline mode flag.
|
abstract TooltipMode |
getMode()
Controls the way of data loading to a tooltip.
|
abstract String |
getOnbeforehide() |
abstract String |
getOnbeforeshow() |
abstract String |
getOnhide() |
abstract String |
getOnshow() |
abstract int |
getShowDelay()
Delay in milliseconds before tooltip will be displayed.
|
abstract String |
getShowEvent()
Event that triggers the tooltip.
|
abstract String |
getStyle() |
abstract String |
getStyleClass() |
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 int |
getZindex() |
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, restoreState, saveState, setConverter, setValue
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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
getDir, getLang, getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle
public 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.UIOutput
public String getTarget()
public void setTarget(String target)
public abstract TooltipLayout getLayout()
public abstract boolean isAttached()
public abstract Positioning getJointPoint()
public abstract Positioning getDirection()
public abstract boolean isFollowMouse()
public abstract int getHideDelay()
public abstract String getHideEvent()
public abstract int getHorizontalOffset()
public abstract TooltipMode getMode()
public abstract int getShowDelay()
public abstract String getShowEvent()
public abstract int getVerticalOffset()
public abstract String getStyle()
getStyle
in interface AbstractDivPanel
public abstract String getStyleClass()
getStyleClass
in interface AbstractDivPanel
public abstract int getZindex()
public abstract String getOnhide()
public abstract String getOnshow()
public abstract String getOnbeforehide()
public abstract String getOnbeforeshow()
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
public void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId) throws IOException
encodeMetaComponent
in interface MetaComponentEncoder
IOException
public String getContentClientId(javax.faces.context.FacesContext context)
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
if provided meta-component name is
not a supported one.resolveClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
substituteUnresolvedClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
Copyright © 2013 JBoss by Red Hat. All Rights Reserved.