org.icefaces.ace.component.tabset

Class TabPaneBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.ace.component.tabset.TabPaneBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ITabPane

Direct Known Subclasses:

TabPane

public abstract class TabPaneBase
extends javax.faces.component.UIComponentBase
implements ITabPane

The TabPane component belongs inside of a TabSet component, and encapsulates both the clickable label, and the content pane that is shown when the TabPane is selected. The clickable label part may be specified by the label property, or by the label facet, allowing for any components to comprise the label.

For more information, see the TabPane Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TabPaneBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

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

Constructors

Constructor and Description
TabPaneBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getCache() Return the value of the cache property.
java.lang.String	getFamily()
java.lang.String	getLabel() Return the value of the label property.
javax.faces.component.UIComponent	getLabelFacet() Return the value of the label facet property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setCache(java.lang.String cache) Set the value of the cache property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setLabel(java.lang.String label) Set the value of the label property.
void	setLabelFacet(javax.faces.component.UIComponent label) Set the value of the label facet property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

Constructor Detail

TabPaneBase

public TabPaneBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this tab header and activates it.

Specified by:

setAccesskey in interface ITabPane

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this tab header and activates it.

Specified by:

getAccesskey in interface ITabPane

setCache

public void setCache(java.lang.String cache)

Set the value of the cache property.

Contents: When clientSide=true on the tabSet, all tabPane components are always cached on the client, so this only applies when the tabSet has clientSide=false. When this property value is "none" then no caching occurs in the browser and the tab contents are completely rendered and updated in the browser when the tab is active, and become unrendered when the tab is no longer active. The other values involve the tab contents being cached in different ways. The contents are lazily loaded when the tab first becomes active, and then remain in the browser. When the value is "dynamic", the lazily loaded tab contents will continue to be rendered whether the tab is still active or not, and any changes will be detected and granularly updated. When the value is "static", the tab will not be rendered or updated after the first time. This is an optimisation to save CPU rendering time. It is facilitated by "staticAuto", which is usually like static mode, except when a component within the tab initiates a lifecycle causing a full render, then it will automatically change to being dynamic for just that lifecycle, so that the tab contents may be rendered and updated in the browser. As well, there is "dynamicRevertStaticAuto", which allows for the application to indicate that it wants to temporarily use dynamic caching for the current lifecycle only, and have the tabPane automatically revert the mode back to static auto mode afterwards. This is intended to be set in action/actionListener methods that knowingly update an otherwise statically cached tabPane.

Specified by:

setCache in interface ITabPane

getCache

public java.lang.String getCache()

Return the value of the cache property.

Contents: When clientSide=true on the tabSet, all tabPane components are always cached on the client, so this only applies when the tabSet has clientSide=false. When this property value is "none" then no caching occurs in the browser and the tab contents are completely rendered and updated in the browser when the tab is active, and become unrendered when the tab is no longer active. The other values involve the tab contents being cached in different ways. The contents are lazily loaded when the tab first becomes active, and then remain in the browser. When the value is "dynamic", the lazily loaded tab contents will continue to be rendered whether the tab is still active or not, and any changes will be detected and granularly updated. When the value is "static", the tab will not be rendered or updated after the first time. This is an optimisation to save CPU rendering time. It is facilitated by "staticAuto", which is usually like static mode, except when a component within the tab initiates a lifecycle causing a full render, then it will automatically change to being dynamic for just that lifecycle, so that the tab contents may be rendered and updated in the browser. As well, there is "dynamicRevertStaticAuto", which allows for the application to indicate that it wants to temporarily use dynamic caching for the current lifecycle only, and have the tabPane automatically revert the mode back to static auto mode afterwards. This is intended to be set in action/actionListener methods that knowingly update an otherwise statically cached tabPane. Default = 'none'.

Specified by:

getCache in interface ITabPane

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: If true then this tab will be disabled and can not be selected.

Specified by:

setDisabled in interface ITabPane

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: If true then this tab will be disabled and can not be selected.

Specified by:

isDisabled in interface ITabPane

setLabel

public void setLabel(java.lang.String label)

Set the value of the label property.

Contents: The text label in the clickable tab for the TabPane. Where these are rendered is determined by TabSet's orientation property. Alternatively, the label facet may be used to specify components to represent the label.

Specified by:

setLabel in interface ITabPane

getLabel

public java.lang.String getLabel()

Return the value of the label property.

Contents: The text label in the clickable tab for the TabPane. Where these are rendered is determined by TabSet's orientation property. Alternatively, the label facet may be used to specify components to represent the label.

Specified by:

getLabel in interface ITabPane

setLabelFacet

public void setLabelFacet(javax.faces.component.UIComponent label)

Set the value of the label facet property.

getLabelFacet

public javax.faces.component.UIComponent getLabelFacet()

Return the value of the label facet property.

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent