org.alfresco.web.ui.common.component

Class UIPanel

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.alfresco.web.ui.common.component.UIPanel

All Implemented Interfaces:

ActionSource, StateHolder

public class UIPanel
extends UICommand

Author:

kevinr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIPanel.ExpandedEvent Class representing the an action relevant when the panel is expanded or collapsed.

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Constructors

Constructor and Description
UIPanel() Default constructor

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
void	encodeEnd(FacesContext context)
String	getBgcolor()
String	getBorder()
MethodBinding	getExpandedActionListener()
String	getExpandedTitleBorder()
String	getFacetsId() Get the facets component Id to use
String	getFamily()
String	getLabel()
String	getTitleBgcolor()
String	getTitleBorder()
UIComponent	getTitleComponent() Return the UI Component to be displayed on the right of the panel title area
boolean	isExpanded() Returns whether the component show allow rendering of its child components.
boolean	isProgressive()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setBgcolor(String bgcolor)
void	setBorder(String border)
void	setExpanded(boolean expanded) Sets whether the component show allow rendering of its child components.
void	setExpandedActionListener(MethodBinding binding)
void	setExpandedTitleBorder(String expandedTitleBorder)
void	setFacetsId(String facets) Set the facets component Id to use
void	setLabel(String label)
void	setProgressive(boolean progressive)
void	setTitleBgcolor(String titleBgcolor)
void	setTitleBorder(String titleBorder)

Methods inherited from class javax.faces.component.UICommand

addActionListener, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIPanel

public UIPanel()

Default constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UICommand

See Also:

UIComponent.getFamily()

getTitleComponent

public UIComponent getTitleComponent()

Return the UI Component to be displayed on the right of the panel title area

Returns:

UIComponent

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeEnd(javax.faces.context.FacesContext)

decode

public void decode(FacesContext context)

Overrides:

decode in class UIComponentBase

See Also:

UIComponentBase.decode(javax.faces.context.FacesContext)

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UICommand

Throws:

AbortProcessingException

See Also:

UICommand.broadcast(javax.faces.event.FacesEvent)

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UICommand

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UICommand

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

setExpandedActionListener

public void setExpandedActionListener(MethodBinding binding)

Parameters:

binding - The MethodBinding to call when expand/collapse is performed by the user.

getExpandedActionListener

public MethodBinding getExpandedActionListener()

Returns:

The MethodBinding to call when expand/collapse is performed by the user.

getBgcolor

public String getBgcolor()

Returns:

Returns the bgcolor.

setBgcolor

public void setBgcolor(String bgcolor)

Parameters:

bgcolor - The bgcolor to set.

getBorder

public String getBorder()

Returns:

Returns the border name.

setBorder

public void setBorder(String border)

Parameters:

border - The border name to user.

getTitleBgcolor

public String getTitleBgcolor()

Returns:

Returns the bgcolor of the title area

setTitleBgcolor

public void setTitleBgcolor(String titleBgcolor)

Parameters:

titleBgcolor - Sets the bgcolor of the title area

getTitleBorder

public String getTitleBorder()

Returns:

Returns the border style of the title area

setTitleBorder

public void setTitleBorder(String titleBorder)

Parameters:

titleBorder - Sets the border style of the title area

getExpandedTitleBorder

public String getExpandedTitleBorder()

Returns:

Returns the border style of the expanded title area

setExpandedTitleBorder

public void setExpandedTitleBorder(String expandedTitleBorder)

Parameters:

expandedTitleBorder - Sets the border style of the expanded title area

getLabel

public String getLabel()

Returns:

Returns the label.

setLabel

public void setLabel(String label)

Parameters:

label - The label to set.

isProgressive

public boolean isProgressive()

Returns:

Returns the progressive display setting.

setProgressive

public void setProgressive(boolean progressive)

Parameters:

progressive - The progressive display boolean to set.

isExpanded

public boolean isExpanded()

Returns whether the component show allow rendering of its child components.

setExpanded

public void setExpanded(boolean expanded)

Sets whether the component show allow rendering of its child components. For this component we change this value if the user indicates to change the hidden/visible state of the progressive panel.

getFacetsId

public String getFacetsId()

Get the facets component Id to use

Returns:

the facets component Id

setFacetsId

public void setFacetsId(String facets)

Set the facets component Id to use

Parameters:

facets - the facets component Id