org.apache.shale.usecases.rolodex
Class HeaderSorter

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.html.HtmlOutputText
                  org.apache.shale.usecases.rolodex.HeaderSorter

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class HeaderSorter
extends javax.faces.component.html.HtmlOutputText

Field Summary

Fields inherited from class javax.faces.component.html.HtmlOutputText

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY

Constructor Summary

HeaderSorter()
Sets the renderer type to "org.apache.shale.HeaderSorter".

Method Summary

String	getAscImage() Returns the acending image resource location that is relative to the context root.
String	getDescImage() Returns the decending image resource location that is relative to the context root.
String	getFamily() Sets the family to "org.apache.shale.Sorter".
String	getSortBy() Returns a comma delimited list of properties to sort by.
boolean	isSortAscending() Returns true if the model data is sorted in ascending order defined by the sortBy property.
void	restoreState(javax.faces.context.FacesContext facescontext, Object obj) Restores the component's state.
Object	saveState(javax.faces.context.FacesContext facescontext) Saves the component's state.
void	setAscImage(String string) Sets the acending image resource location that is relative to the context root.
void	setDescImage(String string) Sets the decending image resource location that is relative to the context root.
void	setSortAscending(boolean b) This setter toggles the collating sequence from ascending to descending.
void	setSortBy(String s) Sets a comma delimited list of properties to sort by.
boolean	wasSelected() Returns true if the component was selected.

Methods inherited from class javax.faces.component.html.HtmlOutputText

getStyle, getStyleClass, getTitle, isEscape, setEscape, setStyle, setStyleClass, setTitle

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, 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, queueEvent, 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

HeaderSorter

public HeaderSorter()

Sets the renderer type to "org.apache.shale.HeaderSorter".

Method Detail

getFamily

public String getFamily()

Sets the family to "org.apache.shale.Sorter".

Overrides:

getFamily in class javax.faces.component.UIOutput

wasSelected

public boolean wasSelected()

Returns true if the component was selected.

restoreState

public void restoreState(javax.faces.context.FacesContext facescontext,
                         Object obj)

Restores the component's state.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.html.HtmlOutputText

saveState

public Object saveState(javax.faces.context.FacesContext facescontext)

Saves the component's state.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.html.HtmlOutputText

getSortBy

public String getSortBy()

Returns a comma delimited list of properties to sort by. The property names are defined in the bean collection contained by the UIData model.

setSortBy

public void setSortBy(String s)

Sets a comma delimited list of properties to sort by. The property names are defined in the bean collection contained by the UIData model.

isSortAscending

public boolean isSortAscending()

Returns true if the model data is sorted in ascending order defined by the sortBy property.

setSortAscending

public void setSortAscending(boolean b)

This setter toggles the collating sequence from ascending to descending.

getAscImage

public String getAscImage()

Returns the acending image resource location that is relative to the context root.

getDescImage

public String getDescImage()

Returns the decending image resource location that is relative to the context root.

setAscImage

public void setAscImage(String string)

Sets the acending image resource location that is relative to the context root.

setDescImage

public void setDescImage(String string)

Sets the decending image resource location that is relative to the context root.