Foundation

Tag reference sheet

Tag library reference for the following tag libraries:

Tomahawk sandbox tag library. - version 1.1.7

Sandbox is a place to put new JSF 2.0 ideas.

Namespace definition: xmlns:s="http://myfaces.apache.org/sandbox"

Tags

Required attributes are marked with a*

<s:accordionPanel>

A group of panels, which can be opened and closed. See attribute layout for further description on how opening and closing works. Extends standard panelGroup by user role support.

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderColorDefines the color of the border.String
collapsedBackColorDefines the background color for collapsed state.String
collapsedFontWeightDefines the font weight for collapsed state.String
collapsedTextColorDefines the text color for collapsed state.String
colspanstandard html colspan attribute for table cellString
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.String
expandedBackColorDefines the background color for expanded state.String
expandedFontWeightDefines the font weight for expanded state.String
expandedTextColorDefines the text color for expanded state.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)String
hoverBackColorDefines the background color on hover.String
hoverTextColorDefines the text color on hover.String
idGet a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.String
langHTML: The base language of this document.String
layoutDefines the layout of this accordionPanel. If you set this to 'accordion', opening a panel will close all other panels. If you set this to 'toggling', opening a panel doesn't affect the state of the other panels. You can close a panel by clicking on the header of this panel a second time.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
visibleOnUserRoleIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.String

<s:effectAppear>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
fromfloat value, defaults to 0.0, percent of opacity to startString
tofloat value, defaults to 1.0, percent of opacity to endString

<s:effectBlindDown>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
scaleContentboolean, defaults to trueString
scaleFrominteger value, percentage (0%-100%), defaults to 100String
scaleFromCenterboolean, defaults to falseString
scaleModestring, defaults to 'box', can also be 'contents'String
scaleTointeger value, percentage (0%-100%), defaults to 0String
scaleXboolean, defaults to falseString
scaleYboolean, defaults to trueString

<s:effectBlindUp>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
scaleContentboolean, defaults to trueString
scaleFrominteger value, percentage (0%-100%), defaults to 100String
scaleFromCenterboolean, defaults to falseString
scaleModestring, defaults to 'box', can also be 'contents'String
scaleTointeger value, percentage (0%-100%), defaults to 0String
scaleXboolean, defaults to falseString
scaleYboolean, defaults to trueString

<s:effectDropOut>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectFade>

Convenient wrapper for scriptaculous Effect.Fade

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
fromfloat value, defaults to 0.0, percent of opacity to startString
tofloat value, defaults to 1.0, percent of opacity to endString

<s:effectFold>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectGrow>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
directionstring, defaults to 'center', can also be: 'top-left', 'top-right', 'bottom-left', 'bottom-right', specifying the origin from which to "grow" the elementString
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectHide>

Convenient wrapper for scriptaculous Effect.Fade

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectHighlight>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
endcolorSets the color of the last frame of the highlight. This is best set to the background color of the highlighted element. Defaults to "#ffffff" (white).String
eventThe event that this client behavior should be attached.String
for*String
forId*String
keepBackgroundImageUnless this is set to true, any background image on the element will not be preserved.String
restorecolorSets the background-color of the element after the highlight has finished. Defaults to the current background-color of the highlighted element (see Note).String
startcolorSets the color of first frame of the highlight. Defaults to "#ffff99" (a light yellow).String

<s:effectMorph>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String
stylethe target style of your element, as a string written with the standard CSS syntax, a hash, or a CSS class name.String

<s:effectMove>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String
modestring, defaults to 'relative', can also be 'absolute', specifies if the element is moved absolutely or relative to its own position.String
xinteger value, either the new absolute target of the effect elements left value or the modifier of its current left value, depending on the mode optionString
yinteger value, either the new absolute target of the effect elements top value or the modifier of its current top value, depending on the mode optionString

<s:effectOpacity>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
fromfloat value, defaults to 0.0, percent of opacity to startString
tofloat value, defaults to 1.0, percent of opacity to endString

<s:effectPuff>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
fromfloat value, defaults to 0.0, percent of opacity to startString
tofloat value, defaults to 1.0, percent of opacity to endString

<s:effectPulsate>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 2.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
fromfloat value, defaults to 0.0, the minimal opacity during the pulsate, in a value between 0.0 and 1.0. For example, use 0.7 for a mild pulsateString
pulsesinteger value, defaults to 5, the amount of pulses within the duration timeString

<s:effectScale>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String
percentPercent value used to indicate the final scale.String
scaleContentSets whether content scaling should be enabled, defaults to true.String
scaleFrominteger value, percentage (0%-100%), defaults to 100String
scaleFromCenterIf true, scale the element in a way that the center of the element stays on the same position on the screen, defaults to false.String
scaleModeEither 'box' (default, scales the visible area of the element) or 'contents' (scales the complete element, that is parts normally only visible by scrolling are taken into account). You can also precisely control the size the element will become by assigning the originalHeight and originalWidth variables to scaleMode. Example: scaleMode: { originalHeight: 900, originalWidth: 900 }String
scaleXSets whether the element should be scaled horizontally, defaults to true.String
scaleYSets whether the element should be scaled vertically, defaults to true.String

<s:effectScrollTo>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
offsetinteger value, vertical offset of the target element, in pixels, defaults to 0String

<s:effectShake>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
distanceinteger value, defaults to 20, the number of pixels to move horizontallyString
durationfloat value, in seconds, defaults to 0.5String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectShow>

Convenient wrapper for scriptaculous Effect.Fade

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectShrink>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
directionstring, defaults to 'center', can also be: 'top-left', 'top-right', 'bottom-left', 'bottom-right', the direction to "shrink" the element toString
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectSlideDown>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
scaleContentboolean, defaults to trueString
scaleFrominteger value, percentage (0%-100%), defaults to 100String
scaleFromCenterboolean, defaults to falseString
scaleModestring, defaults to 'box', can also be 'contents'String
scaleTointeger value, percentage (0%-100%), defaults to 0String
scaleXboolean, defaults to falseString
scaleYboolean, defaults to trueString

<s:effectSlideUp>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
scaleContentboolean, defaults to trueString
scaleFrominteger value, percentage (0%-100%), defaults to 100String
scaleFromCenterboolean, defaults to falseString
scaleModestring, defaults to 'box', can also be 'contents'String
scaleTointeger value, percentage (0%-100%), defaults to 0String
scaleXboolean, defaults to falseString
scaleYboolean, defaults to trueString

<s:effectSquish>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectSwitchOff>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
eventThe event that this client behavior should be attached.String
for*String
forId*String

<s:effectToggle>

Convenient wrapper for scriptaculous Effect.Appear

Can contain:empty

Attributes

NameDescriptionType
appendJs*String
delay*String
durationfloat value, in seconds, defaults to 1.0String
eventThe event that this client behavior should be attached.String
for*String
forId*String
modestring value, indicate toggling mode : 'appear', 'slide', 'blind'. Default to 'blind'String

<s:passwordStrength>

The passwordStrength component is needed by the web sites which ask the user to enter a powerful password for the purpose of the registration stuff. <p> The component enables its user to know the strength of the password while (he/she) types it before even submit the form to the server [please see the screenshots]. </p> <p> The component enables its user to define his custom security policy for his password in an easy manner. </p> <p> The component also have 2 types of presenting the password strength. Till now the strength can be represented as text or progressbar. </p>

Can contain:JSP

Attributes

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
autocompleteIf the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterAn expression that specifies the Converter for this component. <p> The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. </p>String
converterMessageText to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p>String
customSecurityExpressionThis string determines the expression of the custom security rule of the password <p> Note that the expression has the following format : </p> <p> ******************************************************* </p> <p> S (Number) N (Number) A (Number) </p> <ul> <li>Where S stands for Symbols</li> <li>Where N stands for Numbers</li> <li>Where A stands for Alphabets</li> </ul> <p> ******************************************************* </p> <p> For example) A4N2S3A2 Means that the password will be as following : </p> <ul> <li>4 or more Alphabets followed by</li> <li>2 or more Numbers followed by</li> <li>3 or more Symbols followed by</li> <li>2 or more Alphabets</li> </ul> <p> ******************************************************* </p> <p> Note also that the useCustomSecurity should be set to true. </p>String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
idGet a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.String
immediateA boolean value that identifies the phase during which action events should fire. <p> During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. </p>String
labelA display name for this component.String
langHTML: The base language of this document.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
penaltyRatioThis attribute determines the penalty ratio that will decrease the password Strength if the custom security expression is not met. Note also that the useCustomSecurity should be set to true to apply this flag. Possible values from 0 to 100. Default value is 50.String
preferredPasswordLengthThe prefered length of the passwordString
prefixTextThe prefix of the component messageString
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p>String
requiredMessageText to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank).String
showDetailsThis flag {true | false} determines whether to show the details (left characters). default is trueString
sizeHTML: The initial width of this control, in characters.String
strengthIndicatorTypeThis flag determines the indicator type. It can be {text or bar}. Default is textString
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
textStrengthDescriptionsThe text strength descriptionsString
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
useCustomSecurityThis flag determines whether to user custom security rules instead of just depending on the password length. The default is false.String
validatorA method-binding EL expression which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code>String
validatorMessageText which will be shown if validation fails.String
valueGets The initial value of this component.String
valueChangeListenerA method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p>String

<s:validateBean>

Behavior for Bean Validation validations in JavaScript. <p/> This class can be attached to UIComponent instances and validate the entire form. Any UIMessages instances in the form are looked up and used for positioning error messages.

Can contain:empty

Attributes

NameDescriptionType
for*String