org.apache.myfaces.custom.sortheader
Class HtmlCommandSortHeader

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by javax.faces.component.html.HtmlCommandLink
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
                      extended by org.apache.myfaces.component.html.ext.HtmlCommandLink
                          extended by org.apache.myfaces.custom.sortheader.AbstractHtmlCommandSortHeader
                              extended by org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader
All Implemented Interfaces:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ForceIdAware, UserRoleAware

public class HtmlCommandSortHeader
extends AbstractHtmlCommandSortHeader


Nested Class Summary
protected static class HtmlCommandSortHeader.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlCommandSortHeader()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getCharset()
           
 String getColumnName()
          The name of this column.
 String getCoords()
           
 String getDir()
           
 String getFamily()
           
 String getHreflang()
           
 String getLang()
           
 String getOnblur()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnfocus()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getPropertyName()
          The property name associated with this column.
 String getRel()
           
 String getRev()
           
 String getShape()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTarget()
           
 String getTitle()
           
 String getType()
           
 boolean isArrow()
          Indicates whether an arrow, that shows the sort direction should be rendered.
 boolean isDisabled()
          When set instead of a Hyperlink a span tag is rendered in the corresponding Component
 void setAccesskey(String accesskey)
           
 void setArrow(boolean arrow)
           
 void setCharset(String charset)
           
 void setColumnName(String columnName)
           
 void setCoords(String coords)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setHreflang(String hreflang)
           
 void setLang(String lang)
           
 void setOnblur(String onblur)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnfocus(String onfocus)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setPropertyName(String propertyName)
           
 void setRel(String rel)
           
 void setRev(String rev)
           
 void setShape(String shape)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTarget(String target)
           
 void setTitle(String title)
           
 void setType(String type)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 
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, isForceId, isForceIdIndex, setActionFor, 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
getDefaultEventName, getEventNames
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlCommandSortHeader

public HtmlCommandSortHeader()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class HtmlCommandLink

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class HtmlCommandLink

getColumnName

public 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(String columnName)

getPropertyName

public 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(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)

isDisabled

public boolean isDisabled()
Description copied from class: AbstractHtmlCommandLink
When set instead of a Hyperlink a span tag is rendered in the corresponding Component

Overrides:
isDisabled in class HtmlCommandLink

setDisabled

public void setDisabled(boolean disabled)
Overrides:
setDisabled in class HtmlCommandLink

getStyle

public String getStyle()
Overrides:
getStyle in class HtmlCommandLink

setStyle

public void setStyle(String style)
Overrides:
setStyle in class HtmlCommandLink

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class HtmlCommandLink

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class HtmlCommandLink

getTabindex

public String getTabindex()
Overrides:
getTabindex in class HtmlCommandLink

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class HtmlCommandLink

getOnblur

public String getOnblur()
Overrides:
getOnblur in class HtmlCommandLink

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class HtmlCommandLink

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class HtmlCommandLink

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class HtmlCommandLink

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class HtmlCommandLink

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class HtmlCommandLink

getOnclick

public String getOnclick()
Overrides:
getOnclick in class HtmlCommandLink

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class HtmlCommandLink

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class HtmlCommandLink

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class HtmlCommandLink

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class HtmlCommandLink

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class HtmlCommandLink

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class HtmlCommandLink

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class HtmlCommandLink

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class HtmlCommandLink

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class HtmlCommandLink

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class HtmlCommandLink

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class HtmlCommandLink

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class HtmlCommandLink

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class HtmlCommandLink

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class HtmlCommandLink

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class HtmlCommandLink

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class HtmlCommandLink

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class HtmlCommandLink

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class HtmlCommandLink

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class HtmlCommandLink

getDir

public String getDir()
Overrides:
getDir in class HtmlCommandLink

setDir

public void setDir(String dir)
Overrides:
setDir in class HtmlCommandLink

getLang

public String getLang()
Overrides:
getLang in class HtmlCommandLink

setLang

public void setLang(String lang)
Overrides:
setLang in class HtmlCommandLink

getTitle

public String getTitle()
Overrides:
getTitle in class HtmlCommandLink

setTitle

public void setTitle(String title)
Overrides:
setTitle in class HtmlCommandLink

getCharset

public String getCharset()
Overrides:
getCharset in class HtmlCommandLink

setCharset

public void setCharset(String charset)
Overrides:
setCharset in class HtmlCommandLink

getCoords

public String getCoords()
Overrides:
getCoords in class HtmlCommandLink

setCoords

public void setCoords(String coords)
Overrides:
setCoords in class HtmlCommandLink

getHreflang

public String getHreflang()
Overrides:
getHreflang in class HtmlCommandLink

setHreflang

public void setHreflang(String hreflang)
Overrides:
setHreflang in class HtmlCommandLink

getRel

public String getRel()
Overrides:
getRel in class HtmlCommandLink

setRel

public void setRel(String rel)
Overrides:
setRel in class HtmlCommandLink

getRev

public String getRev()
Overrides:
getRev in class HtmlCommandLink

setRev

public void setRev(String rev)
Overrides:
setRev in class HtmlCommandLink

getShape

public String getShape()
Overrides:
getShape in class HtmlCommandLink

setShape

public void setShape(String shape)
Overrides:
setShape in class HtmlCommandLink

getTarget

public String getTarget()
Overrides:
getTarget in class HtmlCommandLink

setTarget

public void setTarget(String target)
Overrides:
setTarget in class HtmlCommandLink

getType

public String getType()
Overrides:
getType in class HtmlCommandLink

setType

public void setType(String type)
Overrides:
setType in class HtmlCommandLink

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class HtmlCommandLink

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class HtmlCommandLink


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.