|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
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.icefaces.ace.component.tooltip.TooltipBase
public class TooltipBase
The Tooltip is a component that displays a tooltip with various events, effects and customization options.
For more information, see the Tooltip Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
TooltipBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIOutput |
---|
COMPONENT_FAMILY |
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 |
Constructor Summary | |
---|---|
TooltipBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
javax.el.MethodExpression |
getDisplayListener()
Return the value of the displayListener property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
javax.el.ValueExpression |
getFetch()
Return the value of the fetch property. |
java.lang.String |
getFor()
Return the value of the for property. |
java.lang.String |
getForContainer()
Return the value of the forContainer property. |
java.lang.String |
getForDelegate()
Return the value of the forDelegate property. |
java.lang.String |
getForElement()
Return the value of the forElement property. |
int |
getHideDelay()
Return the value of the hideDelay property. |
java.lang.String |
getHideEffect()
Return the value of the hideEffect property. |
int |
getHideEffectLength()
Return the value of the hideEffectLength property. |
java.lang.String |
getHideEvent()
Return the value of the hideEvent property. |
java.lang.String |
getPosition()
Return the value of the position property. |
int |
getShowDelay()
Return the value of the showDelay property. |
java.lang.String |
getShowEffect()
Return the value of the showEffect property. |
int |
getShowEffectLength()
Return the value of the showEffectLength property. |
java.lang.String |
getShowEvent()
Return the value of the showEvent property. |
java.lang.Object |
getStore()
Return the value of the store property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getTargetPosition()
Return the value of the targetPosition property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
boolean |
isGlobal()
Return the value of the global property. |
boolean |
isSpeechBubble()
Return the value of the speechBubble property. |
void |
setDisplayListener(javax.el.MethodExpression displayListener)
Set the value of the displayListener property. |
void |
setFetch(javax.el.ValueExpression fetch)
Set the value of the fetch property. |
void |
setFor(java.lang.String forValue)
Set the value of the for property. |
void |
setForContainer(java.lang.String forContainer)
Set the value of the forContainer property. |
void |
setForDelegate(java.lang.String forDelegate)
Set the value of the forDelegate property. |
void |
setForElement(java.lang.String forElement)
Set the value of the forElement property. |
void |
setGlobal(boolean global)
Set the value of the global property. |
void |
setHideDelay(int hideDelay)
Set the value of the hideDelay property. |
void |
setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect property. |
void |
setHideEffectLength(int hideEffectLength)
Set the value of the hideEffectLength property. |
void |
setHideEvent(java.lang.String hideEvent)
Set the value of the hideEvent property. |
void |
setPosition(java.lang.String position)
Set the value of the position property. |
void |
setShowDelay(int showDelay)
Set the value of the showDelay property. |
void |
setShowEffect(java.lang.String showEffect)
Set the value of the showEffect property. |
void |
setShowEffectLength(int showEffectLength)
Set the value of the showEffectLength property. |
void |
setShowEvent(java.lang.String showEvent)
Set the value of the showEvent property. |
void |
setSpeechBubble(boolean speechBubble)
Set the value of the speechBubble property. |
void |
setStore(java.lang.Object store)
Set the value of the store property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTargetPosition(java.lang.String targetPosition)
Set the value of the targetPosition property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
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 |
---|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public TooltipBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIOutput
public void setDisplayListener(javax.el.MethodExpression displayListener)
Set the value of the displayListener
property.
Contents: A server side listener to be invoked when the tooltip is about to be shown in the client.
setDisplayListener
in interface ITooltip
public javax.el.MethodExpression getDisplayListener()
Return the value of the displayListener
property.
Contents: A server side listener to be invoked when the tooltip is about to be shown in the client.
getDisplayListener
in interface ITooltip
public void setFetch(javax.el.ValueExpression fetch)
Set the value of the fetch
property.
Contents: When using "forDelegate", an EL expression can be specified as the value of this attribute. Such expression will be evaluated at the same point (e.g. row) where the component that triggered the tooltip is located, allowing to retrieve row data in a table or iterative container. The result is saved in the bean property specified by the "store" attribute.
setFetch
in interface ITooltip
public javax.el.ValueExpression getFetch()
Return the value of the fetch
property.
Contents: When using "forDelegate", an EL expression can be specified as the value of this attribute. Such expression will be evaluated at the same point (e.g. row) where the component that triggered the tooltip is located, allowing to retrieve row data in a table or iterative container. The result is saved in the bean property specified by the "store" attribute.
getFetch
in interface ITooltip
public void setFor(java.lang.String forValue)
Set the value of the for
property.
Contents: Specifies the id of the component that will display the tooltip. Ignored if "global" is true.
setFor
in interface ITooltip
public java.lang.String getFor()
Return the value of the for
property.
Contents: Specifies the id of the component that will display the tooltip. Ignored if "global" is true.
getFor
in interface ITooltip
public void setForContainer(java.lang.String forContainer)
Set the value of the forContainer
property.
Contents: Specifies the id of the component that contains the component referenced by the "for" attribute. This is to be used in cases where the target component is inside an iterative container such as a data table and the tooltip component itself is outside. A more robust solution is to use "forDelegate" instead of this attribute.
setForContainer
in interface ITooltip
public java.lang.String getForContainer()
Return the value of the forContainer
property.
Contents: Specifies the id of the component that contains the component referenced by the "for" attribute. This is to be used in cases where the target component is inside an iterative container such as a data table and the tooltip component itself is outside. A more robust solution is to use "forDelegate" instead of this attribute.
getForContainer
in interface ITooltip
public void setForDelegate(java.lang.String forDelegate)
Set the value of the forDelegate
property.
Contents: Specifies the id of the
setForDelegate
in interface ITooltip
public java.lang.String getForDelegate()
Return the value of the forDelegate
property.
Contents: Specifies the id of the
getForDelegate
in interface ITooltip
public void setForElement(java.lang.String forElement)
Set the value of the forElement
property.
Contents: Specifies the id of the HTML element that will display the tooltip. Applicable only if "for" component is not specified. Ignored if "global" is true.
setForElement
in interface ITooltip
public java.lang.String getForElement()
Return the value of the forElement
property.
Contents: Specifies the id of the HTML element that will display the tooltip. Applicable only if "for" component is not specified. Ignored if "global" is true.
getForElement
in interface ITooltip
public void setGlobal(boolean global)
Set the value of the global
property.
Contents: Boolean value specifying whether to create tooltips for all elements with a title attribute using the title attribute value.
setGlobal
in interface ITooltip
public boolean isGlobal()
Return the value of the global
property.
Contents: Boolean value specifying whether to create tooltips for all elements with a title attribute using the title attribute value. Default = 'false'.
isGlobal
in interface ITooltip
public void setHideDelay(int hideDelay)
Set the value of the hideDelay
property.
Contents: Time in milliseconds by which to delay the hiding of the tooltip.
setHideDelay
in interface ITooltip
public int getHideDelay()
Return the value of the hideDelay
property.
Contents: Time in milliseconds by which to delay the hiding of the tooltip. Default = '0'.
getHideDelay
in interface ITooltip
public void setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect
property.
Contents: Effect to use upon hiding the tooltip e.g. fade, slide or grow.
setHideEffect
in interface ITooltip
public java.lang.String getHideEffect()
Return the value of the hideEffect
property.
Contents: Effect to use upon hiding the tooltip e.g. fade, slide or grow. Default = 'fade'.
getHideEffect
in interface ITooltip
public void setHideEffectLength(int hideEffectLength)
Set the value of the hideEffectLength
property.
Contents: Length of time in milliseconds the hide effect will last for.
setHideEffectLength
in interface ITooltip
public int getHideEffectLength()
Return the value of the hideEffectLength
property.
Contents: Length of time in milliseconds the hide effect will last for. Default = '500'.
getHideEffectLength
in interface ITooltip
public void setHideEvent(java.lang.String hideEvent)
Set the value of the hideEvent
property.
Contents: Event which will trigger the hiding of the tooltip. Possible values are DOM events, such as "mouseout", documented under jQuery's Event: bind().
setHideEvent
in interface ITooltip
public java.lang.String getHideEvent()
Return the value of the hideEvent
property.
Contents: Event which will trigger the hiding of the tooltip. Possible values are DOM events, such as "mouseout", documented under jQuery's Event: bind(). Default = 'mouseout'.
getHideEvent
in interface ITooltip
public void setPosition(java.lang.String position)
Set the value of the position
property.
Contents: The corner of the tooltip to position in relation to the target's corner. E.g. topLeft, bottomRight. See positioning for all possible values.
setPosition
in interface ITooltip
public java.lang.String getPosition()
Return the value of the position
property.
Contents: The corner of the tooltip to position in relation to the target's corner. E.g. topLeft, bottomRight. See positioning for all possible values. Default = 'topLeft'.
getPosition
in interface ITooltip
public void setShowDelay(int showDelay)
Set the value of the showDelay
property.
Contents: Time in milliseconds by which to delay the showing of the tooltip.
setShowDelay
in interface ITooltip
public int getShowDelay()
Return the value of the showDelay
property.
Contents: Time in milliseconds by which to delay the showing of the tooltip. Default = '140'.
getShowDelay
in interface ITooltip
public void setShowEffect(java.lang.String showEffect)
Set the value of the showEffect
property.
Contents: Effect to use upon showing the tooltip e.g. fade, slide or grow.
setShowEffect
in interface ITooltip
public java.lang.String getShowEffect()
Return the value of the showEffect
property.
Contents: Effect to use upon showing the tooltip e.g. fade, slide or grow. Default = 'fade'.
getShowEffect
in interface ITooltip
public void setShowEffectLength(int showEffectLength)
Set the value of the showEffectLength
property.
Contents: Length of time in milliseconds the show effect will last for.
setShowEffectLength
in interface ITooltip
public int getShowEffectLength()
Return the value of the showEffectLength
property.
Contents: Length of time in milliseconds the show effect will last for. Default = '500'.
getShowEffectLength
in interface ITooltip
public void setShowEvent(java.lang.String showEvent)
Set the value of the showEvent
property.
Contents: Event which will trigger the showing of the tooltip. Possible values are DOM events, such as "mouseover", documented under jQuery's Event: bind().
setShowEvent
in interface ITooltip
public java.lang.String getShowEvent()
Return the value of the showEvent
property.
Contents: Event which will trigger the showing of the tooltip. Possible values are DOM events, such as "mouseover", documented under jQuery's Event: bind(). Default = 'mouseover'.
getShowEvent
in interface ITooltip
public void setSpeechBubble(boolean speechBubble)
Set the value of the speechBubble
property.
Contents: Specifies whether the tooltip should be stylized as a speech bubble (i.e. with a speech bubble arrow tip pointing to the triggerer element).
setSpeechBubble
in interface ITooltip
public boolean isSpeechBubble()
Return the value of the speechBubble
property.
Contents: Specifies whether the tooltip should be stylized as a speech bubble (i.e. with a speech bubble arrow tip pointing to the triggerer element). Default = 'false'.
isSpeechBubble
in interface ITooltip
public void setStore(java.lang.Object store)
Set the value of the store
property.
Contents: The result of evaluating the expression specified in "fetch" is stored in the bean property specified in this attribute.
setStore
in interface ITooltip
public java.lang.Object getStore()
Return the value of the store
property.
Contents: The result of evaluating the expression specified in "fetch" is stored in the bean property specified in this attribute.
getStore
in interface ITooltip
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: The inline style of the component, rendered on the root div of the component.
setStyle
in interface ITooltip
public java.lang.String getStyle()
Return the value of the style
property.
Contents: The inline style of the component, rendered on the root div of the component.
getStyle
in interface ITooltip
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: The CSS style class of the component, rendered on the root div of the component.
setStyleClass
in interface ITooltip
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: The CSS style class of the component, rendered on the root div of the component.
getStyleClass
in interface ITooltip
public void setTargetPosition(java.lang.String targetPosition)
Set the value of the targetPosition
property.
Contents: The corner of the target element by which to position the tooltip by. E.g. topLeft, bottomRight. See positioning for all possible values.
setTargetPosition
in interface ITooltip
public java.lang.String getTargetPosition()
Return the value of the targetPosition
property.
Contents: The corner of the target element by which to position the tooltip by. E.g. topLeft, bottomRight. See positioning for all possible values. Default = 'bottomRight'.
getTargetPosition
in interface ITooltip
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Name of the widget to access client side api
setWidgetVar
in interface ITooltip
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Name of the widget to access client side api
getWidgetVar
in interface ITooltip
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |