public abstract class AbstractCollapsiblePanel extends AbstractTogglePanel implements PanelToggleSource, CoreProps, EventsMouseProps, I18nProps
The <rich:collapsiblePanel> component is a collapsible panel that shows or hides content when the header bar is activated. It is a simplified version of <rich:togglePanel> component.
Modifier and Type | Class and Description |
---|---|
static class |
AbstractCollapsiblePanel.Properties |
static class |
AbstractCollapsiblePanel.States |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
ACTIVE_ITEM_META_COMPONENT, META_NAME_FIRST, META_NAME_LAST, META_NAME_NEXT, META_NAME_PREV, UPDATE_MESSAGE_ID
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
META_COMPONENT_SEPARATOR_CHAR
Modifier | Constructor and Description |
---|---|
protected |
AbstractCollapsiblePanel() |
Modifier and Type | Method and Description |
---|---|
void |
addPanelToggleListener(PanelToggleListener listener)
Add a new
PanelToggleListener to the set of listeners interested in being notified when PanelToggleEvent s
occur. |
void |
broadcast(javax.faces.event.FacesEvent event) |
String |
getActiveItem()
Holds the active panel name.
|
abstract String |
getBodyClass()
Space-separated list of CSS style class(es) to be applied to the panel content.
|
String |
getFamily() |
abstract String |
getHeader()
Provides the text on the panel header.
|
abstract String |
getHeaderClass()
Space-separated list of CSS style class(es) to be applied to the panel header.
|
abstract javax.el.MethodExpression |
getItemChangeListener()
Occurs on the server side when an item is changed through Ajax using the server mode
|
abstract String |
getLeftCollapsedIcon()
The icon displayed on the left of the panel header when the panel is collapsed
|
abstract String |
getLeftExpandedIcon()
The icon displayed on the left of the panel header when the panel is expanded
|
abstract String |
getOnbeforeitemchange()
The client-side script method to be called before the item is changed.
|
abstract String |
getOnbeforeswitch()
The client-side script method to be called before the panel state is switched
|
abstract String |
getOnitemchange()
The client-side script method to be called after the item is changed.
|
abstract String |
getOnswitch()
The client-side script method to be called after the panel state is switched
|
PanelToggleListener[] |
getPanelToggleListeners()
Return the set of registered
PanelToggleListener s for this instance. |
abstract String |
getRightCollapsedIcon()
The icon displayed on the right of the panel header when the panel is collapsed
|
abstract String |
getRightExpandedIcon()
The icon displayed on the right of the panel header when the panel is expanded
|
abstract javax.el.MethodExpression |
getToggleListener()
A Server-side MethodExpression to be called when the panel is toggled
|
Object |
getValue() |
boolean |
isActiveItem(javax.faces.component.UIComponent kid) |
protected boolean |
isActiveItem(javax.faces.component.UIComponent kid,
String value) |
abstract boolean |
isCycledSwitching()
Applicable when cycling through the tabs.
|
boolean |
isExpanded()
When true, the panel is expanded, when false, the panel is collapsed
|
void |
queueEvent(javax.faces.event.FacesEvent facesEvent) |
void |
removePanelToggleListener(PanelToggleListener listener)
Remove an existing
PanelToggleListener (if any) from the set of listeners interested in being notified when
PanelToggleEvent s occur. |
void |
setExpanded(boolean expanded) |
void |
setValue(Object value) |
String |
updateActiveName(String activeItemName) |
addItemChangeListener, decode, encodeBegin, encodeMetaComponent, getChildIndex, getClientIdByName, getData, getExecute, getFirstItem, getIndexByName, getItem, getItemByIndex, getItemChangeListeners, getItemCount, getLastItem, getNameByIndex, getNextItem, getNextItem, getPrevItem, getPrevItem, getRender, getRendersChildren, getStatus, getSubmittedActiveItem, getSubmittedValue, getSwitchType, getVisitStateByName, isActiveItem, isImmediate, isLimitRender, isLocalValueSet, isPanelItemDynamic, isRequired, isValid, processDecodes, processUpdates, processValidators, removeItemChangeListener, resetValue, resolveClientId, setActiveItem, setEventPhase, setEventPhase, setImmediate, setLocalValueSet, setRequired, setSubmittedActiveItem, setSubmittedValue, setSwitchType, setValid, setValueExpression, substituteUnresolvedClientId, updateModel, visitMetaComponents, visitTogglePanelItems, visitTree
clearInitialState, getConverter, getLocalValue, markInitialState, restoreState, saveState, setConverter
addClientBehavior, addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getStyle, getStyleClass, getTitle
getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class AbstractTogglePanel
public String getActiveItem()
AbstractTogglePanel
getActiveItem
in class AbstractTogglePanel
public boolean isActiveItem(javax.faces.component.UIComponent kid)
isActiveItem
in class AbstractTogglePanel
protected boolean isActiveItem(javax.faces.component.UIComponent kid, String value)
isActiveItem
in class AbstractTogglePanel
public String updateActiveName(String activeItemName)
updateActiveName
in class AbstractTogglePanel
public boolean isExpanded()
public void setExpanded(boolean expanded)
public abstract boolean isCycledSwitching()
AbstractTogglePanel
isCycledSwitching
in class AbstractTogglePanel
public void queueEvent(javax.faces.event.FacesEvent facesEvent)
queueEvent
in class AbstractTogglePanel
public abstract String getHeader()
Provides the text on the panel header. The panel header is all that is visible when the panel is collapsed.
Alternatively the header facet could be used in place of the header attribute. This would allow for additional styles and custom content to be applied to the tab.
public abstract javax.el.MethodExpression getToggleListener()
public abstract javax.el.MethodExpression getItemChangeListener()
AbstractTogglePanel
getItemChangeListener
in class AbstractTogglePanel
public abstract String getLeftCollapsedIcon()
public abstract String getLeftExpandedIcon()
public abstract String getRightCollapsedIcon()
public abstract String getRightExpandedIcon()
public abstract String getBodyClass()
public abstract String getHeaderClass()
public abstract String getOnswitch()
public abstract String getOnbeforeswitch()
public abstract String getOnbeforeitemchange()
AbstractTogglePanel
getOnbeforeitemchange
in class AbstractTogglePanel
public abstract String getOnitemchange()
AbstractTogglePanel
getOnitemchange
in class AbstractTogglePanel
public void addPanelToggleListener(PanelToggleListener listener)
PanelToggleSource
Add a new PanelToggleListener
to the set of listeners interested in being notified when PanelToggleEvent
s
occur.
addPanelToggleListener
in interface PanelToggleSource
listener
- The PanelToggleListener
to be addedpublic PanelToggleListener[] getPanelToggleListeners()
PanelToggleSource
Return the set of registered PanelToggleListener
s for this instance. If there are no registered listeners, a
zero-length array is returned.
getPanelToggleListeners
in interface PanelToggleSource
public void removePanelToggleListener(PanelToggleListener listener)
PanelToggleSource
Remove an existing PanelToggleListener
(if any) from the set of listeners interested in being notified when
PanelToggleEvent
s occur.
removePanelToggleListener
in interface PanelToggleSource
listener
- The PanelToggleListener
to be removedpublic Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class javax.faces.component.UIOutput
public void setValue(Object value)
setValue
in interface javax.faces.component.ValueHolder
setValue
in class AbstractTogglePanel
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class AbstractTogglePanel
javax.faces.event.AbortProcessingException
Copyright © 2015 JBoss by Red Hat. All Rights Reserved.