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

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.UIModeList
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class UIModeList
extends javax.faces.component.UICommand


Nested Class Summary
static class UIModeList.ModeListItemSelectedEvent
          Class representing a change in selection for a ModeList component.
 
Field Summary
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
UIModeList()
          Default constructor
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 java.lang.String getFamily()
           
 int getIconColumnWidth()
          Get the icon column width
 java.lang.String getLabel()
           
 java.lang.String getMenuImage()
           
 boolean isDisabled()
          Returns the disabled flag
 boolean isHorizontal()
          Get the horizontal rendering flag
 boolean isMenu()
          Returns the menu rendering flag
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setDisabled(boolean disabled)
          Sets whether the mode list is disabled
 void setHorizontal(boolean horizontal)
          Set true for horizontal rendering, false otherwise
 void setIconColumnWidth(int iconColumnWidth)
          Set the icon column width
 void setLabel(java.lang.String label)
           
 void setMenu(boolean menu)
          Sets whether the mode list is a menu
 void setMenuImage(java.lang.String menuImage)
           
 
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, decode, encodeBegin, encodeChildren, encodeEnd, 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

UIModeList

public UIModeList()
Default constructor

Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand
See Also:
UIComponent.getFamily()

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)

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)

isHorizontal

public boolean isHorizontal()
Get the horizontal rendering flag

Returns:
true for horizontal rendering, false otherwise

setHorizontal

public void setHorizontal(boolean horizontal)
Set true for horizontal rendering, false otherwise

Parameters:
horizontal - the horizontal

getIconColumnWidth

public int getIconColumnWidth()
Get the icon column width

Returns:
the icon column width

setIconColumnWidth

public void setIconColumnWidth(int iconColumnWidth)
Set the icon column width

Parameters:
iconColumnWidth - the icon column width

isDisabled

public boolean isDisabled()
Returns the disabled flag

Returns:
true if the mode list is disabled

setDisabled

public void setDisabled(boolean disabled)
Sets whether the mode list is disabled

Parameters:
disabled - the disabled flag

isMenu

public boolean isMenu()
Returns the menu rendering flag

Returns:
true if the menu rendering mode is to be used

setMenu

public void setMenu(boolean menu)
Sets whether the mode list is a menu

Parameters:
menu - the menu flag

getLabel

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

setLabel

public void setLabel(java.lang.String label)
Parameters:
label - The label to set.

getMenuImage

public java.lang.String getMenuImage()
Returns:
Returns the menu image.

setMenuImage

public void setMenuImage(java.lang.String menuImage)
Parameters:
menuImage - The menu image to set.


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