org.apache.myfaces.custom.sortheader
Class HtmlCommandSortHeader

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              javax.faces.component.html.HtmlCommandLink
                  org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
                      org.apache.myfaces.component.html.ext.HtmlCommandLink
                          org.apache.myfaces.custom.sortheader.AbstractHtmlCommandSortHeader
                              org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader

All Implemented Interfaces:

javax.faces.component.ActionSource, javax.faces.component.StateHolder, ForceIdAware, UserRoleAware

public class HtmlCommandSortHeader
extends AbstractHtmlCommandSortHeader

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlCommandSortHeader()

Method Summary

java.lang.String	getColumnName() The name of this column.
java.lang.String	getFamily()
java.lang.String	getPropertyName() The property name associated with this column.
boolean	isArrow() Indicates whether an arrow, that shows the sort direction should be rendered.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setArrow(boolean arrow)
void	setColumnName(java.lang.String columnName)
void	setPropertyName(java.lang.String propertyName)

Methods inherited from class org.apache.myfaces.custom.sortheader.AbstractHtmlCommandSortHeader

broadcast, findParentDataTable

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink

getActionFor, getDisabledStyle, getDisabledStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isDisabled, isForceId, isForceIdIndex, setActionFor, setDisabled, setDisabledStyle, setDisabledStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink

getClientId, isRendered

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

getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, setAccesskey, setCharset, setCoords, setDir, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType

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, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlCommandSortHeader

public HtmlCommandSortHeader()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class HtmlCommandLink

getColumnName

public java.lang.String getColumnName()

Description copied from class: AbstractHtmlCommandSortHeader

The name of this column. This name must uniquely identify this column among all other (sortable) columns in the same data_table. The sortColumn attribute of the embedding data_table reflects the current sort column (see extended data_table).

Specified by:

getColumnName in class AbstractHtmlCommandSortHeader

setColumnName

public void setColumnName(java.lang.String columnName)

getPropertyName

public java.lang.String getPropertyName()

Description copied from class: AbstractHtmlCommandSortHeader

The property name associated with this column. This name must be one of the properties of the row object by which the sorting should be performed. The sortProperty attribute of the embedding data_table reflects the current sort property (see extended data_table).

Specified by:

getPropertyName in class AbstractHtmlCommandSortHeader

setPropertyName

public void setPropertyName(java.lang.String propertyName)

isArrow

public boolean isArrow()

Description copied from class: AbstractHtmlCommandSortHeader

Indicates whether an arrow, that shows the sort direction should be rendered. Default: false

Specified by:

isArrow in class AbstractHtmlCommandSortHeader

setArrow

public void setArrow(boolean arrow)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class HtmlCommandLink

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class HtmlCommandLink