com.liferay.faces.alloy.component.outputtooltip

Class OutputTooltipBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.html.HtmlOutputText

com.liferay.faces.alloy.component.outputtext.OutputTextBase

com.liferay.faces.alloy.component.outputtooltip.OutputTooltipBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

OutputTooltip

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class OutputTooltipBase
extends OutputTextBase
implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OutputTooltipBase.OutputTooltipPropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlOutputText

javax.faces.component.html.HtmlOutputText.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static 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

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Constructor Summary

Constructors

Constructor and Description
OutputTooltipBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientKey() clientKey attribute description: The key name that can be used to reference the component on the client.
String	getFor() for attribute description: The id of the component that is associated with the tooltip.
String	getHeaderText() headerText attribute description: The text to place in the header of the component.
String	getOpacity() opacity attribute description: A number between 0 and 1 describing how much the tooltip will obscure its background when visible.
String	getPosition() position attribute description: Indicates the side of the associated component where the tooltip should appear ("right", "left", "top", "bottom").
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
Integer	getzIndex() zIndex attribute description: Specifies the stack order of the component.
boolean	isAutoShow() autoShow attribute description: When true, the component is visible initially.
void	setAutoShow(boolean autoShow) autoShow attribute description: When true, the component is visible initially.
void	setClientKey(String clientKey) clientKey attribute description: The key name that can be used to reference the component on the client.
void	setFor(String for_) for attribute description: The id of the component that is associated with the tooltip.
void	setHeaderText(String headerText) headerText attribute description: The text to place in the header of the component.
void	setOpacity(String opacity) opacity attribute description: A number between 0 and 1 describing how much the tooltip will obscure its background when visible.
void	setPosition(String position) position attribute description: Indicates the side of the associated component where the tooltip should appear ("right", "left", "top", "bottom").
void	setzIndex(Integer zIndex) zIndex attribute description: Specifies the stack order of the component.

Methods inherited from class javax.faces.component.html.HtmlOutputText

getDir, getLang, getRole, getStyle, getTitle, isEscape, setDir, setEscape, setLang, setRole, setStyle, setStyleClass, setTitle

Methods inherited from class javax.faces.component.UIOutput

clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, resetValue, 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, 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

Methods inherited from class javax.faces.component.UIComponent

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, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.faces.util.component.Styleable

getStyle, setStyle, setStyleClass

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

OutputTooltipBase

public OutputTooltipBase()

Method Detail

isAutoShow

public boolean isAutoShow()

autoShow attribute description:

When true, the component is visible initially.

setAutoShow

public void setAutoShow(boolean autoShow)

autoShow attribute description:

When true, the component is visible initially.

getClientKey

public String getClientKey()

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

getClientKey in interface com.liferay.faces.util.component.ClientComponent

setClientKey

public void setClientKey(String clientKey)

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

setClientKey in interface com.liferay.faces.util.component.ClientComponent

getFor

public String getFor()

for attribute description:

The id of the component that is associated with the tooltip.

setFor

public void setFor(String for_)

for attribute description:

The id of the component that is associated with the tooltip.

getHeaderText

public String getHeaderText()

headerText attribute description:

The text to place in the header of the component.

setHeaderText

public void setHeaderText(String headerText)

headerText attribute description:

The text to place in the header of the component.

getOpacity

public String getOpacity()

opacity attribute description:

A number between 0 and 1 describing how much the tooltip will obscure its background when visible.

setOpacity

public void setOpacity(String opacity)

opacity attribute description:

A number between 0 and 1 describing how much the tooltip will obscure its background when visible.

getPosition

public String getPosition()

position attribute description:

Indicates the side of the associated component where the tooltip should appear ("right", "left", "top", "bottom").

setPosition

public void setPosition(String position)

position attribute description:

Indicates the side of the associated component where the tooltip should appear ("right", "left", "top", "bottom").

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class OutputTextBase

getzIndex

public Integer getzIndex()

zIndex attribute description:

Specifies the stack order of the component. The default value is a constant from the Liferay.zIndex JavaScript object.

setzIndex

public void setzIndex(Integer zIndex)

zIndex attribute description:

Specifies the stack order of the component. The default value is a constant from the Liferay.zIndex JavaScript object.