Faces Attribute Reference

This is a list of all possible attributes for all JSF components.

Rendering

This component has no visual rendering. No HTML is rendered.

Rendering

The component's visual rendering varies depending upon the component selected.

Component at design time

Component at runtime

Attributes

Parent tags

This tag is used as a child of the following tags:

Rendering

The tag is rendered by its parent tag, see the parent tag descriptions for more information.

Properties view

Some components may be hidden on the palette. To show a hidden component in the palette, right-click within the palette view and choose Customize. Remove the check next to Hide for each component that you want to display on the palette. Components that are initially hidden are denoted by an asterisk (*) below. The Properties view for a component shows the most common set of attributes you can set on a component, and, depending on the component, you might also see options for adding controls, actions, or other components. To open the Properties view, click Window > Show View > Properties; however, it is opened by default.

Properties view

All Attributes view

The All Attributes view shows a table of all the attributes you can set on a component, which includes those attributes you can access from the Properties view. To switch to the All Attributes view, click the All Attributes icon All Attributes icon in the Properties view.

All Attributes view

Properties and All Attributes views

The Properties view for a component shows the most common set of attributes you can set on a component, and, depending on the component, you might also see options for adding controls, actions, or other components. To open the Properties view, click Window > Show View > Properties.

Quick Edit view

Configure this component using the Quick Edit view. To open the Quick Edit view, click Window > Show View > Quick Edit.

The All Attributes view shows a table of all the attributes you can set on a component, which includes those attributes you can access from the Properties view. To switch to the All Attributes view, click the All Attributes icon All Attributes icon in the upper right corner of the Properties view.

Property name

Represented in All Attributes view by

Attribute name

Represented in Properties view by

Description

For components

Configuration option

Not represented

Format type

Format options

Add an action that is performed when a row is clicked

Allows you to create a runtime action that happens when a row is clicked.

Add an edit column that brings up a form for in-place editing of row content

Allows you to provide in-row editing at runtime.

Add selection column to the table

Allows you to add a column with choices related to the table contents.

Add action that manipulates selection to header

Allows you to create an action that manipulates the header information.

Add a choice for each check box in the group

Allows you to specify the names, values and order of boxes in the check box group component. You can add single choices or a set of choices.

Add a choice for each radio button in the group

Allows you to specify the names, values and order of radio buttons in the radio button group component. You can add single choices or a set of choices.

Add a choice for each item in the color menu

Allows you to specify the names, values and order of colors in the selectOneColor component. You can add single choices or a set of choices.

Add a choice for each item in the combo box drop-down

Allows you to specify the names, values and order of items in the drop-down menu of the component.

Add a choice for each radio button in the group

Allows you to specify the names, values and order of buttons in the radio button group component.

Add a choice for item in the list box

Allows you to specify the names, values and order of items within the list box component.

Add a parameter value to substitute for each {n} in the value string

Allows you to specify the names and values of Output Message parameters. You may also remove items using the Remove button and change their order in the panel using the Move Up and Move Down buttons.

Add the parameters that control the player

Specifies what parameters are used to control the media player component.

Add the parameters that are passed to the action

Specifies what parameters are passed to the action by the component.

Add a panel for each tab to display in the control

Allows you to specify the IDs, labels and order of tabs in the panels - tabbed component. Additionally, you may also specify that individual tabs contain predefined finish and cancel command button components.

Add a Web style pager

Adds each page number to the footer area so that the desired page can be clicked on by the user.

Categorization>Add column to categorize table rows

Categorization>Remove column to categorize table rows

Adds a column with a row categorization component where you can set table sort values and add icons or text to the column. Once added, the Categorization icon changes to Remove.

Add goto pager

Adds a component to the footer area that lets you select a page from a drop-down list.

Add deluxe pager

Adds a component to the footer area that uses arrows to move between pages.

Add simple pager

Adds a component to the footer that creates a simple drop down menu for moving to the next page.

Add page information

Adds a component to the footer area that displays statistics on the pages.

Add items to the control

Allows you to view the items in the menu bar, as well as add hyperlinks, command buttons, sub-panels, and separators. You may also remove items using the Remove button and change their order in the panel using the Move Up and Move Down buttons.

Behavior>After user types X characters

Enact the control attribute after an end user enters this many characters into the component.

Assign actions to the specified keystrokes.

Specifies key strokes, actions and targets of those actions within the form component. Key strokes and actions are chosen from drop down lists. The targets are selected from a drop down list populated with input fields present within the form. Whenever the key is pressed within the form, the action is executed.

Background image

Specifies an image to be used as the background. Click the Browse button to choose an image file or to bind to a data source.

Click to code the action this button performs

Switches to the Quick Edit view so that actions for the command button to perform may be programmed. Additionally, rules can be defined based upon the actions and outcomes returned.

Click to code the action this link performs

Switches to the Quick Edit view so that actions for the hyperlink to perform may be programmed. Additionally, rules can be defined based upon the actions and outcomes returned.

Click to create/edit custom validation code

Switches to the Quick Edit view so that scripts or snippets of code may be entered for various user initiated events.

Columns

Specifies whether a header or footer is to be included in the data table. Use the Add and Remove buttons to add or delete columns. Use the Move Up and Move Down buttons to modify the order of the columns.

Display validation error messages in an error message control

Inserts an error message component associated with the selected component. This will display an error message if the validation fails.

Do not line wrap cell contents

Specifies that contents of the selected cell should not wrap.

File Type

Specifies the type of file to be used by the component. Can be statically defined or linked to data storage.

File Name

Specifies the name of the file to be used by the component. Can be statically defined or linked to data storage.

Format

Specifies the format of the data to be manipulated by the component: Refer to the individual format types table for details.

String

String: Specifies that the input supplied by the user should be in the form of a text string.

Number

Number: Specifies that the input supplied by the user should be in the form of a number.

Date/Time

Date/Time: Specifies that the input supplied by the user should be in the form of date and/or time.

Mask

Mask: Specifies that the input supplied by the user be filtered in a way that selectively includes or excludes certain values.

Specifies the format of the data to be manipulated by the component: Refer to the individual format types table for details.

Format: String

String: Specifies that the output should be in the form of a text string.

Format: Number

Number: Specifies that the output should be in the form of a number.

Format: Date/Time

Date/Time: Specifies that the output should be in the form of date and/or time.

Format: Mask

Mask: Specifies that the output be filtered in a way that selectively includes or excludes certain values.

Hidden Fields

Displays all current Input - Hidden components within the form and allows you to add, remove, and modify hidden fields.

Horizontal Alignment

Specifies whether the panel should be aligned on the left, center or right.

Options

Options>Opens a window with a list of custom attributes that may be set for this component.

Order of items in the panel

Allows you to specify the order of components within the panel, using the Move Up and Move Down buttons.

Select the content of this field

Specifies that the field chosen to have focus should also initially have its contents selected.

Show header

Checking this box inserts a header region, f:facet (header) and h:panelBox, into the data table which can then be populated with other components.

Show helper button

Show helper button>Specifies that the component should display a helper button to the user.

Show footer

Checking this box inserts a footer region, f:facet (footer) and h:panelBox, into the data table which can then be populated with other components.

Show prompt character

Show prompt character>Specifies a symbol be made visible to the user to prompt them for input.

Use simple validation

Use simple validation>Allows you to enter a simple minimum and maximum range that the component will validate against.

Use advanced validation

Use advanced validation>Allows you to specify a more advanced expression for validation using EL syntax.

Validate field value in the browser

Allows for the field validation to happen in the browser at runtime.

Set focus when the page is initially displayed

Specifies the field that will have the initial focus when the page is displayed. First field in page or Specific Fields (identified by their ID) may be specified.

"All Attributes" view attributes

accept

Allow the following types of files

Specifies the types of files, separated by commas, that the component will allow.

acceptcharset

The character set in which the response to the client is expected. Standard HTML attr. See the HTML form tag: This attribute specifies the list of character encodings for input data that is accepted by the server processing this form. The value is a space-delimited and/or comma-delimited list of charset values. The client must interpret this list as an exclusive-or list, that is, the server is able to accept any single character encoding per entity received.

accesskey

char

Accessibility>Access Key

Specifies a single keyboard key as an access key. Pressing the specified access key at runtime gives focus to this component. Pressing ALT plus the specified access key at runtime gives focus to this component (or executes the component if it is a kind of button).

action

Specifies the value returned when the component is clicked. The value is passed to the default NavigationHandler, that then matches the value against a set of navigation rules defined in the application configuration file.

actionListener

An expression that points to a method with an ActionEvent argument and a "void" return type.

align

Alignment

Specifies the alignment for the component:
Specifies the alignment for the component:

Alignment: Horizontal

Specifies whether the component should be aligned to the left, center or right.

alt

Accessibility>Alternate Text

Specifies alternate text for a component. The alternative text is displayed when the element cannot be rendered normally, for example, in browsers that do not support forms and in browsers set to not display images.

archive

An attribute associated with the object html tag used to render the Media Components, used to specify a space-separated list of URLs for archives containing resources relevant to the object.

asis

Specifies whether data other than masked inputted are removed or not. Default value is false.

autoseparate

Show separator between each item

Checking this box specifies that separator lines appear between items in the action bar. If autoseparate is set to true, a separator item is automatically inserted between each contained components when rendered. If it is left blank, the default is false and no separator is inserted.

autoStart

Autoplay

If autostart is set to true, the rich media file will start playing automatically in the component. Checking this will cause the component to start automatically at run time.

autoTab

Auto-advance to next field

Automatically advance to another input field after the specified number of characters has been entered. The default value is false.

Specifies whether auto-tabbing is enabled or disabled. Automatically advances user to another input field after the specified number of characters has been entered. When checked adds the hx:inputHelperAssist section to the All Attributes view and sets autoTab to True.

backgroundcolor

Sets the background color for the image window. When a clip includes transparent regions, the background color also shows through these areas.

baseURL

Specifies the base URL the media player will be operating in. For more information, see the Windows® Media documentation for baseURL in the MSDN Library.

bgcolor

Background color

Specifies the background color in 6 digit hexadecimal RGB values beginning with a # symbol, or by entering a color name, for example, black, white, or blue.

Specifies the color of the movie rectangle before the movie itself appears. The value is expressed in the standard six hexadecimal character RGB color representation (for example, #FFFF00).

binding

expression

An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).

border

Border

Specifies, in pixels, the size of the border for the table.

Specifies, in pixels, the size of the border for the player.

Specifies, in pixels, the size of the border for the image.

cancelBubble

Specifies whether the event bubble managed by browsers is cancelled or not:

cellpadding

Padding

Specifies the amount of space between the border of the cell and the cell contents. If the value of this attribute is a pixel length, all four margins should be this distance from the contents.

Specifies the amount of space between the border of the cell and its contents. If the value of this attribute is a pixel length, all four margins should be this distance from the contents.

cellspacing

Spacing

Specifies, in pixels, the amount of space between the individual cells within the table.

Specifies, in pixels, the amount of space to leave between cells.

center

Specifies whether the presentation should be centered in the image window and displayed in its original, encoded size.

charset

The character encoding of the resource designated by the hyperlink.

codebase

Specifies the base path used to resolve relative URIs specified by other attributes in the component.

collapsed

Specifies the initial collapse state of the category row. Values can be true or false. If left blank, the default is true.

collapsedImage

Specifies a custom image to be displayed when a category is collapsed.

color

Coloring

Specifies the color of the selected component in 6 digit hexadecimal RGB values beginning with a # symbol, or by entering a color name, for example, black, white, blue, and so on.

columnClasses

Column Classes

Assigns a defined CSS stylesheet style for the columns of the data table component. The CSS stylesheet file must be linked into the component's JSP before it can be used. This may be entered manually, or by clicking the button and selecting the desired classes from within the window.

cols

Size: Width

Specifies the number of columns displayed at runtime.

columns

Columns

Specifies the number of columns displayed at runtime.

Adds or removes column components from the table. You can set the label, width, and ID for each column and move them within the table.

Size: Columns

Specifies the number of columns in the grid.

confirm

Prompt Text

Specifies text to be displayed requesting confirmation when a commandExButton is pressed. If no value is set for this attribute, a confirm dialog will not be shown.

console

When the same console name is specified for multiple control on a Web page, this parameter can be used to enable these controls to manage playback of a single embedded presentation. For example, if you have multiple Play and Stop buttons on the same page, a shared console name enables them to control the same clip.

contentClass

Alternative CSS class names associated with the component. The situation in which these are used can be determined from the names.

controls

Embeds the specified RealPlayer control on your Web page.

converter

Specifies the data type to which the value is converted. The JavaServer Faces implementation provides a set of Converter implementations that you can use to convert your component data to a type not supported by its renderer.

coords

The position and shape of the hot spot on the screen (for use in client-side image maps).

currencyCode

Converts the Input Text string to an Input Text Number format.

currencySymbol

Currency Symbol

Specifies the symbol for the currency to be entered. Becomes active if you specify a currency number type.

dateStyle

Date Style

Predefined formatting style which determines how the date portion of a date string is to be formatted and parsed. Applied only if type is either date or both. Allows you to select one of several date formats:

decode

Used to specify a method to invoke at the decode phase of the scriptCollector component.

dimage

Type>Image: Disabled Image

Specifies the image to be displayed when the component is disabled.

dir

ltr, rtl

Specifies the component's direction when rendered at runtime. The values can be either: If the direction is not specified, a direction appropriate to the encoding of the component is used.

disabled

boolean

Control is disabled

Behavior>Control is disabled

If disabled is set to true, the component is displayed at runtime but is not functional. If left blank, the default value is false.

disableCancel

If set to true, the Cancel button is displayed at runtime but is not functional. If left blank, the default value is false.

disabledClass

Alternative CSS class names associated with the component The situation in which these are used can be determined from the names.

disableFinish

If set to true, the Finish button is displayed at runtime but is not functional. If left blank, the default value is false.

editStyle

CSS style applied to edit pane.

editStyleClass

CSS style class applied to edit pane and controls.

enableContextMenu

Specifies whether the context menu appears when the user clicks the right mouse button. Default is true.

enabledClass

Alternative CSS class names associated with the component The situation in which these are used can be determined from the names.

enctype

Specifies the content type used to submit the form.

errorAction

Specifies an action by one of the predefined actions or JavaScript™ function, which is invoked when client-side validation results in an error.

errorClass

Alternative CSS class names associated with the component. The situation in which these are used can be determined from their names.

Specifies a CSS class for error. The style is reset to the successClass style when a valid key is clicked in the input field. If the successClass is not specified, the css class for input_text is used. When neither errorClass nor successClass is specified, the css class is not reset. You can specify multiple classes separated by commas, for example: errorClass="class, class2, class3".

errorStyle

Style modifiers for the CSS classes.

escape

Specifies whether to escape HTML formatting (False) or to render HTML tags as HTML (True).

Render the HTML in the value

exclude

Mime types to be excluded.

exclude

Do not allow the following types of files

Specifies the types of files, separated by commas, that the component will exclude.

expandedImage

Specifies a custom image to be displayed when a category is expanded.

fatalClass

Alternative CSS class names associated with the component. The situation in which these are used can be determined from the names.

fatalStyle

Style modifiers for the CSS classes.

first

Index of the first row to be displayed.

footerClass

Footer Class

Assigns a defined CSS stylesheet style for the column headers of the data table component. The CSS stylesheet file must be linked into the component's JSP before it can be used. This may be entered manually, or by clicking the button and selecting the desired class from within the window.

for

Id to label

Specifies the component to which the helper component is to be applied. The value should be the ID of the helped component.

Display error message for the component

Specifies the ID of the input field for which you want to capture and display error messages.

frame

Specifies which sides of the frame surrounding a table will be visible:

Specifies which sides of the frame surrounding a grid will be visible.

globalOnly

Show all error messages generated by this page

Show only error messages not associated with a specific component.

Specifies what error messages the component should display, either all error messages generated by the page (False) or only error messages of components not already associated (True).

groupingsUsed

Specifies whether formatted output will contain grouping separators.

headerClass

Header Class

Assigns a defined CSS stylesheet style for the column headers of the data table component. The CSS stylesheet file must be linked into the component's JSP before it can be used. This may be entered manually, or by clicking the button and selecting the desired class from within the window.

height

Size: Height

Specifies the height of the component in either pixels or percentage. To specify percentage, append % to the value.

Specifies the height of the component in pixels.

hidden

Specifies whether or not to hide the player on a Web page.

himage

Type>Image: Moused Image

Specifies the image to display when the user's mouse pointer passes over the component.

The path to the image for this button.

hreflang

The language code of the resource designated by this hyperlink.

hspace

Margin: Horizontal

Specifies the amount of white space in pixels to be inserted to the left and right of the component.

id

ID

Assigns a name to a component. Should be a unique name within a JSP.

imagekey

Used in conjunction with the 'bundle' attribute, the imageKey attribute relates to a key within the set of key = value pairs specified in the bundle, where the value is a URL/URI to an image file.

image

Type>Image: Normal Image

Specifies an URL/URI to an image to be displayed in the component.

imeMode

This attribute is valid for Internet Explorer only. Specifies the IME mode:

immediate

boolean

If true, skip straight to render phase of life cycle.

infoClass

Alternative CSS class names associated with the component. The situation in which these are used can be determined from the names.

infoStyle

Style modifiers for the CSS classes.

initialPandelld

Specifies the panel's initial ID.

inputAssistant

Specifies whether client-side auto-formatting is enabled or not. The default value is false (not enabled).

integerOnly

Specifies whether only the integer part of the value will be parsed.

Integer Only

Specifies that the number entered into the field be restricted to an integer.

ismap

If set to true, the image component is set to use a Server Side image map. Note that the graphic component must be contained within a hyperlink component.

key

Specifies a key expression.

label

Specifies the displayed text.

lang

The language of the component's value(s) and text content. If omitted, the language is inherited from the containing tags (notably the view. Specified as an ISO-standard language abbreviation code. For example, "en" for English, "en-US" for American English, "fr" for French, "de" for German.
Note: This does not "translate" the text in the component, rather, it identifies the language of the component so that operations such as searching, sorting, collating and the like are done correctly.

layout

Panel Orientation

Layout of Panel: Orientation

Specifies the layout as horizontal or vertical:

Orientation

Direction

Specifies whether the component is oriented horizontally or vertically at runtime:

Display error: Layout

Specifies the formatting of the output from the component as either paragraph or list style:

locale

Locale whose predefined styles for dates and times are used during formatting or parsing. If not specified, the locale returned by FacesContext.getViewRoot().getLocale() is used.

Locale whose predefined styles for numbers are used during formatting or parsing. If not specified, the locale returned by FacesContext.getViewRoot().getLocale() is used.

longdesc

Specifies a link to a long description of the image. This description should supplement the short description provided using the alt attribute.

loop

Specifies whether playback of the clip should continue or loop, indefinitely. Default is true.

Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. Default is true.

mask

Specifies an input mask pattern by using mask characters. Use # as a digit placeholder and ? as a letter placeholder.

Mask

Specifies an output mask pattern by using mask characters. Use # as a digit placeholder and ? as a letter placeholder.

maxFractionDigits

Maximum number of digits that will be formatted in the fractional portion of the output.

maxIntegerDigits

Maximum number of digits that will be formatted in the integer portion of the output.

maxlength

After user types X characters

Behavior>After user types X characters

Enact the control attribute after an end user enters this many characters into the component.

Specifies the maximum length of characters the input component can allow.

Specifies the maximum length of characters for file name and location.

menu

Specifies the displayed menu type:

mimeType

Type

Used for declaring the media MIME type when src is bound to binary data.

minimum

Minimum length

The minimum number of characters this component can contain when submitted on the server.

The minimum number of characters this component can contain when submitted on the server. Adds a function f:validateLength with a minimum attribute to the All Attributes view.

maximum

Maximum length

The maximum number of characters this component can contain when submitted on the server.

The maximum number of characters this component can contain when submitted on the server. Adds the function f:validateLength with a maximum attribute to the All Attributes view.

minFractionDigits

Minimum number of digits that will be formatted in the fractional portion of the output.

minIntegerDigits

Minimum number of digits that will be formatted in the integer portion of the output.

name

Specifies a name for the component, should be unique within a JSP.

Specifies the name of the facet that is added, for example, header in a data table.

nestedExpanded

Initially show panel expanded

Expand or collapse the child panelActionbar. It is applied only if one panelActionbar is nested inside another.

nestedImagePosition

Image Position

Places the image before or after the label of the child panelActionbar. It is applied only if one panelActionbar is nested inside another.

nestedIndent

Amount by which the submenu of the child panelActionbar will be indented. It is applied only if one panelActionbar is nested inside another.

nestedTitleText

Label

Label of child panelActionbar. It is applied only if one panelActionbar is nested inside another.

nestedTitleImage

Image

Specifies an image to go before or after the label. The button to the right of the field allows you to browse for or import the image.

noscript

Do not use JavaScript with this control.

noshade

Display using 3-D shading

Check to give the component a three-dimensional, shaded appearance. If noshade is set to true, the component is rendered in a solid color. If left blank, the browser used will display the tag in its default way.

numOfTabs

Scroll after display of X tabs

Number of tabs to be displayed on the panel. Limits the number of tabs visible within the component to the number entered into the field. Additional tabs can be accessed by using the inserted scrolling control.

pattern

Pattern

Becomes active if you select a custom type number field. Custom formatting pattern which determines how the string should be parsed.

pimage

Type>Image: Depressed Image

Specifies the image to display when a user clicks on the component.

playCount

Specifies the number of times a clip plays.

playerAttributes

For adding a list of additional player attributes/parameters, the list should be a comma separated list of name=value pairs.

pluginsPage

Specifies URL containing player code for download. Shown if player is not already installed.

pluginUrl

Specifies location of Java™ Archive (JAR) file containing player code for download. Shown if player is not already installed.

preRender

Used to specify a method that is to be invoked at the start of the encode. Begin phase of the scriptCollector, that is, the method is invoked just before the component is rendered.

postRender

Used to specify a method that is to be invoked at the end of the encode. End phase of the scriptCollector, that is, the method is invoked immediately after the component is rendered.

promptCharacter

The underscore character ( _ ) is the default character value for the property. The PromptChar property can only be set to exactly one character.

Prompt character

Specifies the character to be shown to prompt a user for input.

quality

Specifies playing quality:

Options: Quality

Specifies a picture quality level for the component. Note that a High quality level can affect performance.

readonly

boolean

Control is read-only

Behavior>Control is read-only

Specifies that the value of the component cannot be changed from its initial value.

redisplay

If set to 'true' at runtime, the password asterisks will be redisplayed in same named password fields after submitting the containing form.

regex

Constraint

Limits the type of characters that can be entered into the component (for example, Digits Only or ASCII Alphabet Only). Adds hx:validateConstraint with the regex attribute to the All Attributes view.

rel

The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types.

renderButton

Render a button as an accessibility hook for keyboard navigation.

rendered

boolean

Can be set to true or false:

required

Value is Required

Validation>Value is Required

The component must be specified. Check this to require the user to enter a value.

rev

A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types.

rowClasses

Row Classes

A set of classes which are cycled through as the rows are displayed. This may be defined manually, or by clicking the button and selecting the desired classes from within the window.

rows

Rows per page

Specifies the number of rows displayed at runtime.

rules

Specifies which rules will appear between cells within a table:

salign

Specifies alignment:

scale

Specifies scale:

separatorSize

Size (pixels between items)

Specifies the size (in pixels) between items within the component.

Specifies the pixel width of the rendered table cell containing the separators.

separatorStyle

Style

Assigns a defined CSS stylesheet style for the separator (for example, solid lines or whitespace). The CSS stylesheet file must be linked into the component's JSP before it can be used.

shape

Sets the shape of the link:

showFinishCancelButton

Displays Finish and Cancel buttons.

showBackNextButton

Displays Next and Back buttons.

Checking this box inserts a pair of buttons that can be used to cycle between the various tabs within the component.

Specifies whether or not Back and Next buttons are shown for navigating between panels.

showDetail

Specifies whether the detail part of the error is shown.

showSummary

Specifies whether the summary of the message is shown.

showTabs

Hide tabs

Checking this box specifies that the tabs in the component should be hidden from the user.

Show only this many tabs at a time and display scroller-buttons used to get to the tabs not displayed.

shuffle

Specifies whether all unplayed clips in a presentation, should be played back in a random order. This parameter can be used for multi-clip RAM files (.ram or .rpm) or SMIL files that contain only a sequence of clips

size

The width (in characters) of the control. The width can be more precisely specified via CSS.

Size: Height

Specifies the height of the component (by number of lines, pixels or percentage of the screen).

Size: Width

Specifies the initial width of the component. The width is given in pixels except in the case of a text input component where its value refers to the number of characters.

Specifies the initial width of the component, where its value refers to the number of characters.

slantActiveLeft

Width of nip off the upper left side of the tab, when tab is the selected tab.

slantActiveRight

Width of the tab border curve in pixels on the upper right side of the tab, when the tab is select.

slantInactiveLeft

Width of nip off the upper left side of the tab, when tab is NOT the selected tab.

slantInactiveRight

Width of nip off the upper right side of the tab, when tab is NOT the selected tab.

Tab border curve (in pixels)

Width of nip of the relevant side of the tab (left or right). You may set the width for both active and inactive tabs.

srcFirst

The URL to an image representing the first button.

srcLast

The URL to an image representing the last button.

srcNext

The URL to an image representing the next button.

srcPrevious

The URL to an image representing the previous button.

srcSelected

URL of image to display when selected.

srcUnselected

URL of image to display when unselected.

src

File

Media file to be played. Specifies the file to be used by the component.

standby

Specifies a message that a browser may render while loading the component's implementation and data.

stretchToFit

Specifies whether to maintain the original aspect ratio of the video to be played. Default is false.

style

string

Style: Props

Specifies CSS style information for the component (for example, style="font-size : 8pt ; color : red"). Defines the properties (such as font and color) of the selected component. This may be done manually, or by clicking the button and selecting the desired properties from within the window.

styleClass

string

Style: Classes

Space-separated list of CSS style classes to be applied when this element is rendered. This value must be passed through as the class attribute on generated markup. Defines the classes (such as style sheets) of the selected component. This may be done manually, or by clicking the button and selecting the desired Classes from within the window.

successAction

Specifies an action by one of the predefined actions or JavaScript function, which is invoked when client-side validation results in success.

successClass

Specifies a CSS class for success with client-side validation. Multiple classes can be specified.

summary

Specifies a summary details string for user agents rendering to non-visual media.

swRemote

Controls all Shockmachine functionality and has separate sub-parameters. For details, refer to Shockmachine parameters in the Macromedia Director Support Center.

swStretchHAlign

Specifies horizontal alignment when swStretchStyle is set to meet or stage:

swStretchStyle

Specifies the stretch style to use for the Shockwave media:

swStretchVAlign

Specifies vertical alignment when swStretchStyle is set to meet or stage:

tabindex

integer

Accessibility>Tab order index

Specifies the position of the component in the tabbing order in the JSP. This value must be a number between 0 and 32767.

tabindexStartAt

Specifies the number to start the tabindex property at for the categories. Default is 0.

target

Assigns the target frame within a frameset that a page should be loaded into when the hyperlink is clicked:

Normally the behavior applies to the parent tag. Target can be used to assign it to a different tag. Note the value may identify an HTML (non-JSF) tag. #body can be supplied to apply the behavior to the entire page.

Specifies the action target by tag ID. When the target is not specified and action is set, the default target is the event-source object.

Assigns the target frame within a frameset that a page should be loaded into when a component is clicked.

targetAction

Specifies the predefined action.

textStyleClass

CSS class applied to the text field. This allows the distinction between the input type=submit and input type=text when using ELEMENT.className notation in CSS.

timeStyle

Time Style

Predefined formatting style which determines how the time portion of a date string is to be formatted and parsed. This attribute works only if the type is "time" or "both." Appears when Date/Time is selected. Allows you to select one of several time formats:

timeZone

Time zone in which to interpret any time information in the date string

title

string

Accessibility>Title

Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.

tooltip

Specifies whether detail part of message should be shown as tooltip.

type

Type

Specifies the button type, either Submit, Reset, or Plain .

Specifies that the component should use an item from a database

Specifies the type of number that will be used by the component:
The type of the dialog box. A modal dialog box blocks input (keyboard or mouse) to the window under the dialog (you must fill out the dialog and press OK or CANCEL before you may do anything else in the page). A modeless dialog box does not block input to the window "under" the dialog.
Note: More than one modeless dialog box may be displayed at a time. If more than one modal dialog box is displayed at a time, the boxes stack on top of each other and only the top dialog is active.

Specifies whether the date, the time, or both are displayed in the output field.

uiMode

Specifies the appearance of the embedded Windows Media Player:

url

Specifies the URL the component should use.

useButtons

Render text buttons instead of images.

usemap

Specifies an image map to be used with the component. The image map is defined by a MAP element. The value of usemap must match the value of the name attribute of the associated MAP element.

validation

Specifies whether client-side validation is enabled or not. The default value is true (enabled).

validator

Classname of validator to instantiate.

A method (represented by a MethodBinding expression) that accepts FacesContext, UIComponent, and Object parameters. It is called during the validation process to ensure that value of the component is correct.

valign

Alignment: Vertical

Specifies the vertical position of data within a cell:

value

Value

Specifies the document to which the link is connected. This can be a String containing the document filename or it can be the binary data of the document. Specifying binary data is done in conjunction with setting the mimetype attribute. The value can be a String(Base64 encoded), a byte[], or a java.io.InputStream object. When specifying binary data the value binding expression must be able to be evaluated on its own in a subsequent request back to the server by the browser for the document.

Specifies the initial text value for the component displayed at runtime. Contains information to be displayed, in the form of a specified value or a pointer to a dynamic value.

File

Specifies the file to be used by the component. The value can be a String (file content will be Base64 encoded), a byte[], or an object.

Type>Text: Button Label

Specifies the text to be displayed within the command button.

URL

Specifies the page to which the component links. This may be specified manually when the link is created on the page, or by clicking the button and selecting the page from the window.

valueChangeListener

Method to be notified when value of component has changed.

var

Specifies the reference variable name for the data available using the value attribute.

variableTabLength

Specifies whether tabs will be of different lengths, depending on their name.

variableTableLength

Layout of tabs: Display tabs with a uniform width

Specifies that all tabs within the component be displayed with the same width.

volume

Specifies the volume, in hundredths of decibels ranging from –10,000 to 0. The default value is –600.

vspace

Margin: Vertical

Specifies the amount of white space, in pixels, to be inserted to the top and bottom of the component.

warnClass

Alternative CSS class names associated with the component. The situation in which these are used can be determined from the names.

warnStyle

Style modifiers for the CSS classes.

width

Width

Size: Width

Specifies the width of the component in either pixels or percentage. To specify percentage is to be used append % to the value.

wmode

Specifies the window mode property of the Flash movie for transparency, layering, and positioning in the browser:

onblur

JavaScript event handler invoked when the date changes.

onclick

JavaScript event handler invoked if a mouse button is clicked while the mouse pointer is over the component. Fires after the individual mousedown and mouseup events. Should not fire if the mouse pointer is moved such that the release of the button occurs while the pointer is outside the component.

onblclick

JavaScript event handler invoked if a mouse button is clicked twice while the mouse pointer is over the component. Fires after the individual mousedown and mouseup events. The click event should not be fired in this case.

onfocus

JavaScript event handler invoked when the component receives focus.

onkeydown

JavaScript event handler invoked when a keyboard key is pressed down.

onkeypress

JavaScript event handler invoked when a character is formed as the result of pressing a keyboard key. Browsers differ as to whether the event is fired when a "function" or "control" key pressed.

onkeyup

JavaScript event handler invoked when a keyboard key is released.

onmousedown

JavaScript event handler invoked if a mouse button is pressed down while the mouse pointer is over the component.

onmousemove

JavaScript event handler invoked each time the mouse pointer is moved while over a component. Browsers differ in regard to the granularity of a what constitutes a move, although the event should fire each time the pointer is moved at least one pixel.

onmouseout

JavaScript event handler invoked when the mouse pointer is outside (away from) a component. A mouseover event should have been fired before this event.

onmouseover

JavaScript event handler invoked when the mouse pointer is initially moved over a component.

onmouseup

JavaScript event handler invoked if a mouse button is released down while the mouse pointer is over the component.

<hx:behavior>

Assign a JWL Action and/or JavaScript to a DOM event handler.

<hx:behaviorKeyPress>

Assign a JWL Action and/or JavaScript to the pressing of a function/control key when a component or the content of a component has focus.

<hx:behaviorRightMouse>

Assign a JWL Action and/or Javascript to the clicking of the right mouse button on a component or on the content of a component.

<hx:ajaxRefreshRequest>

Mark the panel as AJAX-able where requests to re-retrieve the content include parameters which can be used to vary the content of the panel.

<hx:ajaxRefreshSubmit>

Mark the panel as AJAX-able where requests to re-retrieve the content submit the contents of the containing form so that the form contents can be used to vary the content of the panel.

<hx:ajaxExternalRequest>

Mark the panel as AJAX-able where requests to re-retrieve the content are directed to a different page than the one containing the panel (e.g., an "external data source").

flyOpen

boolean

When you mouse over a menu-item in the top-level menu that has children, the child menu is displayed, if set to true or omitted. If it is set to false, you must click on a menu-item in the top-level menu that has children in order to see the child menu.

flyOpenBody

boolean

When you mouse over a menu-item in the top-level menu that has children, the child menu is displayed, if set to true or omitted. If it is set to false, you must click on a menu-item in the top-level menu that has children in order to see the child menu.

initialSelection

string

The ID of a menu item that is initially displayed as "selected" (selected is a different CSS defined visual state).

openInPlace

boolean

If false or omitted, child menus are displayed in a "separate window" (that is, they float above the page content). If true, the child menus open "in place", that is, space opens up in the menu bar after the parent menu item and the child menu is displayed in that space. This allows a menu to be "tree-style" (like Windows Explorer). Only one child menu at each level of the menu tree is displayed "in place". When a different child menu is displayed, any other menu that is displayed "in place" is "closed" (hidden) before the new menu is displayed. If a menu is openInPlace, it is also sticky.
Note: If openInPlace is used in a horizontal menu it may not render properly.
Note:

openSticky

boolean

If omitted or false, child menus are displayed as a "pop-ups" that are only on display when they are "active" (they parent menu item has been moused-over or clicked on). If true, for each level below the top-level menu, the last child menu that is moused/clicked at that level is left on display.
Note: The top-level menu is always sticky. This property affects only child menus.

selectAll

boolean

If an initial selection is provided (or if one is set via JavaScript), specifies if only the child item is shown selected (false or omitted) or if all items from the containing parent menu down to the child item are shown as selected.

vertical

boolean

If true, the top-level menu is displayed vertically. If false or omitted, it is drawn horizontally.

verticalBody

boolean

If true or omitted, the child-menus (all menus other than the top-level menu) are displayed vertically. If false, they are drawn horizontally.

onchange

JavaScript

If provided, the function is called whenever an action is taken.

altClass

boolean

If true, this menu item is styled via the "alt class" CSS classes. If false or omitted, the item is styled using the "normal" CSS classes.

itemDisabled

boolean

If true, this menu item is disabled. If false or omitted, the menu item is not disabled.

actionClick

boolean

If true, clicking on this menu item executes both the tag associated with the item (e.g., executes the requestLink) and displays the child menu associated with this item. This attribute is only meanigful when applied to the child tag in a header facet, that is, to a menu item which has a child menu associated with it. By default, clicking on any menu item that does not have children, executes the menu item. Eqaully, clicking on any menu item that does have an associated child menu only displays the child menu. In certain cases (usually when building a navigation structure) clicking on a menu item that has an associated child menu needs to both execute the action (e.g., get a page, targetted to a different frame) and display the child menu.

multiLine

boolean

Default is true. If true, the header area of the calendar is displayed on two lines (one for year and one for month). If false, the header area is displayed on one line.

border

Width (in pixels) of the border to be drawn around the table containing the options list.

converter

The ID or class name of a custom converter to use with this component. If a custom converter is defined in a TLD, it may also be specified by using the converter tag as a child tag of the component.

onselect

JavaScript event handler invoked when the color changes.

buttonBorder

Controls how the button is drawn relative to the input field. By default, the button is drawn in a manner appropriate to the operating system of the browser so that the button looks like a combo box button. For example in Windows 2000 or Windows 9X, the button is drawn as part of the border. In Windows XP, the button is drawn as a separately from the input field (to the right). The following values can be set:

buttonColor

Specifies the background-color of the button. By default the background color matches the border color of the input field. Use of this attribute is of limited value, it's currently more of a placeholder for a future extension that will allow an alternate button background graphic to be supplied.

dropdownClass

The base class of a set of CSS classes that describe the visual appearance of the dropdown popup. Note that the name excludes the suffixes (e.g., it's inputColor1 not inputColor1_ColorPicker).

showLabels

If specified (true), the name of the currently selected color is displayed in the input field on top of the color swatch. If omitted (or false), the name is not displayed and the input field displays only a color swatch showing the currently selected color.
Note: Ensure the width of the picker is set to a value large enough to accommodate the largest name or the picker may not display properly.

auto

If true, the progress bar is self-timing and when started, it automatically updates itself on the specified interval. If omitted or false, the progress bar must be updated manually. It redraws the bar as a result of JavaScript calls that specify the current status. If auto is true, the bar does not display percent complete. If false, it displays percent complete.

initHidden

If true, the progress bar is hidden when the page is initially displayed. This should be used instead of setting "display:none" in the progress bar's style.

message

The message to display above the bar. This may be changed via JavaScript as the bar is running.

outward

If true, the progress bar draws from the center outwards. If omitted or false, the bar draws from left to right.

proportion

If auto is true (optional, default is 5), the amount (percentage of the width of the progress bar) the bar increments each time it updates. For example, a value of 10 means each increment widens the bar by 10% of total width. If auto is false or not set (optional, default is 0), the amount (percentage) the bar intially displays. For example, a value of 15 means that the bar shows the starting value as 15%.

initValue

If auto is false or not set (optional, default is 0), the amount (percentage) the bar intially displays. For example, a value of 15 means that the bar shows the starting value as 15%.

timeInterval

If auto is true, interval (how often) the bar is updated. Specified in milliseconds, for example, a value of 5000 means the bar changes every 5 seconds.

enableMoveKey

If omitted or true, dialogs that are movable can be moved via the keyboard by pressing Ctrl+Shift+Arrow-key whenever something in the dialog has focus. If false, the dialog cannot be moved via the keyboard.

initiallyShow

If true, when the page is loaded, the dialog is shown (the onshow handler is called, the primary window is disabled). If false, the dialog is not initially shown.

initialFocus

If an identifier is provided, when the dialog is shown, focus is initially set to this field (and the content of the field selected if appropriate). If omitted or false, when the dialog is shown, focus is set to the first focusable field in the dialog.

movable

Specifies whether the dialog can be moved by pressing the mouse cursor down on the title bar and dragging the dialog to a different location or using the keyboard equivalent. If false, the dialog cannot be moved.
Note: If a dialog is movable and has no title bar, it may only be moved using the keyboard accelerators.

relativeTo

If an ID is provided and align or valign is set to relative, the alignment is relative to the identified tag.

saveState

If true, when the dialog is displayed a copy of the values from all "form" fields within the dialog is made (for example, the values of input and textArea are saved). The saved values are available programmatically to event handlers written for the dialog and the values are used to restore the state of the values if cancel is clicked. If false, values are not saved (and clicking cancel will not restore values to their state when the dialog was first shown).

showTitleBar

If true (or omitted), a title bar is displayed at the top of the dialog box. If false, a title bar is not displayed.

showTitleCloseButton

If true (or omitted), a close button is displayed in the title bar (if the title bar is displayed). If false, a close button is not displayed.
Note: Clicking the close button is the same as clicking a cancel button.

titleCloseButtonImage

The URL of the image to be used as the close button. (Can also be specified via CSS.)

onshow

JavaScript function to be run whenever the dialog is displayed. The signature of the function is function(thisObj, thisEvent) where thisObj points to the dialog and thisEvent is the event that triggered the show.

onhide

JavaScript function to be run whenever the dialog is removed from display. The signature of the function is function(thisObj, thisEvent) where thisObj points to the dialog and thisEvent is the event that triggered the hide. If the dialog is hidden because an OK or CANCEL button (or the close button which is a cancel button) within the dialog is clicked, then thisEvent.dialogAction will be OK or CANCEL depending on which button was clicked.

initClosed

If set to false, the section is initially rendered "expanded". If set to true or omitted, it's rendered "collapsed".

helpPosition

Defines the position of help and or error text associated with all formItems contained by the panel. over and under position help/error text directly above (below) the value of the formItem (that is aligned with the left edge of the value). left and right position help/error text to the left (right) of the value.
Note: helpPosition is affected by showInPopup. If showInPopup is false, help/error text associated with each item is displayed in it's own table cell (either a row or column is added to the table to accomodate it). If showInPopup is true, the help/error text is displayed in an absolutely positioned div (that is, does not occupy an visible row/cell). Regardless of whether the text is displayed in a cell or in a div, labelPosition defines the position of the cell/div relative to the value of the formItem.

interItemSpacing

If provided, defines the space between each row of in the rendered table. The value may be any HTML width specification (for example, "4px", "1em", "4%"). If no width is specified, pixels (px) is used. If percent is specified, it is a percentage of the line height in force (for example, 150% means 1.5 times the line height).
Note: Spacing may also be set using the panelFormBox_Spacer-Cell class.

labelPosition

Defines the position of labels associated with all formItems contained by the panel. over and under position labels directly above (below) the value of the formItem (that is aligned with the left edge of the value). left and right position labels to the left (right) of the value.
Note: This attribute does not affect the label attribute of the panelFormBox tag. This attribute affects the labels associated with the contained formItem tags.

showInPopup

Defines the whether help and or error text associated with all formItems contained by the panel is displayed inline (as a table cell that causes the table to expand/contract) or as a div that is absolutely positioned relative to the form item content. The relative position (left, right, under, over) of the popup is defined by labelPosition. The popup is displayed in a higher z-order than the underlying value, it is positioned above the content.

widthContent

If provided, specifies the width (either as pixels or as a percentage) of the column displaying values (content).
Note: Column width may also be set using the panelFormBox_Content-Cell class.

widthHelp

If provided, specifies the width (either as pixels or as a percentage) of the column displaying help.
Note: Column width may also be set using the panelFormBox_Help-Cell class.

widthLabel

If provided, specifies the width (either as pixels or as a percentage) of the column displaying labels. Note that the column width may also be set using the panelFormBox_Label-Cell class.

errorText

Text to display when the value of the field in the formItem is not valid. If omitted, a "system provided" error text is used when the field is not valid. A field is validated on the server when the form containing the formItem is submitted. If any field's value is invalid, the page is redisplayed with the errorText displayed for the formItem (subject to the showHelp attribute). If an errorText is provided, the supplied text is displayed. If errorText is not provided, the message (h:message) generated on the server for the field is displayed. Control of where the text is displayed is specified on the panelFormBox. Control of whether the text is displayed is controlled by the showHelp attribute described below. In addition, a field can have client-side validation enabled (client-side validation is always enabled if the field is required). When a field loses focus (onblur fires), client-side validation is run. If the field fails validation, the error is displayed. If an errorText is provided, the supplied text is displayed. If errorText is not provided, an appropriate message from the hxclient string resource file is displayed. By supplying an errorText, a consistent error message is displayed when a field is invalid -- regardless of how (where) the error is flagged. Whether the error is flagged by client-side validation or server-side validation, the same error is displayed (in the same location).

infoText

Additional informational or help text to be displayed with the item. For example, it can provide details on what the user should enter or it could describe the units of measure for the field. Control of where the text is displayed is specified on the panelFormBox. Control of whether the text is displayed is controlled by the showHelp attribute described below. As with errorText and label, HTML may be embedded in the string.

releaseMargin

The contents of the formItems in a panel are aligned in table columns based on the labelPosition and helpPosition attributes of the panel. For example, all labels are put in one column and all contents in an adjacent column. Setting releaseMargin "releases" this item from this rule. When releaseMargin is set, the contents of this formItem are wrapped in a sub-table inserted in the panel's table. The contents of the subtable thus have an independent alignment. releaseMargin is often used when one item has a label (or content) that is significantly wider or narrower than the other items. By "releasing" this item, this item's elements can be aligned differently without forcing all other items in the panel to become "too wide". Note that releaseMargin is only meaningful if labels and/or messages are displayed to the left/right of the field. It has little effect if the labels and/or messages are displayed over/under the field.

showHelp

Determines how (when) the infoText and errorText are displayed for this item. If Always the info text is always displayed unless there is an error in which case the error is displayed in its place. If As-needed the info text is displayed when the field has focus (unless there is an error). The error is always displayed if there is an error. If Info the info text is always displayed. The error text is never displayed. If Error the info text is never displayed. The error text is displayed if there is an error. If None neither text is ever displayed.

behaviorAction

The name of the action(s) to be run. If more than one action name is provided they should be separated with a semicolon.

event

The name of the event to which the behavior is attached. For example "onclick". It must include the "on" prefix.

onActionFunction

A JavaScript function to be executed. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted.

targetAction

The target(s) of the action(s) to be run. By default, the action's target is the tag the behavior is assigned to (as a child or via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

targetFacet

Normally the behavior applies to the parent tag. targetFacet can be used to assign it to the content of the named facet.

autoSubmit

If autoTab is true, then if autoSubmit is true, then when a user types in sufficient characters to auto-advance to the next field, instead of advancing, the form containing the field is submitted. This attribute is primarily intended for use by applications trying to emulate certain "antique" input mechanisms such as emulating 3270 terminals.

autoTab

If false or omitted, focus does not advance to the next field when the maximum number of characters is entered. If true, when the maximum number of characters for the field are entered, focus advances to the next field. For autoadvance to work correctly, either the field should have a pattern that unambiguously identifies the maximum number of characters in the field or maxlength should be set on the field. For example, the pattern ##9 is ambiguous. Three characters can be entered for a positive number while four characters can be entered for a negative number. So maxlength should be set in this case.

errorAction

If validation is set to true, the name of the action(s) to be run if the field's value fails validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.

imeMode

If supplied, when the field gets focus, the CSS imeMode property is set to the value supplied. This property only works with browsers that support the CSS imeMode property (currently only Internet Explorer supports this).

inputAssist

Currently not available. When the feature is enabled, inputAssist will turn on character checking (veryify that a valid character is entered).

onerror

If provided, a JavaScript function to be executed when onblur fires and the field value fails validation. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).

onfocuserror

If provided, a JavaScript function to be executed when onfocus fires and the field value fails conversion. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).

onfocussuccess

If provided, a JavaScript function to be executed when onfocus fires and the field value passes conversion. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.

onfocusErrorAction

If validation is set to true, the name of the action(s) to be run if the field value fails conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.

onfocusSuccessAction

If validation is set to true, the name of the action(s) to be run if the field's value passes conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.

onfocusSuccessClass

If validation is set to true, the name of the CSS class that is to be applied to the field if the field's value passes conversion when onfocus is fired.

onsuccess

If provided, a JavaScript function to be executed when onblur fires and the field value passes validation. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.

promptCharacter

If provided, the field is put in assist mode where each character position in the field is shown with the specified prompt character or the current value of the field. For date/time fields, the date is represented using all numeric characters. Only valid characters may be entered in each position. As the user types the cursor is automatically advanced to an appropriate position.

successAction

If validation is set to true, the name of the action(s) to be run if the field value passes validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.

successClass

If validation is set to true, the name of the CSS class that is to be applied to the field if the field value passes validation when onblur is fired.

targetErrorAction

The target(s) of the action(s) associated with the errorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons)

targetOnFocusErrorAction

The target(s) of the action(s) associated with the onFocusErrorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

targetOnfocusSuccessAction

The target(s) of the action(s) associated with the onFocusSucessAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

targetSuccessAction

The target(s) of the action(s) associated with the successAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

select

If true, the content of the field receiving focus is initially selected. If omitted or false, the content of the field initially receiving focus is not selected.

inProgress

Attribute is not yet available.

matchWidth

If true, the suggestion drop down menu is as wide as the input field. If false, its width is determined by CSS of the drop down.

maxSuggestions

The maximum number of suggestions displayed.

startCharacters

The minimum number of characters that must be in input field before a suggestion is made.

startDelay

Number of milliseconds delay before a suggestion is made, that is, if a user types a second character within startDelay milliseconds, a suggestion is not made for the first character.

oncomplete

If a request succeeds, after the content of the panel is replaced, this JavaScript is executed. The function has no meaningful arguments.

onstart

When the behavior starts executing, this JavaScript function is executed. It has no meaningful arguments. If it returns false execution is halted. This function can be used (in conjunction with oncomplete to customize what is displayed while the request is in progress.

params

The value of these tags will be retrieved and appended as params to the URL used to get the new content. The name of the param will be the simple ID provided. For example, if the ID is "text1", the param will be named "text1" (not "form1:text1").

Allowed as Child Tag

The tag may be used as a child of the following tags:
  • <hx:panelActionbar>
  • <hx:panelBox>
  • <hx:panelDialog>
  • <hx:panelFormBox>
  • <h:panelGrid>
  • <h:panelGroup>
  • <hx:panelLayout>
  • <hx:panelMenu>
  • <hx:panelSection>

Allowed Contents

The tag rebuilds the content of a panel tag (allowed tags listed above). A panel that is being rebuilt may include any JSF tags except the following:
  • <hx:scriptCollector>
  • <f:subview>
  • <f:view>
  • <hx:viewFragment>
  • <hx:inputHelperFormTracker>
  • <hx:inputHelperSetFocus>
  • <r:inputRichText>
  • <odc:tabbedPanel>
  • <odc:bfPanel>
  • <odc:buttonPanel>
  • <odc:tree>
  • <odc:treeNodeAttr>
  • <odc:graphDraw>
  • <odc:graphDrawData>
  • <odc:graphDrawDataSeries>
  • <odc:graphDrawLabels>

href

The URL of the JSP that responds to the request. When a JWL get action is issued against this component, the new content for the panel associated with the component is retrieved using the specified URL.

source

The IDof a tag in the targeted URL whose content will replace the content of the container with which this component is associated. If not specified or if the ID is not found in the page referenced by the URL, the ID of container is used. If this ID is not found in the page referenced by the URL, the body content is used.

dateStyle

Predefined formatting style which determines how the date component of a date string is to be formatted and parsed. Applied only if type is "date" or "both".

timeStyle

Predefined formatting style which determines how the time component of a date string is to be formatted and parsed. Applied only if type is "time" or "both".

timeZone

Time zone in which to interpret any time information in the date String. Value must be either a VB expression that evaluates to a java.util.TimeZone instance, or a String that is a timezone ID as described in the javadocs for java.util.TimeZone.getTimeZone().

calendar

The calendrical system to be used for the date/time. Gregorian is the default. Calendars available include:

char1RegEx

A regular expression that describes what characters are allowed in positions marked with the # character in the mask pattern. If omitted the expression [0-9] is used (the digits 0 through 9 are allowed).

char2RegEx

A regular expression that describes what characters are allowed in positions marked with the ? character in the mask pattern. If omitted, the expression [a-zA-Z] is used (the ASCII alphabetic characters are allowed).

char3RegEx

A regular expression that describes what characters are allowed in positions marked with the ! character in the mask pattern. If omitted, the ! character is considered a literal in the pattern.

char4RegEx

A regular expression that describes what characters are allowed in positions marked with the ~ character in the mask pattern. If omitted, the ~ character is considered a literal in the pattern.

mask

Describes the pattern of literals and characters for the value.

protectMask

Protects the character in a "marker" position from being changed (or validated), i.e., you can "protect" a position in the string that contains a marker (#,?,!,~) so that a user can't type this character in, instead the value of that position is set programmatically (usually in the initial value). Effectively this turns a character in the value into a literal. This attribute is only useful when the mask is used in an inputText field and that field has input assist enabled on it. If the protectMask is provided, it should be the same length string as the mask. A position is marked as protected if it has an X (an upper-case X) in it. Positions without an X are not protected.

currencyCode

ISO 4217 currency code, applied only when formatting currencies.

currencySymbol

Currency symbol, applied only when formatting currencies.

groupingUsed

Flag specifying whether formatted output will contain grouping separators. Default value is true.

integerOnly

Flag specifying whether only the integer part of the value will be formatted and parsed.

maxFractionDigits

Maximum number of digits that will be formatted in the fractional portion of the output.

maxIntegerDigits

Maximum number of digits that will be formatted in the integer portion of the output.

minFractionDigits

Minimum number of digits that will be formatted in the fractional portion of the output.

minIntegerDigits

Minimum number of digits that will be formatted in the integer portion of the output.

itemDescription

Description of this option, for use in development tools.

itemLabel

Label to be displayed to the user for this option.

itemValue

Value to be returned to the server if this option is selected by the user.

maximum

The maximum date as specified by yyyy/mm/dd hh:mm:ss.

minimum

The minimum date as specified by yyyy/mm/dd hh:mm:ss.

expression

An Expression Language (EL) expression that returns a boolean where true means the value is valid and false means it is not valid.

modulus

Specify which of the two IBM® modulus algorithms to use -- Modulus 10 or Modulus 11. By default, Modulus 10 is used.

Invalid values for selectOne components
Note:
The JSF lifecycle does not validate values when a page is initially rendered, as per the JSF standard. For example:
<h:inputText id="text2" styleClass="inputText" value="#{pc_Sa_RATLC00298618.myBean.myBigDecimal04}">
	<hx:convertNumber/>
	<f:validateDoubleRange minimum="10.0" maximum="99.0">
	</f:validateDoubleRange>
</h:inputText>
If the value initially resolves to something that is not in the specified range, the JSF tools will not mark an error (in an <h:message> tag). It is assumed that an invalid value is deliberately being used so that a user can correct it or to display an input message.

When the tag with an invalid value is a selectOne component, such as a combo box, a list box or a radio button group, an initial value is not set on the HTML tag (no option is selected) when the page is rendered. This is because an option that matches the invalid value cannot be located.

The browser will display nothing selected in the list box or radio button group since it is assumed that you are trying to force a user to choose a value. When the page is submitted, a value is not submitted (no selection) if non-valid choice has been made. If the field is marked as "required", an error will be generated.

In the case of a combo box, the same thing is done, but the browser behavior differs. If a combo box has an invalid selection, the browser makes the first value the selection. As a result, when the page is submitted, a valid value is always submitted.


Feedback