|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| 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
javax.faces.component.UIOutput
org.richfaces.component.AbstractTogglePanel
org.richfaces.component.AbstractCollapsiblePanel
org.richfaces.component.UICollapsiblePanel
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UICollapsiblePanel
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.
| Nested Class Summary | |
|---|---|
protected static class |
UICollapsiblePanel.Properties
|
| Nested classes/interfaces inherited from class org.richfaces.component.AbstractCollapsiblePanel |
|---|
AbstractCollapsiblePanel.States |
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class org.richfaces.component.AbstractTogglePanel |
|---|
ACTIVE_ITEM_META_COMPONENT, META_NAME_FIRST, META_NAME_LAST, META_NAME_NEXT, META_NAME_PREV, UPDATE_MESSAGE_ID |
| 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 org.richfaces.component.MetaComponentResolver |
|---|
META_COMPONENT_SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
UICollapsiblePanel()
|
|
| Method Summary | |
|---|---|
String |
getBodyClass()
Space-separated list of CSS style class(es) to be applied to the panel content. |
Object |
getData()
|
String |
getDefaultEventName()
|
String |
getDir()
|
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()
|
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()
|
String |
getOndblclick()
|
String |
getOnitemchange()
The client-side script method to be called after the item is changed. |
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
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()
|
String |
getStyleClass()
|
String |
getTitle()
|
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)
|
| Methods inherited from class org.richfaces.component.AbstractCollapsiblePanel |
|---|
addPanelToggleListener, broadcast, getActiveItem, getPanelToggleListeners, getValue, isActiveItem, isActiveItem, queueEvent, removePanelToggleListener, setValue, updateActiveName |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
clearInitialState, getConverter, getLocalValue, markInitialState, restoreState, saveState, setConverter |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, 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, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
|---|
addClientBehavior, getClientBehaviors |
| Methods inherited from interface org.richfaces.event.PanelToggleSource |
|---|
addPanelToggleListener, getPanelToggleListeners, removePanelToggleListener |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UICollapsiblePanel()
| Method Detail |
|---|
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()
AbstractCollapsiblePanel
getBodyClass in class AbstractCollapsiblePanelpublic void setBodyClass(String bodyClass)
public boolean isCycledSwitching()
AbstractTogglePanel
isCycledSwitching in class AbstractCollapsiblePanelpublic void setCycledSwitching(boolean cycledSwitching)
public Object getData()
getData in class AbstractTogglePanelpublic void setData(Object data)
public String getDir()
getDir in interface AbstractDivPanelgetDir in class AbstractCollapsiblePanelpublic void setDir(String dir)
public Object getExecute()
getExecute in class AbstractTogglePanelpublic void setExecute(Object execute)
public boolean isExpanded()
AbstractCollapsiblePanel
isExpanded 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()
AbstractCollapsiblePanel
getHeaderClass in class AbstractCollapsiblePanelpublic void setHeaderClass(String headerClass)
public javax.el.MethodExpression getItemChangeListener()
AbstractTogglePanel
getItemChangeListener in class AbstractCollapsiblePanelpublic void setItemChangeListener(javax.el.MethodExpression itemChangeListener)
public String getLang()
getLang in interface AbstractDivPanelgetLang in class AbstractCollapsiblePanelpublic void setLang(String lang)
public String getLeftCollapsedIcon()
AbstractCollapsiblePanel
getLeftCollapsedIcon in class AbstractCollapsiblePanelpublic void setLeftCollapsedIcon(String leftCollapsedIcon)
public String getLeftExpandedIcon()
AbstractCollapsiblePanel
getLeftExpandedIcon in class AbstractCollapsiblePanelpublic void setLeftExpandedIcon(String leftExpandedIcon)
public boolean isLimitRender()
isLimitRender in class AbstractTogglePanelpublic void setLimitRender(boolean limitRender)
public String getOnbeforeitemchange()
AbstractTogglePanel
getOnbeforeitemchange in class AbstractCollapsiblePanelpublic void setOnbeforeitemchange(String onbeforeitemchange)
public String getOnbeforeswitch()
AbstractCollapsiblePanel
getOnbeforeswitch in class AbstractCollapsiblePanelpublic void setOnbeforeswitch(String onbeforeswitch)
public String getOnclick()
getOnclick in interface AbstractDivPanelgetOnclick in class AbstractCollapsiblePanelpublic void setOnclick(String onclick)
public String getOndblclick()
getOndblclick in interface AbstractDivPanelgetOndblclick in class AbstractCollapsiblePanelpublic void setOndblclick(String ondblclick)
public String getOnitemchange()
AbstractTogglePanel
getOnitemchange in class AbstractCollapsiblePanelpublic void setOnitemchange(String onitemchange)
public String getOnmousedown()
getOnmousedown in interface AbstractDivPanelgetOnmousedown in class AbstractCollapsiblePanelpublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
getOnmousemove in interface AbstractDivPanelgetOnmousemove in class AbstractCollapsiblePanelpublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
getOnmouseout in interface AbstractDivPanelgetOnmouseout in class AbstractCollapsiblePanelpublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
getOnmouseover in interface AbstractDivPanelgetOnmouseover in class AbstractCollapsiblePanelpublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
getOnmouseup in interface AbstractDivPanelgetOnmouseup in class AbstractCollapsiblePanelpublic void setOnmouseup(String onmouseup)
public String getOnswitch()
AbstractCollapsiblePanel
getOnswitch in class AbstractCollapsiblePanelpublic void setOnswitch(String onswitch)
public Object getRender()
getRender in class AbstractTogglePanelpublic void setRender(Object render)
public String getRightCollapsedIcon()
AbstractCollapsiblePanel
getRightCollapsedIcon in class AbstractCollapsiblePanelpublic void setRightCollapsedIcon(String rightCollapsedIcon)
public String getRightExpandedIcon()
AbstractCollapsiblePanel
getRightExpandedIcon in class AbstractCollapsiblePanelpublic void setRightExpandedIcon(String rightExpandedIcon)
public String getStatus()
getStatus in class AbstractTogglePanelpublic void setStatus(String status)
public String getStyle()
getStyle in interface AbstractDivPanelgetStyle in class AbstractCollapsiblePanelpublic void setStyle(String style)
public String getStyleClass()
getStyleClass in interface AbstractDivPanelgetStyleClass in class AbstractCollapsiblePanelpublic void setStyleClass(String styleClass)
public String getTitle()
getTitle in interface AbstractDivPanelgetTitle in class AbstractCollapsiblePanelpublic void setTitle(String title)
public javax.el.MethodExpression getToggleListener()
AbstractCollapsiblePanel
getToggleListener in class AbstractCollapsiblePanelpublic void setToggleListener(javax.el.MethodExpression toggleListener)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||