@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UICollapsiblePanel extends AbstractCollapsiblePanel implements javax.faces.component.behavior.ClientBehaviorHolder, CoreProps, EventsMouseProps, I18nProps, PanelToggleSource
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 |
|---|---|
protected static class |
UICollapsiblePanel.Properties |
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_IDATTRS_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_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
UICollapsiblePanel() |
| Modifier and Type | Method and Description |
|---|---|
String |
getBodyClass()
Space-separated list of CSS style class(es) to be applied to the panel content.
|
Object |
getData() |
String |
getDefaultEventName() |
String |
getDir()
Direction indication for text that does not inherit directionality.
|
Collection<String> |
getEventNames() |
Object |
getExecute() |
String |
getFamily() |
String |
getHeader()
Provides the text on the panel header.
|
String |
getHeaderClass()
Space-separated list of CSS style class(es) to be applied to the panel header.
|
javax.el.MethodExpression |
getItemChangeListener()
Occurs on the server side when an item is changed through Ajax using the server mode
|
String |
getLang()
Code describing the language used in the generated markup for this component.
|
String |
getLeftCollapsedIcon()
The icon displayed on the left of the panel header when the panel is collapsed
|
String |
getLeftExpandedIcon()
The icon displayed on the left of the panel header when the panel is expanded
|
String |
getOnbeforeitemchange()
The client-side script method to be called before the item is changed.
|
String |
getOnbeforeswitch()
The client-side script method to be called before the panel state is switched
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnitemchange()
The client-side script method to be called after the item is changed.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOnswitch()
The client-side script method to be called after the panel state is switched
|
Object |
getRender() |
String |
getRightCollapsedIcon()
The icon displayed on the right of the panel header when the panel is collapsed
|
String |
getRightExpandedIcon()
The icon displayed on the right of the panel header when the panel is expanded
|
String |
getStatus() |
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
javax.el.MethodExpression |
getToggleListener()
A Server-side MethodExpression to be called when the panel is toggled
|
boolean |
isCycledSwitching()
Applicable when cycling through the tabs.
|
boolean |
isExpanded()
When true, the panel is expanded, when false, the panel is collapsed
|
boolean |
isLimitRender() |
void |
setBodyClass(String bodyClass) |
void |
setCycledSwitching(boolean cycledSwitching) |
void |
setData(Object data) |
void |
setDir(String dir) |
void |
setExecute(Object execute) |
void |
setExpanded(boolean expanded) |
void |
setHeader(String header) |
void |
setHeaderClass(String headerClass) |
void |
setItemChangeListener(javax.el.MethodExpression itemChangeListener) |
void |
setLang(String lang) |
void |
setLeftCollapsedIcon(String leftCollapsedIcon) |
void |
setLeftExpandedIcon(String leftExpandedIcon) |
void |
setLimitRender(boolean limitRender) |
void |
setOnbeforeitemchange(String onbeforeitemchange) |
void |
setOnbeforeswitch(String onbeforeswitch) |
void |
setOnclick(String onclick) |
void |
setOndblclick(String ondblclick) |
void |
setOnitemchange(String onitemchange) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOnswitch(String onswitch) |
void |
setRender(Object render) |
void |
setRightCollapsedIcon(String rightCollapsedIcon) |
void |
setRightExpandedIcon(String rightExpandedIcon) |
void |
setStatus(String status) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTitle(String title) |
void |
setToggleListener(javax.el.MethodExpression toggleListener) |
addPanelToggleListener, broadcast, getActiveItem, getPanelToggleListeners, getValue, isActiveItem, isActiveItem, queueEvent, removePanelToggleListener, setValue, updateActiveNameaddItemChangeListener, decode, encodeBegin, encodeMetaComponent, getChildIndex, getClientIdByName, getFirstItem, getIndexByName, getItem, getItemByIndex, getItemChangeListeners, getItemCount, getLastItem, getNameByIndex, getNextItem, getNextItem, getPrevItem, getPrevItem, getRendersChildren, getSubmittedActiveItem, getSubmittedValue, getSwitchType, getVisitStateByName, isActiveItem, isImmediate, 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, visitTreeclearInitialState, getConverter, getLocalValue, markInitialState, restoreState, saveState, setConverteraddClientBehavior, addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsaddPanelToggleListener, getPanelToggleListeners, removePanelToggleListenerpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class AbstractCollapsiblePanelpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getBodyClass()
AbstractCollapsiblePanelgetBodyClass in class AbstractCollapsiblePanelpublic void setBodyClass(String bodyClass)
public boolean isCycledSwitching()
AbstractTogglePanelisCycledSwitching in class AbstractCollapsiblePanelpublic void setCycledSwitching(boolean cycledSwitching)
public Object getData()
getData in class AbstractTogglePanelpublic void setData(Object data)
public String getDir()
I18nPropspublic void setDir(String dir)
public Object getExecute()
getExecute in class AbstractTogglePanelpublic void setExecute(Object execute)
public boolean isExpanded()
AbstractCollapsiblePanelisExpanded in class AbstractCollapsiblePanelpublic void setExpanded(boolean expanded)
setExpanded in class AbstractCollapsiblePanelpublic String getHeader()
AbstractCollapsiblePanelProvides 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.
getHeader in class AbstractCollapsiblePanelpublic void setHeader(String header)
public String getHeaderClass()
AbstractCollapsiblePanelgetHeaderClass in class AbstractCollapsiblePanelpublic void setHeaderClass(String headerClass)
public javax.el.MethodExpression getItemChangeListener()
AbstractTogglePanelgetItemChangeListener in class AbstractCollapsiblePanelpublic void setItemChangeListener(javax.el.MethodExpression itemChangeListener)
public String getLang()
I18nPropspublic void setLang(String lang)
public String getLeftCollapsedIcon()
AbstractCollapsiblePanelgetLeftCollapsedIcon in class AbstractCollapsiblePanelpublic void setLeftCollapsedIcon(String leftCollapsedIcon)
public String getLeftExpandedIcon()
AbstractCollapsiblePanelgetLeftExpandedIcon in class AbstractCollapsiblePanelpublic void setLeftExpandedIcon(String leftExpandedIcon)
public boolean isLimitRender()
isLimitRender in class AbstractTogglePanelpublic void setLimitRender(boolean limitRender)
public String getOnbeforeitemchange()
AbstractTogglePanelgetOnbeforeitemchange in class AbstractCollapsiblePanelpublic void setOnbeforeitemchange(String onbeforeitemchange)
public String getOnbeforeswitch()
AbstractCollapsiblePanelgetOnbeforeswitch in class AbstractCollapsiblePanelpublic void setOnbeforeswitch(String onbeforeswitch)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnitemchange()
AbstractTogglePanelgetOnitemchange in class AbstractCollapsiblePanelpublic void setOnitemchange(String onitemchange)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getOnswitch()
AbstractCollapsiblePanelgetOnswitch in class AbstractCollapsiblePanelpublic void setOnswitch(String onswitch)
public Object getRender()
getRender in class AbstractTogglePanelpublic void setRender(Object render)
public String getRightCollapsedIcon()
AbstractCollapsiblePanelgetRightCollapsedIcon in class AbstractCollapsiblePanelpublic void setRightCollapsedIcon(String rightCollapsedIcon)
public String getRightExpandedIcon()
AbstractCollapsiblePanelgetRightExpandedIcon in class AbstractCollapsiblePanelpublic void setRightExpandedIcon(String rightExpandedIcon)
public String getStatus()
getStatus in class AbstractTogglePanelpublic void setStatus(String status)
public String getStyle()
CorePropspublic void setStyle(String style)
public String getStyleClass()
CorePropsgetStyleClass in interface CorePropspublic void setStyleClass(String styleClass)
public String getTitle()
CorePropspublic void setTitle(String title)
public javax.el.MethodExpression getToggleListener()
AbstractCollapsiblePanelgetToggleListener in class AbstractCollapsiblePanelpublic void setToggleListener(javax.el.MethodExpression toggleListener)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.