Summary
Tag name: <t:commandSortHeader>
UIComponent class: org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader
Tag class: org.apache.myfaces.custom.sortheader.HtmlCommandSortHeaderTag
Component type: org.apache.myfaces.HtmlCommandSortHeader
Component family: javax.faces.Command
Renderer type: org.apache.myfaces.SortHeader
Renderer class: org.apache.myfaces.custom.sortheader.HtmlSortHeaderRenderer
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.
Usage
<t:commandSortHeader [ all standard commandLink attributes allowed ] [ columnName="unique-column-name" ] [ arrow="{true|false}" ] > nested link text and/or image(s) </t:commandSortHeader>
Instructions
Must be nested inside an extended DataTable <t:dataTable>
(see examples/simpleSortList.jsp for an example)
Attributes
Name | Type | Supports EL? | Description |
---|---|---|---|
accesskey | String | Yes | HTML: Sets the access key for this element. |
action | javax.faces.el.MethodBinding | Yes | Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. 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. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. |
actionFor | String | Yes | Comma separated list of subForm-ids for which validation and model update should take place when this command is executed. You need to wrap your input components in org.apache.myfaces.custom.subform.SubForm instances for this to work. |
actionListener | javax.faces.el.MethodBinding | Only EL | A 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. |
arrow | boolean | Yes | Indicates whether an arrow, that shows the sort direction should be rendered. Default: false |
binding | String | Only EL | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. |
charset | String | Yes | HTML: Specifies the character encoding of the linked resource. |
columnName | String | Yes | 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). |
coords | String | Yes | HTML: The coordinates of regions within a client side image map. |
dir | String | Yes | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
disabled | boolean | Yes | When set instead of a Hyperlink a span tag is rendered in the corresponding Component |
disabledStyle | String | Yes | CSS-Style Attribute to render when disabled is true |
disabledStyleClass | String | Yes | CSS-Style Class to use when disabled is true |
enabledOnUserRole | String | Yes | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. |
forceId | boolean | No | If true, this component will force the use of the specified id when rendering. |
forceIdIndex | boolean | No | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) |
hreflang | String | Yes | HTML: The language of the linked resource. |
id | String | Yes | An identifier for this particular component instance within
a component view.
The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. |
immediate | boolean | Yes | A 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. |
lang | String | Yes | HTML: The base language of this document. |
onblur | String | Yes | HTML: Specifies a script to be invoked when the element loses focus. |
onclick | String | Yes | HTML: Script to be invoked when the element is clicked. |
ondblclick | String | Yes | HTML: Script to be invoked when the element is double-clicked. |
onfocus | String | Yes | HTML: Specifies a script to be invoked when the element receives focus. |
onkeydown | String | Yes | HTML: Script to be invoked when a key is pressed down over this element. |
onkeypress | String | Yes | HTML: Script to be invoked when a key is pressed over this element. |
onkeyup | String | Yes | HTML: Script to be invoked when a key is released over this element. |
onmousedown | String | Yes | HTML: Script to be invoked when the pointing device is pressed over this element. |
onmousemove | String | Yes | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
onmouseout | String | Yes | HTML: Script to be invoked when the pointing device is moves out of this element. |
onmouseover | String | Yes | HTML: Script to be invoked when the pointing device is moved into this element. |
onmouseup | String | Yes | HTML: Script to be invoked when the pointing device is released over this element. |
propertyName | String | Yes | 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). |
rel | String | Yes | HTML: The relationship between the current document and the linked resource. |
rendered | boolean | Yes | A boolean value that indicates whether this component should be rendered. Default value: true. |
rev | String | Yes | HTML: The type(s) describing the reverse link for the linked resource. |
shape | String | Yes | HTML: The shape of a region in a client side image map. |
style | String | Yes | HTML: CSS styling instructions. |
styleClass | String | Yes | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
tabindex | String | Yes | HTML: Specifies the position of this element within the tab order of the document. |
target | String | Yes | HTML: Names the frame that should display content generated by invoking this action. |
title | String | Yes | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
type | String | Yes | HTML: A hint to the user agent about the content type of the linked resource. |
value | Object | Yes | The initial value of this component. |
visibleOnUserRole | String | Yes | If 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. |