You see the Properties window for a JavaServer Faces Hyperlink when you select the outer part of the component on a page that you are editing in the Visual Designer or you select the Hyperlink part of this composite component in the Navigator window.
The Hyperlink component consists of an Output Text component embedded in a Hyperlink component . When you select this component in the Visual Designer, you also see it in the Navigator window, where you can select the part of the component you want to work with.
This standard JavaServer Faces component has the following properties.
General
id.Type: text
The name of the Hyperlink component in the page bean and the JSP file.
target. Type: String
The frame of the current page in which the link is to be opened.
Appearance
style. Type: String
Cascading Style Sheet rules (CSS level 2) to be applied to the component. This property overrides any settings in the project CSS file. For example:
position: absolute; left: 288px; top: 312px
You can enter values directly or click the ellipsis (...) button to use the Style Editor.
For a list of CSS2 style attributes, see the web page at
styleClass. Type: String
Enter a space-separated list of CSS2 style classes to be applied when the component is rendered. The style classes must be defined in the project's style sheet. If you click the ellipsis button (...), you see a list of all styles you can add to this property. For information on adding CSS classes and rules to the project's cascading style sheet, see CSS Editor.
title. Type: String
Information about the Hyperlink that is readable by a screen reader and can be displayed as a tool tip.
If the component is disabled, the tool tip will not display in most browsers.
Data
converter. Type: Converter
A JavaServer Faces converter that produces the correct type of value for the value property. If the user enters the wrong type of value, such as a word instead of a number for an Integer converter, the converter sends a message that you can display in an Inline Message component.
value. Type: Object
The URL of the target document or resource. Equivalent to the HTML attribute href.
JavaScript
onblur. Type: String
JavaScript to be executed when the component loses focus.
onclick. Type: String
JavaScript to be executed when the user clicks the component.
ondblclick. Type: String
JavaScript to be executed when the user double-clicks the component.
onfocus. Type: String
JavaScript to be executed when the component gains focus.
onkeydown. Type: String
JavaScript to be executed when the component has focus and a key is pressed.
onkeypress. Type: String
JavaScript to be executed when the component has focus and a key is pressed and released.
onkeyup. Type: String
JavaScript to be executed when the component has focus and a key is released.
onmousedown. Type: String
JavaScript to be executed when the mouse cursor is over the component and the user presses down on the mouse button.
onmousemove. Type: String
JavaScript to be executed when the user moves the mouse cursor within the component.
onmouseout. Type: String
JavaScript to be executed when the user moves the mouse cursor away from the component after it has been over the component.
onmouseover. Type: String
JavaScript to be executed when the user moves the mouse cursor onto the component.
onmouseup. Type: String
JavaScript to be executed when the mouse cursor is over the component and the user releases the mouse button.
Advanced
accesskey. Type: String
A keyboard key, or keyboard shortcut, that activates this Hyperlink. You can enter any valid character that can be typed on the keyboard. Equivalent to the accesskey attribute of the HTML <input> tag.
charset. Type: String
The character encoding of the document or resource to which this hyperlink links. Equivalent to the HTML attribute charset of the <a> tag. You can see a list of encodings at
.
coords. Type: String
The position and shape of the hotspot on the page, used for client-side image maps. Equivalent to the HTML attribute coords of the <a> tag. The number and order of values depends on the shape being defined. Possible combinations are:
rectangle. left-x, top-y, right-x, bottom-y.
circle. center-x, center-y, radius.
polygon. x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon.
Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas.
dir. Type: String
An indicator of the directionality if the text does not inherit directionality (for example, because the text is English but the primary language for the page is Hebrew). Equivalent to the dir attribute of the HTML <input> tag.
Values can be:
LTR. Left-to-right.
RTL. Right-to-left.
hreflang. Type: String
Code describing the language used by the document or resource to which the hyperlink links. This property takes the same values as Language Code, which is described next.
lang. Type: String
Code describing the language used in the generated markup for the component. Equivalent to the lang attribute of the HTML <input> tag. To choose a language code, you can click the ellipsis button (...) to open the property editor. Some examples:
ar - Traditional Arabic
de - German
en - English
es - Spanish
fr - French
ja - Japanese
In addition to the codes available in the property editor, you can also enter additional codes using ISO standard names. Some examples:
en-US - United States English
ja-JP - Japanese
zh-guoyu - Mandarin or Standard Chinese
zh-Hans - Simplified Chinese script
zh-HanT - Traditional Chinese script
rel. Type: String
Specifies the relationship to the linked document. Same as the HTML attribute rel: a space separated list of types. The types can be any of the following:
Alternate. Substitute versions for the document in which the link occurs. When used with the lang attribute, it means that the substitute is a translated version of the document.
Appendix. An appendix in a collection of documents.
Bookmark. A link to an entry point in a document.
Chapter. A chapter in a collection of documents.
Contents. A table of contents.
Copyright. A copyright for the current document.
Glossary. A glossary of terms for the current document.
Help. A help document.
Index. An index for the current document.
Next. The next document in a sequence of documents.
Prev. The previous document in a sequence of documents.
Section. A section in a collection of documents.
Start. The first document in a collection of documents: the starting point of the collection.
Stylesheet. Refers to an external style sheet. Used with the link type Alternate to provide for user-selectable alternate style sheets.
Subsection. A subsection in a collection of documents.
rendered. Type: boolean
If selected, the hyperlink is to be rendered and processed on any subsequent page submission. If not selected, the hyperlink does not appear on the page at all, not even as a hidden component. You can bind this property to a variable that determines when the hyperlink does get rendered. For example, an airline reservation form might show a hyperlink for frequent flyers and not show it for the general public. To bind this property, right-click the component in the Visual Designer and choose Property Bindings, and then select the All radio button to display all properties so you can select the rendered property.
rev. Type: String
A reverse type link from the document to which this hyperlink links back to this document. Equivalent to the HTML attribute rev, a space-separated list of types. See the Relationship property above for a list of types.
shape. Type: String
The shape of the hotspot on the page, used for client-side image maps. Equivalent to the HTML attribute shape of the <a> tag. Possible values are:
default. Entire region
rectangle. Rectangular region.
circle. Circular region.
polygon. Polygonal region.
tabindex. Type: String
Optionally specifies the position of the Hyperlink in the tab order of the document, determining when the Hyperlink will get focus if the user tabs through the document. The value must be an integer between 0 and 32767. Equivalent to the tabindex attribute of the HTML <input> tag.
type. Type: String
The content type of the resource to which this hyperlink links. Equivalent to the HTML attribute type, which is a MIME type, such as text/html, image/png, image/gif, video/mpeg, text/css, or audio/basic.