|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
org.richfaces.component.AbstractTooltip
public abstract class AbstractTooltip
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.
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static String |
CONTENT_META_COMPONENT_ID
|
| Fields inherited from class javax.faces.component.UIComponent |
|---|
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 |
| Fields inherited from interface org.richfaces.component.MetaComponentResolver |
|---|
META_COMPONENT_SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
protected |
AbstractTooltip()
|
| Method Summary | |
|---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
|
String |
getContentClientId(javax.faces.context.FacesContext context)
|
abstract org.richfaces.component.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 org.richfaces.component.Positioning |
getJointPoint()
|
abstract org.richfaces.TooltipLayout |
getLayout()
Block/inline mode flag. |
abstract org.richfaces.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)
|
void |
setTarget(String target)
|
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
|
| Methods inherited from class javax.faces.component.UIOutput |
|---|
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
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 |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.richfaces.component.AbstractDivPanel |
|---|
getDir, getLang, getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String CONTENT_META_COMPONENT_ID
| Constructor Detail |
|---|
protected AbstractTooltip()
| Method Detail |
|---|
public String getFamily()
getFamily in class javax.faces.component.UIOutputpublic String getTarget()
public void setTarget(String target)
public abstract org.richfaces.TooltipLayout getLayout()
public abstract boolean isAttached()
public abstract org.richfaces.component.Positioning getJointPoint()
public abstract org.richfaces.component.Positioning getDirection()
public abstract boolean isFollowMouse()
public abstract int getHideDelay()
public abstract String getHideEvent()
public abstract int getHorizontalOffset()
public abstract org.richfaces.TooltipMode getMode()
public abstract int getShowDelay()
public abstract String getShowEvent()
public abstract int getVerticalOffset()
public abstract String getStyle()
getStyle in interface AbstractDivPanelpublic abstract String getStyleClass()
getStyleClass in interface AbstractDivPanelpublic 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 org.richfaces.component.MetaComponentEncoderIOExceptionpublic String getContentClientId(javax.faces.context.FacesContext context)
public String resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
resolveClientId in interface org.richfaces.component.MetaComponentResolver
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
substituteUnresolvedClientId in interface org.richfaces.component.MetaComponentResolver
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||