t
Tag commandSortHeader


Clickable sort column header. Must be nested inside an extended data_table tag. This tag is derived from the standard command_link tag and has the additional attributes columnName and arrow. Note: In contrast to normal command links, the default for the "immediate" attribute is "true". This is desirable as it avoids validating all input fields in the enclosing form when the column sort order changes. HOWEVER when the table contains input components "immediate" must be set to false; otherwise input fields will render blank after a sort, or will show their old values (ie will not appear to sort though output fields in the table will sort) when sort ordering is changed. Unless otherwise specified, all attributes accept static values or EL expressions.


Tag Information
Tag Classorg.apache.myfaces.custom.sortheader.HtmlCommandSortHeaderTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
idfalsefalsejava.lang.StringThe developer-assigned ID of this component. The ID must be unique within the scope of the tag's enclosing naming container (e.g. h:form or f:subview). This value must be a static value.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
immediatefalsefalsejava.lang.StringA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
actionfalsefalsejava.lang.StringA method binding EL expression that identifies an action method to be invoked if this component is activated by the user. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute.
actionListenerfalsefalsejava.lang.StringA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.
valuefalsefalsejava.lang.StringThe initial value of this component.
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
accesskeyfalsefalsejava.lang.StringHTML: Sets the access key for this element.
charsetfalsefalsejava.lang.StringHTML: Specifies the character encoding of the linked resource.
tabindexfalsefalsejava.lang.StringHTML: Specifies the position of this element within the tab order of the document.
onblurfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element loses focus.
onfocusfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element receives focus.
typefalsefalsejava.lang.StringHTML: A hint to the user agent about the content type of the linked resource.
targetfalsefalsejava.lang.StringHTML: Names the frame that should display content generated by invoking this action.
coordsfalsefalsejava.lang.StringHTML: The coordinates of regions within a client side image map.
hreflangfalsefalsejava.lang.StringHTML: The language of the linked resource.
relfalsefalsejava.lang.StringHTML: The relationship between the current document and the linked resource.
revfalsefalsejava.lang.StringHTML: The type(s) describing the reverse link for the linked resource.
shapefalsefalsejava.lang.StringHTML: The shape of a region in a client side image map.
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
columnNametruefalsejava.lang.StringThe 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).
propertyNamefalsefalsejava.lang.StringThe 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).
arrowfalsefalsejava.lang.StringIndicates whether an arrow, that shows the sort direction should be rendered. Default: false

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.