|
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
org.icefaces.ace.component.tabset.TabPaneBase
public class TabPaneBase
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 | |
---|---|
protected static class |
TabPaneBase.PropertyKeys
|
Field Summary | |
---|---|
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 | |
---|---|
TabPaneBase()
|
Method Summary | |
---|---|
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. |
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. |
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, 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, 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 |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public TabPaneBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
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.
setCache
in interface ITabPane
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'.
getCache
in interface ITabPane
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.
setDisabled
in interface ITabPane
public boolean isDisabled()
Return the value of the disabled
property.
Contents: If true then this tab will be disabled and can not be selected.
isDisabled
in interface ITabPane
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.
setLabel
in interface ITabPane
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.
getLabel
in interface ITabPane
public void setLabelFacet(javax.faces.component.UIComponent label)
Set the value of the label facet
property.
public javax.faces.component.UIComponent getLabelFacet()
Return the value of the label facet
property.
|
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 |