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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.alfresco.web.ui.common.component.UIPanel
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class UIPanel
extends javax.faces.component.UICommand


Nested Class Summary
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
UIPanel()
          Default constructor
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 void decode(javax.faces.context.FacesContext context)
           
 void encodeBegin(javax.faces.context.FacesContext context)
           
 void encodeEnd(javax.faces.context.FacesContext context)
           
 java.lang.String getBgcolor()
           
 java.lang.String getBorder()
           
 javax.faces.el.MethodBinding getExpandedActionListener()
           
 java.lang.String getExpandedTitleBorder()
           
 java.lang.String getFacetsId()
          Get the facets component Id to use
 java.lang.String getFamily()
           
 java.lang.String getLabel()
           
 java.lang.String getTitleBgcolor()
           
 java.lang.String getTitleBorder()
           
 javax.faces.component.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(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setBgcolor(java.lang.String bgcolor)
           
 void setBorder(java.lang.String border)
           
 void setExpanded(boolean expanded)
          Sets whether the component show allow rendering of its child components.
 void setExpandedActionListener(javax.faces.el.MethodBinding binding)
           
 void setExpandedTitleBorder(java.lang.String expandedTitleBorder)
           
 void setFacetsId(java.lang.String facets)
          Set the facets component Id to use
 void setLabel(java.lang.String label)
           
 void setProgressive(boolean progressive)
           
 void setTitleBgcolor(java.lang.String titleBgcolor)
           
 void setTitleBorder(java.lang.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 java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand
See Also:
UIComponent.getFamily()

getTitleComponent

public javax.faces.component.UIComponent getTitleComponent()
Return the UI Component to be displayed on the right of the panel title area

Returns:
UIComponent

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException
See Also:
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException
Overrides:
encodeEnd in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException
See Also:
UIComponentBase.encodeEnd(javax.faces.context.FacesContext)

decode

public void decode(javax.faces.context.FacesContext context)
Overrides:
decode in class javax.faces.component.UIComponentBase
See Also:
UIComponentBase.decode(javax.faces.context.FacesContext)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UICommand
Throws:
javax.faces.event.AbortProcessingException
See Also:
UICommand.broadcast(javax.faces.event.FacesEvent)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UICommand
See Also:
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UICommand
See Also:
StateHolder.saveState(javax.faces.context.FacesContext)

setExpandedActionListener

public void setExpandedActionListener(javax.faces.el.MethodBinding binding)
Parameters:
binding - The MethodBinding to call when expand/collapse is performed by the user.

getExpandedActionListener

public javax.faces.el.MethodBinding getExpandedActionListener()
Returns:
The MethodBinding to call when expand/collapse is performed by the user.

getBgcolor

public java.lang.String getBgcolor()
Returns:
Returns the bgcolor.

setBgcolor

public void setBgcolor(java.lang.String bgcolor)
Parameters:
bgcolor - The bgcolor to set.

getBorder

public java.lang.String getBorder()
Returns:
Returns the border name.

setBorder

public void setBorder(java.lang.String border)
Parameters:
border - The border name to user.

getTitleBgcolor

public java.lang.String getTitleBgcolor()
Returns:
Returns the bgcolor of the title area

setTitleBgcolor

public void setTitleBgcolor(java.lang.String titleBgcolor)
Parameters:
titleBgcolor - Sets the bgcolor of the title area

getTitleBorder

public java.lang.String getTitleBorder()
Returns:
Returns the border style of the title area

setTitleBorder

public void setTitleBorder(java.lang.String titleBorder)
Parameters:
titleBorder - Sets the border style of the title area

getExpandedTitleBorder

public java.lang.String getExpandedTitleBorder()
Returns:
Returns the border style of the expanded title area

setExpandedTitleBorder

public void setExpandedTitleBorder(java.lang.String expandedTitleBorder)
Parameters:
expandedTitleBorder - Sets the border style of the expanded title area

getLabel

public java.lang.String getLabel()
Returns:
Returns the label.

setLabel

public void setLabel(java.lang.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 java.lang.String getFacetsId()
Get the facets component Id to use

Returns:
the facets component Id

setFacetsId

public void setFacetsId(java.lang.String facets)
Set the facets component Id to use

Parameters:
facets - the facets component Id


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.