org.alfresco.web.ui.common.component.data
Class UISortLink

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

public class UISortLink
extends javax.faces.component.UICommand


Field Summary
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
UISortLink()
          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)
           
 java.lang.String getColumn()
          Column name referenced by this link
 java.lang.String getLabel()
           
 java.lang.String getMode()
          Sorting mode - see IDataContainer constants
 java.lang.String getTooltip()
           
 boolean isDescending()
          Returns true for descending sort, false for ascending
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setLabel(java.lang.String label)
           
 void setMode(java.lang.String sortMode)
          Set the sorting mode - see IDataContainer constants
 void setTooltip(java.lang.String tooltip)
           
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionListener, getActionListeners, getFamily, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, 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

UISortLink

public UISortLink()
Default Constructor

Method Detail

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:
UIComponent.encodeBegin(javax.faces.context.FacesContext)

decode

public void decode(javax.faces.context.FacesContext context)
Overrides:
decode in class javax.faces.component.UIComponentBase
See Also:
UIComponent.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:
UIComponent.broadcast(javax.faces.event.FacesEvent)

getColumn

public java.lang.String getColumn()
Column name referenced by this link

Returns:
column name

getMode

public java.lang.String getMode()
Sorting mode - see IDataContainer constants

Returns:
sorting mode - see IDataContainer constants

setMode

public void setMode(java.lang.String sortMode)
Set the sorting mode - see IDataContainer constants

Parameters:
sortMode - the sorting mode- see IDataContainer constants

isDescending

public boolean isDescending()
Returns true for descending sort, false for ascending

Returns:
true for descending sort, false for ascending

getLabel

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

setLabel

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

getTooltip

public java.lang.String getTooltip()
Returns:
Returns the tooltip.

setTooltip

public void setTooltip(java.lang.String tooltip)
Parameters:
tooltip - The tooltip to set.

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)


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