Summary
Tag name: <t:toggleLink>
UIComponent class: org.apache.myfaces.custom.toggle.ToggleLink
Tag class: org.apache.myfaces.custom.toggle.ToggleLinkTag
Component type: org.apache.myfaces.ToggleLink
Component family: javax.faces.Output
Renderer type: org.apache.myfaces.ToggleLink
Renderer class: org.apache.myfaces.custom.toggle.ToggleLinkRenderer
Extends standard outputLink but links to a dynamically rendered resource (image, file, ...).
Should be nested within an HtmlToggleGroup component. Controls nested within
this component will be displayed in 'view' mode, controls outside this
component (within the parent HtmlToggleGroup) will be displayed in 'edit'
mode.
Attributes
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accesskey | String | Yes | HTML: Sets the access key for this element. |
| 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. |
| converter | javax.faces.convert.Converter | Yes | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. |
| 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 | HTML: When true, this element cannot receive focus. |
| 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. |
| for | String | No | The class which implements org.apache.myfaces.custom.dynamicResources.ResourceRenderer. The resource renderer is responsible for resource the image. The class must have a default constructor. Any request scoped attribute or managed bean is not available when this resource renderer is instantiated and used. The resource renderer must render the binary data for the resource by using the parameters passed by nested f:param elements and/or using session or application scoped beans. |
| 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. |
| lang | String | Yes | HTML: The base language of this document. |
| onClickFocusId | String | No | Id of the component that will be focused when toggleLink is clicked |
| 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. |
| 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. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed |
| 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. |