Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:link

f:javax.faces.Component
   f:javax.faces.Output
      xp:com.ibm.xsp.UIOutputEx
         xp:com.ibm.xsp.UIOutputLink
            xp:link

Description

A control that links to a different page, to another control on the same page, or to an external resource using a URL.

Properties

Java

Java Class: com.ibm.xsp.component.xp.XspOutputLink


accessibility

title, string
Advisory Title
Provides title information for controls.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
tabindex, string
Tab Index
Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
accesskey, string
Access Key
Transfers focus to the control when pressed
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
role, string
Control Identifier
Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
text, string  [Inherited]
Text
The label text for this control
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dir, string
Direction
Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
lang, string
Language Code
Describes the language used in the generated markup of the control.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
htmlFilter, string
HTML Filtering processor name
Indicates which Active Content Filtering processor to use.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
escape, boolean
Escape Characters
Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
charset, string
Character Set
Specifies the character encoding of the resource referenced by the hyperlink.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
hreflang, string
Language
Specifies the language code of the resource referenced by the hyperlink.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rel, string
Relationship
Specifies the relationship between the current document and the anchor referenced by the control. The value is a list of link types separated by spaces.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rev, string
Reverse Link
Specifies a reverse link from the anchor referenced by the control to the current document. Value is list of link types separated by spaces.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
target, string
Target Frame
Indicates the name of the frame where the resource retrieved by the control is to be displayed.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
type, string
Content Type
Specifies the type of content referenced by the control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

value, generic  [Inherited]
Value
Contains the current value of the control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
converter, f:converterInterface - javax.faces.convert.Converter  [Inherited]
Converter
Converter instance registered with this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
parameters, Collection of xp:parameter - com.ibm.xsp.complex.Parameter  [Inherited]
Parameters
A list of parameters
Required Attribute false

events

onclick, string
Click Script
JavaScript code executed when a pointer control is clicked over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousedown, string
Mouse Down Script
JavaScript code executed when a pointer control is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseup, string
Mouse Up Script
JavaScript code executed when a pointer control is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseover, string
Mouse Over Script
JavaScript code executed when a pointer control is moved onto this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousemove, string
Mouse Move Script
JavaScript code executed when a pointer control is moved within this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseout, string
Mouse Out Script
JavaScript code executed when a pointer control is moved away from this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeypress, string
Key Press Script
JavaScript code executed when a key is pressed and released over this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeydown, string
Key Down Script
JavaScript code executed when a key is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeyup, string
Key Up Script
JavaScript code executed when a key is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onblur, string
Focus Off Script
JavaScript code executed when this control loses focus
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onfocus, string
Focus On Script
JavaScript code executed when this control receives focus
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

format

contentType, string
Content Type
Specifies the type of content to expect. HTML and Text are supported. Text is the default.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
coords, string
Coordinates
The position and shape of the hot spot on the screen (for use in client-side image maps).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
shape, string
Shape
The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
style, string
CSS Styles
Specifies CSS style(s) to be applied when this control is rendered.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
styleClass, string
CSS Style Classes
Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
outerStyleClass, string
CSS Outer Style Classes
Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true