|
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
javax.faces.component.UIPanel
org.icefaces.ace.component.panel.PanelBase
public class PanelBase
Panel is a generic grouping component that also supports toggling, closing and options menu. Both Close and Toggle events can be listened on server side with ajax listeners.
For more information, see the Panel Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
PanelBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIPanel |
---|
COMPONENT_FAMILY |
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 | |
---|---|
PanelBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
int |
getCloseSpeed()
Return the value of the closeSpeed property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
java.lang.String |
getFooter()
Return the value of the footer property. |
java.lang.String |
getHeader()
Return the value of the header property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
int |
getToggleSpeed()
Return the value of the toggleSpeed property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
boolean |
isClosable()
Return the value of the closable property. |
boolean |
isCollapsed()
Return the value of the collapsed property. |
boolean |
isToggleable()
Return the value of the toggleable property. |
boolean |
isVisible()
Return the value of the visible property. |
void |
setClosable(boolean closable)
Set the value of the closable property. |
void |
setCloseSpeed(int closeSpeed)
Set the value of the closeSpeed property. |
void |
setCollapsed(boolean collapsed)
Set the value of the collapsed property. |
void |
setFooter(java.lang.String footer)
Set the value of the footer property. |
void |
setHeader(java.lang.String header)
Set the value of the header property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setToggleable(boolean toggleable)
Set the value of the toggleable property. |
void |
setToggleSpeed(int toggleSpeed)
Set the value of the toggleSpeed property. |
void |
setVisible(boolean visible)
Set the value of the visible property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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 |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public PanelBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public void setClosable(boolean closable)
Set the value of the closable
property.
Contents: Boolean value that specifies whether the panel has a close button.
setClosable
in interface IPanel
public boolean isClosable()
Return the value of the closable
property.
Contents: Boolean value that specifies whether the panel has a close button. Default = 'false'.
isClosable
in interface IPanel
public void setCloseSpeed(int closeSpeed)
Set the value of the closeSpeed
property.
Contents: Integer value that specifies the duration of the closing animation.
setCloseSpeed
in interface IPanel
public int getCloseSpeed()
Return the value of the closeSpeed
property.
Contents: Integer value that specifies the duration of the closing animation. Default = '1000'.
getCloseSpeed
in interface IPanel
public void setCollapsed(boolean collapsed)
Set the value of the collapsed
property.
Contents: Boolean value that specifies whether the panel is collapsed.
setCollapsed
in interface IPanel
public boolean isCollapsed()
Return the value of the collapsed
property.
Contents: Boolean value that specifies whether the panel is collapsed. Default = 'false'.
isCollapsed
in interface IPanel
public void setFooter(java.lang.String footer)
Set the value of the footer
property.
Contents: Footer text of the panel.
setFooter
in interface IPanel
public java.lang.String getFooter()
Return the value of the footer
property.
Contents: Footer text of the panel.
getFooter
in interface IPanel
public void setHeader(java.lang.String header)
Set the value of the header
property.
Contents: Header text of the panel.
setHeader
in interface IPanel
public java.lang.String getHeader()
Return the value of the header
property.
Contents: Header text of the panel.
getHeader
in interface IPanel
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style to apply to the container element.
setStyle
in interface IPanel
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style to apply to the container element.
getStyle
in interface IPanel
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class to apply to the container element.
setStyleClass
in interface IPanel
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class to apply to the container element.
getStyleClass
in interface IPanel
public void setToggleSpeed(int toggleSpeed)
Set the value of the toggleSpeed
property.
Contents: Integer value that specifies the duration of the transition between states.
setToggleSpeed
in interface IPanel
public int getToggleSpeed()
Return the value of the toggleSpeed
property.
Contents: Integer value that specifies the duration of the transition between states. Default = '1000'.
getToggleSpeed
in interface IPanel
public void setToggleable(boolean toggleable)
Set the value of the toggleable
property.
Contents: Boolean value that specifies whether to display a button to toggle between the expanded and collapsed states of the panel.
setToggleable
in interface IPanel
public boolean isToggleable()
Return the value of the toggleable
property.
Contents: Boolean value that specifies whether to display a button to toggle between the expanded and collapsed states of the panel. Default = 'false'.
isToggleable
in interface IPanel
public void setVisible(boolean visible)
Set the value of the visible
property.
Contents: Boolean value that specifies whether the panel is visible.
setVisible
in interface IPanel
public boolean isVisible()
Return the value of the visible
property.
Contents: Boolean value that specifies whether the panel is visible. Default = 'true'.
isVisible
in interface IPanel
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Name of the widget variable to access the client side api.
setWidgetVar
in interface IPanel
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Name of the widget variable to access the client side api.
getWidgetVar
in interface IPanel
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
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 |