|
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
public abstract class AbstractCollapsiblePanel
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 | |
|---|---|
static class |
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 | |
|---|---|
protected |
AbstractCollapsiblePanel()
|
| Method Summary | |
|---|---|
void |
addPanelToggleListener(org.richfaces.event.PanelToggleListener listener)
|
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. |
abstract String |
getDir()
|
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 |
getLang()
|
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 |
getOnclick()
|
abstract String |
getOndblclick()
|
abstract String |
getOnitemchange()
The client-side script method to be called after the item is changed. |
abstract String |
getOnmousedown()
|
abstract String |
getOnmousemove()
|
abstract String |
getOnmouseout()
|
abstract String |
getOnmouseover()
|
abstract String |
getOnmouseup()
|
abstract String |
getOnswitch()
The client-side script method to be called after the panel state is switched |
org.richfaces.event.PanelToggleListener[] |
getPanelToggleListeners()
|
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 String |
getStyle()
|
abstract String |
getStyleClass()
|
abstract String |
getTitle()
|
abstract javax.el.MethodExpression |
getToggleListener()
A Server-side MethodExpression to be called when the panel is toggled |
Object |
getValue()
|
protected 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. |
abstract boolean |
isExpanded()
When true, the panel is expanded, when false, the panel is collapsed |
void |
queueEvent(javax.faces.event.FacesEvent facesEvent)
|
void |
removePanelToggleListener(org.richfaces.event.PanelToggleListener listener)
|
abstract void |
setExpanded(boolean expanded)
|
void |
setValue(Object value)
|
String |
updateActiveName(String activeItemName)
|
| 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, getDefaultEventName, getEventNames, 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 |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
protected AbstractCollapsiblePanel()
| Method Detail |
|---|
public String getFamily()
getFamily in class AbstractTogglePanelpublic String getActiveItem()
AbstractTogglePanel
getActiveItem in class AbstractTogglePanelprotected boolean isActiveItem(javax.faces.component.UIComponent kid)
isActiveItem in class AbstractTogglePanel
protected boolean isActiveItem(javax.faces.component.UIComponent kid,
String value)
isActiveItem in class AbstractTogglePanelpublic String updateActiveName(String activeItemName)
updateActiveName in class AbstractTogglePanelpublic abstract boolean isExpanded()
public abstract void setExpanded(boolean expanded)
public abstract boolean isCycledSwitching()
AbstractTogglePanel
isCycledSwitching in class AbstractTogglePanelpublic void queueEvent(javax.faces.event.FacesEvent facesEvent)
queueEvent in class AbstractTogglePanelpublic 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 AbstractTogglePanelpublic 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 AbstractTogglePanelpublic abstract String getOnitemchange()
AbstractTogglePanel
getOnitemchange in class AbstractTogglePanelpublic abstract String getLang()
getLang in interface AbstractDivPanelpublic abstract String getDir()
getDir in interface AbstractDivPanelpublic abstract String getTitle()
getTitle in interface AbstractDivPanelpublic abstract String getStyle()
getStyle in interface AbstractDivPanelpublic abstract String getStyleClass()
getStyleClass in interface AbstractDivPanelpublic abstract String getOnclick()
getOnclick in interface AbstractDivPanelpublic abstract String getOndblclick()
getOndblclick in interface AbstractDivPanelpublic abstract String getOnmousedown()
getOnmousedown in interface AbstractDivPanelpublic abstract String getOnmousemove()
getOnmousemove in interface AbstractDivPanelpublic abstract String getOnmouseout()
getOnmouseout in interface AbstractDivPanelpublic abstract String getOnmouseover()
getOnmouseover in interface AbstractDivPanelpublic abstract String getOnmouseup()
getOnmouseup in interface AbstractDivPanelpublic void addPanelToggleListener(org.richfaces.event.PanelToggleListener listener)
addPanelToggleListener in interface org.richfaces.event.PanelToggleSourcepublic org.richfaces.event.PanelToggleListener[] getPanelToggleListeners()
getPanelToggleListeners in interface org.richfaces.event.PanelToggleSourcepublic void removePanelToggleListener(org.richfaces.event.PanelToggleListener listener)
removePanelToggleListener in interface org.richfaces.event.PanelToggleSourcepublic Object getValue()
getValue in interface javax.faces.component.ValueHoldergetValue in class javax.faces.component.UIOutputpublic void setValue(Object value)
setValue in interface javax.faces.component.ValueHoldersetValue in class AbstractTogglePanel
public void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class AbstractTogglePaneljavax.faces.event.AbortProcessingException
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||