META-INF.tr.taglib.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-impl Show documentation
Show all versions of trinidad-impl Show documentation
Private implementation of the Apache MyFaces Trinidad project
The newest version!
http://myfaces.apache.org/trinidad
The setActionListener tag provides a declarative syntax for assigning values before an action fires
setActionListener
org.apache.myfaces.trinidadinternal.facelets.SetActionListenerTag
the target for the value; must be an EL expression
to
true
the source of the value; can be an EL expression or a constant value
from
true
resetActionListener
The resetActionListener tag provides a declarative syntax for resetting values before an action fires
org.apache.myfaces.trinidadinternal.facelets.ResetActionListenerTag
The returnActionListener tag is a declarative way to allow an action source to return
a value from a dialog or process.
returnActionListener
org.apache.myfaces.trinidadinternal.facelets.ReturnActionListenerTag
The value to return as the dialog/process result.
This can be an EL expression or a constant value.
value
The fileDownloadActionListener tag provides a declarative syntax for downloading files to a user from a command component.
fileDownloadActionListener
org.apache.myfaces.trinidadinternal.facelets.FileDownloadActionListenerTag
the content or mime type of the file - e.g., text/html or application/pdf
contentType
java.lang.String
the desired or proposed filename. If set, the user will typically be presented with a "Save File" dialog, though this is ultimately at the descretion of the user agent.
filename
java.lang.String
an EL binding to the method that will deliver the file contents. The method must take two parameters, a FacesContext and an OutputStream.
method
true
void myMethod(javax.faces.context.FacesContext, java.io.OutputStream)
A breadCrumbs component is used in hierarchical
site layouts to indicate the path back to the root page of the
hierarchy with links.
breadCrumbs
org.apache.myfaces.trinidad.CoreBreadCrumbs
org.apache.myfaces.trinidad.BreadCrumbs
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether to put links on the same line or indented and
on new lines.
orientation
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of navigation data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The Trinidad Chart is used to diplay data in a chart format.
chart
org.apache.myfaces.trinidad.CoreChart
org.apache.myfaces.trinidad.Chart
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Specifies URI for the template document from which the chart elements are cloned.
If this attribute is null, the chart component uses a default template. The default template is chosen based
on whether the useGradient attribute is true or false.
The template document is useful for changing the Look and Feel of the chart.
Some examples include:1)A developer may want to skin the chart to match its corporate Look and Feel.
2)A developer may want to put water marks/background images inside the chart.
3)A developer may want to change the template for the gauges used in the gauge charts.
4)A developer may want to turn off gradients and instead use filters to set some interesting effects on the chart elements.
templateSource
java.lang.String
Specifies if tooltips are displayed or not.
tooltipsVisible
boolean
The maximum precision of the numbers displayed on the yAxis(xAxis for horizontal charts).
The default is 0.
maxPrecision
int
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
the CSS styles to use for this component.
inlineStyle
java.lang.String
This attribute controls the number of horizontal major grid lines displayed in the chart.
For horizontal charts(horizontalBar, stackedHorizontalBar) this attribute controls the horizontal major grid lines.
The default is 3.
YMajorGridLineCount
int
a CSS style class to use for this component.
styleClass
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
The type of chart. Possible Values are: verticalBar horizontalBar stackedVerticalBar stackedHorizontalBar pie area stackedArea line barLine XYLine scatterPlot radar radarArea funnel circularGauge semiCircularGauge.
type
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Specifies if gradients are used to display chart elements.
By default the chart elements use gradients.
gradientsUsed
boolean
This attribute controls the number of minor grid lines displayed within a major grid section.
The default value is -1, which means it varies per chart type. Currently it is used only for gauge charts
with a default of 3.
YMinorGridLineCount
int
Specified the location of the legend. The legend can be turned off by setting this attribute to none.
Otherwise it can be drawn at top, start, end or bottom.
legendPosition
java.lang.String
the data model being used by this component.The specific model class must be derived from
<code>org.apache.myfaces.trinidad.model.ChartModel</code>.
The derived class must override the abstract methods to provide the required values for chart display.
value
java.lang.Object
This attribute controls the number of vertical major grid lines displayed in the chart.
The default value is -1, which implies that the vertical major grid lines are controlled by the groupLabels
in the chart model. This parameter along with the groupLabels provide flexibility in labeling the
groups. For e.g. one can display a vertical bar chart with 2 years data. Only quarters may be labeled and XMajorGridLineCount can
be 1 for splitting the data into two sections.
XMajorGridLineCount
int
The duration of the animation for the chart components in milliseconds.
Animation can be turned off if the animationDuration is set to 0. The default value is 1000ms.
animationDuration
int
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
a method reference to a drill down listener that
will be called when the user drills down into the chart data.The method must take a parameter of type <code>org.apache.myfaces.trinidad.event.ChartDrillDownEvent</code>.
chartDrillDownListener
void myMethod(org.apache.myfaces.trinidad.event.ChartDrillDownEvent)
Specifies if the chart is drawn with a perspective (2.5D).
By default the chart is draw with a perspective.
perspective
boolean
The chooseColor control creates a palette for picking colors.
chooseColor
org.apache.myfaces.trinidad.CoreChooseColor
org.apache.myfaces.trinidad.Color
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the list of colors for the component
colorData
java.util.List
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
the width of the standard palette in cells
width
int
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
the list of custom colors for the component
customColorData
java.util.List
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The chooseDate component is used in conjunction with a
selectInputDate to allow the user to quickly select a date value without
having to navigate to a secondary window.
chooseDate
org.apache.myfaces.trinidad.CoreChooseDate
org.apache.myfaces.trinidad.Date
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
The minimum value allowed for the Date value.
When set to a fixed value on a tag, this will be parsed as an ISO 8601 date.
ISO 8601 dates are of the form "yyyy-MM-dd"
(for example: 2002-02-15). All other uses require java.util.Date objects.
When binding to Date objects, it is advised to create the Date object with zeroed-out
values for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds)
to allow the largest range of values to be accepted.
minValue
java.util.Date
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The maximum value allowed for the Date value.
When set to a fixed value on a tag, this will be parsed as an ISO 8601 date.
ISO 8601 dates are of the form "yyyy-MM-dd"
(for example: 2002-02-15). All other uses require java.util.Date objects.
When binding to Date objects, it is advised to create the Date object with
maximum value for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds)
to allow the largest range of values to be accepted.
maxValue
java.util.Date
Component that is used as a child of the Table component. The Column
component defines the header, footer and data for a single column in the
Table.
column
org.apache.myfaces.trinidad.CoreColumn
org.apache.myfaces.trinidad.Column
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
The default sort order of the column. The legal values are "ascending" or "descending" for ascending sorting or descending sorting on a first click respectively. The default value is "ascending".
defaultSortOrder
java.lang.String
<html>whether or not the column is sortable. A sortable column has a clickable header that (when clicked) sorts the table by that column's property. Note that in order for a column to be sortable, this attribute must be set to "true" and the underlying model must support sorting by this column's property. <p> This column's "sortProperty" attribute must be set if sorting is desired.</p></html>
sortable
boolean
whether or not the column contents should be allowed to wrap
noWrap
boolean
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Whether or not this column is a row header column.
rowHeader
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
The property that is displayed by this Column. This is the
property that the framework might use to (for example) sort
the Table's data.
sortProperty
java.lang.String
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
The alignment for this column. The legal values are "start", "end" and "center", for left-justified, right-justified, and center-justified respectively in LTR display. The default value is "start".
align
java.lang.String
the preferred width of this column, e.g., "30%", "100px".
width
java.lang.String
whether or not the children of this column should be rendered on separate rows. Setting this attribute to true will cause each child to render in its own row. Setting this to false will cause all the children to be rendered in one cell, which will rowSpan across the rows of the Columns whose children are rendered on separate rows.
This attribute is not supported on the following agent types:
phone, voice.
separateRows
boolean
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether or not the column header
should be allowed to wrap
headerNoWrap
boolean
text to display in the header of the column. This is a convenience that generates output equivalent to adding a "header" facet containing an outputText.
headerText
java.lang.String
The commandButton control creates a button representation of a UIXCommand.
commandButton
org.apache.myfaces.trinidad.CoreCommandButton
org.apache.myfaces.trinidad.Button
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to this button.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple input fields in the
same page of output, the rendering user agent will cycle among
the elements accessed by the similar keys. Note that user agents
are inconsistent about dealing with two links having same access
key, and so the cycling behavior is dependent on what the user agent
provides.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>Text</code> attribute of this button instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is
to use textAndAccessKey.
</p></html>
accessKey
char
Height of the window, if this command is used to launch a window.
windowHeight
int
a reference to an action method sent by the command component,
or the static outcome of an action. If the action starts with "dialog:",
useWindow attribute must be set to true.
action
java.lang.String myMethod()
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a return listener.This method
is used to process dialog returnEvents which are generated as a result of either
calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog
directly or declaratively through the use of a returnActionListener tag.
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
An URL to an image to use for an icon displayed in the button.
icon
java.lang.String
the textual label of the button.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
whether the action should be done through a partial page submit
or not.
Default is false: no partial page submit.
partialSubmit
boolean
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Width of the window, if this command is used to launch a window.
windowWidth
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation - client-side or
server-side -
will be skipped when
events are generated by this component.
When immediate is true, the command's action and
ActionListeners, including the default ActionListener
provided by the JavaServer Faces implementation,
will be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase. Because
validation runs during Process Validators (after
Apply Request Values, but before Invoke Application),
setting immediate to true will skip validation.
immediate
boolean
If set to TRUE the component will start blocking user input when the
action is initiated. The blocking will stop when a response is received
from the server.
blocking
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
Indicates whether processes launched by this command should be
launched in a secondary dialog window. 'useWindow' requires that the "action"
attribute start with "dialog:". Set useWindow to 'false' for the outcome of
the action to be targeted to the existing window.
useWindow
boolean
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the button should be disabled.
disabled
boolean
a method reference to a launch listener
launchListener
void myMethod(org.apache.myfaces.trinidad.event.LaunchEvent)
The commandLink control creates a link representation of a UIXCommand.
commandLink
org.apache.myfaces.trinidad.CoreCommandLink
org.apache.myfaces.trinidad.Link
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to this link.
For accessibility reasons, this functionality is not
supported in screen reader mode.
<p>
If the same access key appears in multiple input fields in the
same page of output, the rendering user agent will cycle among
the elements accessed by the similar keys. Note that user agents
are inconsistent about dealing with two links having same access
key, and so the cycling behavior is dependent on what the user agent
provides.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>Text</code> attribute of this Link instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
</p></html>
accessKey
char
Height of the window, if this command is used to launch a window.
windowHeight
int
a reference to an action method sent by the command component,
or the static outcome of an action. If the action starts with "dialog:",
useWindow attribute must be set to true.
action
java.lang.String myMethod()
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a return listener.This method
is used to process dialog returnEvents which are generated as a result of either
calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog
directly or declaratively through the use of a returnActionListener tag.
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the textual label of the link.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
whether the action should be done through a partial page submit
or not.
Default is false: no partial page submit.
partialSubmit
boolean
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Width of the window, if this command is used to launch a window.
windowWidth
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation - client-side or
server-side -
will be skipped when
events are generated by this component.
When immediate is true, the command's action and
ActionListeners, including the default ActionListener
provided by the JavaServer Faces implementation,
will be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase. Because
validation runs during Process Validators (after
Apply Request Values, but before Invoke Application),
setting immediate to true will skip validation.
immediate
boolean
If set to TRUE the component will start blocking user input when the
action is initiated. The blocking will stop when a response is received
from the server.
blocking
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
Indicates whether processes launched by this command should be
launched in a secondary dialog window. 'useWindow' requires that the "action"
attribute start with "dialog:". Set useWindow to 'false' for the outcome of
the action to be targeted to the existing window.
useWindow
boolean
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the link should be considered disabled.
This attribute only has meaning when links are used in certain
container types, such as global headers and tab bars.
disabled
boolean
a method reference to a launch listener
launchListener
void myMethod(org.apache.myfaces.trinidad.event.LaunchEvent)
The commandNavigationItem control creates a navigation item representation of a UIXCommand.
commandNavigationItem
org.apache.myfaces.trinidad.CoreCommandNavigationItem
org.apache.myfaces.trinidad.NavigationItem
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to this item.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle among
the elements accessed by the similar keys. Note that user agents
are inconsistent about dealing with two links having same access
key, and so the cycling behavior is dependent on what the user agent
provides.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>text</code> attribute of this item instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is
to use textAndAccessKey.
</p></html>
accessKey
char
the target frame for the go component.
targetFrame
java.lang.String
Height of the window, if this command is used to launch a window.
windowHeight
int
a reference to an action method sent by the command component,
or the static outcome of an action. If the action starts with "dialog:",
useWindow attribute must be set to true.
action
java.lang.String myMethod()
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
whether the item is in visited state. Depending on
the renderer the item may appear in a visited style, if true. This
property is currently used only within the a train component.
visited
boolean
a method reference to a return listener.This method
is used to process dialog returnEvents which are generated as a result of either
calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog
directly or declaratively through the use of a returnActionListener tag.
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
whether the item is selected.
selected
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
a URI specifying the location of a target image.
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the text of the item.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
whether the action should be done through a partial page submit
or not.
Default is false: no partial page submit.
partialSubmit
boolean
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Width of the window, if this command is used to launch a window.
windowWidth
int
The URI this component references when activated. This is an alternative to using an action.
destination
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation - client-side or
server-side -
will be skipped when
events are generated by this component.
When immediate is true, the command's action and
ActionListeners, including the default ActionListener
provided by the JavaServer Faces implementation,
will be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase. Because
validation runs during Process Validators (after
Apply Request Values, but before Invoke Application),
setting immediate to true will skip validation.
immediate
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
Indicates whether processes launched by this command should be
launched in a secondary dialog window. 'useWindow' requires that the "action"
attribute start with "dialog:". Set useWindow to 'false' for the outcome of
the action to be targeted to the existing window.
useWindow
boolean
an onmousedown Javascript handler.
onmousedown
java.lang.String
If value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.
disabled
boolean
a method reference to a launch listener
launchListener
void myMethod(org.apache.myfaces.trinidad.event.LaunchEvent)
<html>
The document tag creates each of the standard root elements of an HTML page: <html>, <body>, and <head>.</html>
document
org.apache.myfaces.trinidad.CoreDocument
org.apache.myfaces.trinidad.Document
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
the id of the component to which you want the
focus to be when the full page renders. The accessibility-mode
must be set to "inaccessible" for this feature to be on.
This attribute is not supported on the following agent types:
phone, voice.
initialFocusId
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onunload Javascript handler.
onunload
java.lang.String
Specify the state saving behavior for this page. client=force to be (full) client;
server=force to be server-side; default=follows the settings of the web.xml
stateSaving
java.lang.String
Set if the page should render in default standards mode, quirks mode, or strict mode. Behavior of the modes are:<ul>
<li>"default": renders as transitional doctypes for both XHTML and HTML,
with <a href="http://developer.mozilla.org/en/docs/Gecko's_%22Almost_Standards%22_Mode">"almost standards"</a> rendering mode</li>
<li>"strict": renders as a strict doctype for both XHTML and HTML, also
in standards rendering mode</li>
<li>"quirks": renders HTML pages in quirks mode, and XHTML with
a transitional doctype, but standards mode (there is no quirks mode for
XHTML).</li></ul>
mode
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
The title of the document. (This title doesn't have to match the
title on any contained panelPage.)
title
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
an onload Javascript handler.
onload
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
<html>
The form tag creates an HTML <form> element.</html>
form
org.apache.myfaces.trinidad.CoreForm
org.apache.myfaces.trinidad.Form
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the target frame for the form
targetFrame
java.lang.String
The id attribute of the command button whose action would be invoked by default for form submit on hitting enter on any of the input fields of the form.
defaultCommand
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Javascript code to be called when the form is submitted.
onsubmit
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the form supports file upload.
This attribute is not supported on the following agent types:
pda, phone, voice.
usesUpload
boolean
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
The goButton creates a push button that navigates directly
to another location instead of delivering an action.
goButton
org.apache.myfaces.trinidad.CoreGoButton
org.apache.myfaces.trinidad.Button
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to this component.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple input fields in the
same page of output, the rendering user agent will cycle among
the elements accessed by the similar keys. Note that user agents
are inconsistent about dealing with two links having same access
key, and so the cycling behavior is dependent on what the user agent
provides.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>Text</code> attribute of this go component instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
</p></html>
accessKey
char
the target frame for the go component.
targetFrame
java.lang.String
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
An URL to an image to use for an icon displayed in the button.
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the textual label of the go component. Go components will
also render children elements (including text nodes), though not
all subclasses of the go component will necessarily support
children.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the URI this go component references
destination
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the go component should be considered disabled.
This attribute only has meaning when go components are used in certain
container types, such as global headers and tab bars.
disabled
boolean
The goLink tag is an HTML link.
goLink
org.apache.myfaces.trinidad.CoreGoLink
org.apache.myfaces.trinidad.Link
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to this component.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple input fields in the
same page of output, the rendering user agent will cycle among
the elements accessed by the similar keys. Note that user agents
are inconsistent about dealing with two links having same access
key, and so the cycling behavior is dependent on what the user agent
provides.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>Text</code> attribute of this go component instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
</p></html>
accessKey
char
the target frame for the go component.
targetFrame
java.lang.String
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the textual label of the go component. Go components will
also render children elements (including text nodes), though not
all subclasses of the go component will necessarily support
children.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the URI this go component references
destination
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the go component should be considered disabled.
This attribute only has meaning when go components are used in certain
container types, such as global headers and tab bars.
disabled
boolean
The icon component renders a skin specific icon.
icon
org.apache.myfaces.trinidad.CoreIcon
org.apache.myfaces.trinidad.Icon
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
a name identifying which icon should be rendered.
Valid values depend on the skin-family. Shortcut names
exist for ".AFRequiredIcon", ".AFWarningIcon",
".AFInfoIcon", and ".AFErrorIcon". They are "required",
"warning", "info", and "error" respectively.
See the Apache Trinidad skins documentation for a list of icon names.
name
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The image control creates an image tag.
image
org.apache.myfaces.trinidad.CoreImage
org.apache.myfaces.trinidad.Image
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
If a server-side image map is desired, specify "server" and place
inside a CoreGoLink component. The acceptable values
are "server" or "none"; defaults to "none".
imageMapType
java.lang.String
an URL that specifies a link to a long description of the image.
This description should supplement the short description.
longDescURL
java.lang.String
the URI specifying the location of the image resource.
source
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The importScript tag supports importing the built-in scripts
provided by Apache Trinidad.
importScript
org.apache.myfaces.trinidad.CoreImportScript
org.apache.myfaces.trinidad.ImportScript
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a series of function names
names
java.lang.String[]
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
The inputColor control creates a text field for entering colors and
a button for picking colors from a palette.
inputColor
org.apache.myfaces.trinidad.CoreInputColor
org.apache.myfaces.trinidad.Color
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the number of columns to display in the text
control. If no value is specified, a default
value will be derived from the current converter, if one
is attached.
columns
int
a reference to an action method sent by the commandButton, or the static outcome of an action
action
java.lang.String myMethod()
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an return listener
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
If true, attempt to use less screen real-estate to display the
inputColor. For example, this
might cause the text area not to be rendered, and the color
swatch conveys the currently selected color.
compact
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
The id of the inline chooseColor component which can be used to
update the Color value for this inputColor. Use the same syntax as partialTriggers
if the components are separated by Naming Containers.
chooseId
java.lang.String
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The inputDate component creates a text field for entering dates and
a button for picking dates from a calendar.
inputDate
org.apache.myfaces.trinidad.CoreInputDate
org.apache.myfaces.trinidad.Date
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the number of columns to display in the text
control. If no value is specified, a default
value will be derived from the current converter, if one
is attached.
columns
int
a reference to an action method sent by the commandButton, or the static outcome of an action
action
java.lang.String myMethod()
the maximum number of characters that
can be entered into the text control. Note that
this value is independent of the "columns" displayed.
maximumLength
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an return listener
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
The id of the chooseDate component which can be used to
pick the Date value for this inputDate. Use the same syntax as partialTriggers
if the components are separated by Naming Containers.
chooseId
java.lang.String
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The inputFile component is a component that can
be used to upload a file. It supports displaying a label,
text, and messages.
inputFile
org.apache.myfaces.trinidad.CoreInputFile
org.apache.myfaces.trinidad.File
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html> For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. <p> This attribute is sometimes referred to as the "mnemonic". </p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
The size of the text control specified by the number of characters shown.The default value depends on the browser.
columns
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the label of the bean.
label
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
event handler for when text becomes selected.
onselect
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>An attribute that will simultaneously set both the "label"and "accessKey" attributes from a single value, usingconventional ampersand notation. For example, setting this attribute to "T&ext" willset the label to "Text" and the access key to 'e'.</html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the component is disabled.
disabled
boolean
The inputHidden tag adds a value that
will be submitted with a page, but not displayed
to the user.
inputHidden
org.apache.myfaces.trinidad.CoreInputHidden
org.apache.myfaces.trinidad.Hidden
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
a converter object
converter
javax.faces.convert.Converter
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
The inputListOfValues is a text field that also supports
launching a dialog to assist users in entering a value.
inputListOfValues
org.apache.myfaces.trinidad.CoreInputListOfValues
org.apache.myfaces.trinidad.Text
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
the number of columns to display in the text
control. If no value is specified, a default
of 30 columns is used. One column is approximately one character
in the browser's current display font.
columns
int
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the label of the bean.
label
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
width of the window, if this command is
used to launch a window.
windowWidth
int
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when text becomes selected.
onselect
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
a method reference to an action listener
actionListener
void myMethod(javax.faces.event.ActionEvent)
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
height of the window, if this command is
used to launch a window.
windowHeight
int
a reference to an action method sent by the commandButton, or the static outcome of an action
action
java.lang.String myMethod()
the maximum number of characters that
can be entered into the text control. Note that
this value is independent of the "cols" displayed.
maximumLength
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an return listener
returnListener
void myMethod(org.apache.myfaces.trinidad.event.ReturnEvent)
the search description for the button that launches the dialog.
This text is commonly used by user agents to display tooltip
help text.
searchDesc
java.lang.String
a converter object
converter
javax.faces.convert.Converter
an onmouseup Javascript handler.
onmouseup
java.lang.String
the URI for an alternative image on the button to launch the dialog
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an onclick Javascript handler.
onclick
java.lang.String
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
whether the element is disabled.
disabled
boolean
The inputNumberSpinbox tag creates a browser input widget;
it is used to enter numbers and it has a spinbox to quickly increment or decrement the number.
inputNumberSpinbox
org.apache.myfaces.trinidad.CoreInputNumberSpinbox
org.apache.myfaces.trinidad.NumberSpinbox
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
The minimum number allowed in the input field.
minimum
int
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the number of columns to display in the text
control. If no value is specified, a default
of 1 columns is used. One column is approximately one character
in the browser's current display font.
columns
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a converter object
converter
javax.faces.convert.Converter
The step size by which the spinbox will increase or decrease the number in the input.
stepSize
int
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the inline CSS style for this element
inlineStyle
java.lang.String
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
<html>a CSS style class to use for this component.
The styleClass attribute value is rendered on the root dom element.
We provide some public style classes you can use that will affect only the 'content' piece of the component:
AFFieldTextMarker, AFFieldTextLTRMarker, AFFieldNumberMarker.
</html>
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
the short description of the bean. This text
is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
event handler for when text becomes selected.
onselect
java.lang.String
The maximum number allowed in the input field.
maximum
int
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The inputText tag creates a browser input text widget;
it may be single-line, multi-line, or a "secret" password field.
It supports displaying a label, text, and messages.
inputText
org.apache.myfaces.trinidad.CoreInputText
org.apache.myfaces.trinidad.Text
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the number of columns to display in the text
control. If no value is specified, a default
of 30 columns is used. One column is approximately one character
in the browser's current display font.
columns
int
the maximum number of characters that
can be entered into the text control. Note that
this value is independent of the "cols" displayed.
If set to 0 or less, the maximumLength is ignored.
maximumLength
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the type of text wrapping to be used in a multi-row
text control. This attribute is ignored for single
row inputText. By default (or "soft"), multirow text
wraps visually, but does not include carriage returns in the
submitted value. Setting this to "off" will disable wrapping;
the multirow text will scroll horizontally. Setting it to "hard"
specifies that the value of the text should include any
carriage returns needed to wrap the lines.
wrap
java.lang.String
the IDs of the components that should trigger a partial update.
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
whether previous values of text fields in the form
should be remembered and offered for auto completion.
autoComplete
java.lang.String
the inline CSS style for this element
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
<html>a CSS style class to use for this component.
The styleClass attribute value is rendered on the root dom element.
We provide some public style classes you can use that will affect only the 'content' piece of the component:
AFFieldTextMarker, AFFieldTextLTRMarker, AFPhoneFieldTextMarker, AFPostalCodeFieldTextMarker,
AFAddressFieldTextMarker, AFFieldNumberMarker.
You can still modify the public style definitions for these marker style classes
and it will be picked up by using these "Marker" style class
because in our base skin implementation we map to the public style by doing this:
af|inputText.AFFieldNumberMarker af|inputText::content {-tr-rule-ref:selector(".AFFieldNumber")}.
We recommend that you do not add style properties to the "Marker" style classes.
They are used solely in the css descendant selector to point to the content pseudo-element.</html>
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
the short description of the bean. This text
is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
the number of rows to display in the text control.
The default is one. Setting to more than one row
precludes the use of some attributes, such as
"secret".
rows
int
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
event handler for when text becomes selected.
onselect
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
a boolean value that only applies to single line text
controls. When set to "true", it hides the actual
value of the text from the user, and will
prevent the actual "value" from being shown to the user.
secret
boolean
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The legend adds a legend describing the meaning of an icon.
legend
org.apache.myfaces.trinidad.CoreLegend
org.apache.myfaces.trinidad.Legend
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
A string identifying which icon should
be described. Only one value is currently supported: "required".
name
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The media component displays media content, such as audio, video,
or image in a player embedded in the user agent.
media
org.apache.myfaces.trinidad.CoreMedia
org.apache.myfaces.trinidad.Media
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html> which media player to use to play the media resource. If possible,
the media control will accomodate this request. However, if
the requested player is not available on the user agent, or does
not support playing the media resource, an alternate player
will be used instead. In all cases, the "link" player is used
as a fallback if no other player is available, or the requested
player fails for some reason.
<ul>
<li>
<code>"none"</code>
<p>
use a link in the user agent page to launch the playing of the
media resource.
</p>
<p>
This player setting uses the least amount of space on the page
and uses the user agent's built in content type mapping
to determine how to display the media resource.
</p>
</li>
<li>
<code>"quicktime"</code>
<p>
use the Apple QuickTime player.
</p>
</li>
<li>
<code>"windows"</code>
<p>
use the Windows Media Player.
</p>
</li>
<li>
<code>"real"</code>
<p>
use the Real Player.
</p>
</li>
</ul></html>
player
java.lang.String
the MIME type of the media content returned by the "source" URI.
This attribute is used as a hint when determining which player to
pick, how the controls of the player are to be configured, and
the default size of the media player. If it isn't specified, an
attempt will be made to derive this information from the extension
of the source URI.
contentType
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
<html> the set of controls made available to the user for controlling
the media playback. The actual set of controls displayed for the
same value may differ between players. Likewise, the amount of
space occupied by the controls will differ from media player to
media player. This can cause problems if the size of the
media control has been specified by the "width" and "height"
attributes rather than "innerWidth" and "innerHeight".
<ul>
<li>
<code>"none"</code>
<p>
don't show any controls for the media player and don't allow
control access through alternate means, such as context menus.
</p>
<p>
This value is typically only used in kiosk-type applications
where no user control over the playing of the media is allowed.
It is typically used in conjunction with setting the
"autostart" attribute to "true", and the "playCount" attribute
to "0" to cause the media play immediately and then loop.
</p>
</li>
<li>
<code>"noneVisible"</code>
<p>
don't show any controls for the media player but allow control
access through alternate means, such as context menus.
</p>
<p>
This value is typically only used in applications where user
control over the playing of the media is allowed, but
not encouraged. It is typically used in conjunction with
setting the "autostart" attribute to "true", and the
"playCount" attribute to "0" to cause the media to play
immediately and then loop.
</p>
</li>
<li>
<code>"minimal"</code>
<p>
show a minimal set of controls for playing media on the media
player.
</p>
<p>
This value gives users control over the most
important media playing controls, while occupying the least
amount of additional space on the user agent.
</p>
</li>
<li>
<code>"typical"</code>
<p>
show the typical set of controls for playing media on the
media player.
</p>
<p>
This value, the default, gives users control over the most
common media playing controls, without occupying an inordinate
amount of extra space on the user agent.
</p>
</li>
<li>
<code>"all"</code>
<p>
Show all available controls for playing media on the media player
</p>
<p>
Using this setting can cause large amount of additional space
to be required, depending on the media player used.
</p>
</li>
</ul>
<p>
The default of this attribute is <code>"typical"</code>.
</p></html>
controls
java.lang.String
<html> height in pixels to reserve for the media player plus its content.
As the extra height needed for the media player controls can vary
from media player to media player and depend on the controls
displayed in the media player, it is recommended that the
"innerHeight" attribute be used in preference to this attribute.
<p>
If both the "height" and "innerHeight" attributes are specified,
the "height" attribute will be used.
</p>
<p>
If no height is specified, the height of the media control is
determined by calculating the "innerHeight" and adding any extra
height necessary to display the media player controls.
</p></html>
height
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
<html> width in pixels to reserve for the media player plus its content.
As the extra width needed for the media player controls can vary
from media player to media player and depend on the controls
displayed in the media player, it is recommended that the
"innerWidth" attribute be used in preference to this attribute.
<p>
If both the "width" and "innerWidth" attributes are specified,
the "width" attribute will be used.
</p>
<p>
If no width is specified, the width of the media control is
determined by calculating the "innerWidth" and adding any extra
width necessary to display the media player controls.
</p></html>
width
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
<html> height in pixels to reserve for the media player content. This
will typically be set to the pixel height of the media resource
to display.
<p>
If no "innerHeight" is specified, the "innerHeight" will be defaulted
based on the content type of the media resource to play.
</p>
<p>
If both the "height" and "innerHeight" attributes are specified,
the "height" attribute will be used.
</p></html>
innerHeight
int
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
a boolean value that controls whether the media resource loads
and plays automatically without user initiation. When set to "true",
the media resource will load and play as soon as possible.
autostart
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
Message to display in the media player while the media resource
is loading.
standbyText
java.lang.String
the number of times the media resource will play. If set to "0",
the resource will loop until the user stops the playing.
playCount
int
the URI specifying the location of the media resource. If no
contentType is specified, the contentType will be inferred from
the extension of the source attribute.
source
java.lang.String
<html> width in pixels to reserve for the media player content. This
will typically be set to the pixel width of the media resource
to display.
<p>
If no "innerWidth" is specified, the "innerWidth" will be defaulted
based on the content type of the media resource to play.
</p>
<p>
If both the "width" and "innerWidth" attributes are specified,
the "width" attribute will be used.
</p></html>
innerWidth
int
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Component that displays a message on behalf of a component.
Trinidad input components typically support automatically showing
their own messages, so this tag should be used only when
setting the "simple" attribute to true.
message
org.apache.myfaces.trinidad.CoreMessage
org.apache.myfaces.trinidad.Message
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the relative ID from this component to the component whose messages will be displayed
for
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the type of the message; acceptable values
are "error", "warning", "info", and "none". Defaults to "none".
messageType
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the error, warning, or informational text.
message
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The messages bean is used at the top of an application page to give
the user important messaging information.
messages
org.apache.myfaces.trinidad.CoreMessages
org.apache.myfaces.trinidad.Messages
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the overridden title text.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
whether to render all messages or just global messages. Normally
global messages are rendered followed by messages for individual
components. If this attribute is set to true, only the global
messages will be rendered.
globalOnly
boolean
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the main text message for the box.
message
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The navigationPane component creates a series of navigation items representing one level in a navigation hierarchy.
navigationPane
org.apache.myfaces.trinidad.CoreNavigationPane
org.apache.myfaces.trinidad.Pane
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Text that describes the items. (This attribute is only applicable if the rendering hint supports it, e.g. "choice".)
title
java.lang.String
the level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
level
int
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of navigation data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
<html>How the navigational items are displayed. Options are:
<ul><li>bar
</li><li>buttons
</li><li>choice
</li><li>list
</li><li>tabs
</li></ul>
</html>
hint
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
Whether the component is disabled.
disabled
boolean
The Trinidad NavigationTree is used to display data that is structured in a hierarchical format.
navigationTree
org.apache.myfaces.trinidad.CoreNavigationTree
org.apache.myfaces.trinidad.NavigationTree
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the starting level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
startLevel
int
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of tree data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
the set of disclosed rows for this component.
Each entry in the set is a rowKey.
disclosedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
whether data validation
should be skipped when row disclosure
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.
immediate
boolean
a method reference to an ExpansionListener
rowDisclosureListener
void myMethod(org.apache.myfaces.trinidad.event.RowDisclosureEvent)
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
The outputDocument component supports styled text with line breaks.
outputDocument
org.apache.myfaces.trinidad.CoreOutputDocument
org.apache.myfaces.trinidad.Document
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a converter object
converter
javax.faces.convert.Converter
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
the style class of the title. This property will be
considered only if a title facet is used.
titleClass
java.lang.String
the style class of the separator. This property will be
considered only if a separator facet is used.
separatorClass
java.lang.String
The outputFormatted bean accepts a string in its "value" attribute
containing a very limited set of HTML markup and outputs formatted
results.
outputFormatted
org.apache.myfaces.trinidad.CoreOutputFormatted
org.apache.myfaces.trinidad.Formatted
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the style usage, intended to make it easier to
put the correct style on the text.
Set this attribute when the outputFormatted
is for instruction text, page stamp text, or inContextBranding
text.
The valid values are "instruction" ,
"pageStamp", and "inContextBranding".
If styleUsage and styleClass attributes are both set,
the styleClass attribute takes precedence.
styleUsage
java.lang.String
a converter object
converter
javax.faces.convert.Converter
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Component that displays a label for a form component.
outputLabel
org.apache.myfaces.trinidad.CoreOutputLabel
org.apache.myfaces.trinidad.Label
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set.
For accessibility reasons, this functionality is not supported in
screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
the ID of the component that this component
refers to
for
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a converter object
converter
javax.faces.convert.Converter
<html> An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
valueAndAccessKey
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
The outputText component supports styled text.
outputText
org.apache.myfaces.trinidad.CoreOutputText
org.apache.myfaces.trinidad.Text
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
<html> an attribute controlling whether output will
be escaped for the current markup language or not. This attribute
defaults to true, and should only be set to false if absolutely necessary.
When set to false, you may exposed to cross-site scripting attacks if
the value of this component is any way derived from values supplied
by a user; see <code>outputFormatted</code> for a safe
alternative. In addition, nearly all attributes are ignored when "escape"
is set to false (e.g., "styleClass" is not output).</html>
escape
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the length at which the text should automatically begin
truncating. When set to zero (the default), the string
will never truncate. Values from one to thirteen will
be treated as thirteen - the outputText component will not
truncate strings shorter than thirteen characters.
truncateAt
int
a converter object
converter
javax.faces.convert.Converter
an additional description to be attached
to the text, for use in improving accessibility. The description will
be available to screen readers and other accessibility agents, but will
not be otherwise visible.
This attribute is not supported on the following agent types:
pda, phone, voice.
description
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The Page component is similar to the PanelPage component, except that instead of having navigation1, navigation2, navigation3, and navigationGlobal facets for adding navigation item information, the user binds a model object and a stamp to render these areas.
page
org.apache.myfaces.trinidad.CorePage
org.apache.myfaces.trinidad.Page
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
what the chromeType is for the page: compact or expanded. If
compact, the productBranding will be shown alongside the
corporate branding instead of below the corporate branding.
chromeType
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of menu data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
the set of disclosed rows for this component.
Each entry in the set is a rowKey.
disclosedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
whether data validation
should be skipped when row disclosure
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.
immediate
boolean
a method reference to an ExpansionListener
rowDisclosureListener
void myMethod(org.apache.myfaces.trinidad.event.RowDisclosureEvent)
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelAccordion control creates, contains and shows a series of items defined by showDetailItem nodes.
panelAccordion
org.apache.myfaces.trinidad.CorePanelAccordion
org.apache.myfaces.trinidad.Accordion
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Indicates whether more than one detail item may be
disclosed at a time. Use "false" (the default) to keep a maximum of
one detail item disclosed at all times. Use "true" to make it
possible for multiple detail items to be disclosed.
discloseMany
boolean
Indicates whether a minimum of one detail item must be
disclosed at a time. Use "false" (the default) to keep a minimum of one
detail item disclosed at all times. Use "true" to make it possible for
all items to be collapsed.
discloseNone
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelBorderLayout component is a layout element which lays out all of its
children consecutively in its middle, and supports the following
facets: top, bottom, left, right, start, end, innerTop, innerBottom, innerLeft, innerRight, innerStart, and innerEnd
panelBorderLayout
org.apache.myfaces.trinidad.CorePanelBorderLayout
org.apache.myfaces.trinidad.BorderLayout
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Specifies the CSS width to give to the inner end facet in valid CSS units.
Used if the layout is positioned and the inner end facet is present and rendered and the inner left or right facet
is not used instead. Defaults to 25%.
innerEndWidth
java.lang.String
Specifies the CSS height to give to the inner bottom facet in valid CSS units.
Used if the layout is positioned and the inner bottom facet is present and rendered. Defaults to 25%.
innerBottomHeight
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Specifies the CSS height to give to the inner top facet in valid CSS units.
Used if the layout is positioned and the inner top facet is present and rendered. Defaults to 25%.
innerTopHeight
java.lang.String
Specifies the CSS height to give to the bottom facet in valid CSS units.
Used if the layout is positioned and the bottom facet is present and rendered. Defaults to 25%.
bottomHeight
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
Changes how the panel is rendered. The default is to expand the panel to fix the size of its contents.
Setting the value to positioned will force the panel to use the size given to it via CSS (either via the
styleClass, inlineStyle or via the skin). The facets are sized using the height and width attributes and
the center is given the remainder. With a positioned layout the height and width should be set and the
position should be set to relative or absolute. Note that due to limitations in IE6, the positioned layout
uses JavaScript resizing that will affect performance. Expand is the default.
layout
java.lang.String
Specifies the CSS width to give to the end facet in valid CSS units.
Used if the layout is positioned and the end facet is present and rendered and the left or right facet
is not used instead. Defaults to 25%.
endWidth
java.lang.String
Specifies the CSS width to give to the inner start facet in valid CSS units.
Used if the layout is positioned and the inner start facet is present and rendered and the inner left or right facet
is not used instead. Defaults to 25%.
innerStartWidth
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
Specifies the CSS width to give to the start facet in valid CSS units.
Used if the layout is positioned and the start facet is present and rendered and the left or right facet
is not used instead. Defaults to 25%.
startWidth
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
Specifies the CSS height to give to the top facet in valid CSS units.
Used if the layout is positioned and the top facet is present and rendered. Defaults to 25%.
topHeight
java.lang.String
Specifies the CSS width to give to the left facet in valid CSS units.
Used if the layout is positioned and the left facet is present and rendered. Defaults to 25%.
leftWidth
java.lang.String
Specifies the CSS width to give to the inner right facet in valid CSS units.
Used if the layout is positioned and the inner right facet is present and rendered. Defaults to 25%.
innerRightWidth
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Specifies the CSS width to give to the right facet in valid CSS units.
Used if the layout is positioned and the right facet is present and rendered. Defaults to 25%.
rightWidth
java.lang.String
Specifies the CSS width to give to the inner left facet in valid CSS units.
Used if the layout is positioned and the inner left facet is present and rendered. Defaults to 25%.
innerLeftWidth
java.lang.String
The panelBox is used to place ancillary information on a page,
offset by a certain color.
panelBox
org.apache.myfaces.trinidad.CorePanelBox
org.apache.myfaces.trinidad.Box
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
An URL to an image to use for the icon of
the content container.
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
The header of the content container.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the appearance type of the content container. It should be one of "light",
"medium", "dark", or "transparent"
background
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
The inline style of the content region.
contentStyle
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelButtonBar lays out a set of buttons.
panelButtonBar
org.apache.myfaces.trinidad.CorePanelButtonBar
org.apache.myfaces.trinidad.ButtonBar
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the horizontal alignment to one of start, end, left,
right, or center.
halign
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelCaptionGroup is used to render a set of components,
into a related and more managable grouping. The group is surrounded by a border
containing the group caption.
panelCaptionGroup
org.apache.myfaces.trinidad.CorePanelCaptionGroup
org.apache.myfaces.trinidad.PanelCaptionGroup
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
The text to be rendered as the caption for the group content.
captionText
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelChoice control creates, contains and shows a series of items defined by showDetailItem nodes.
panelChoice
org.apache.myfaces.trinidad.CorePanelChoice
org.apache.myfaces.trinidad.Choice
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
position of the control elements. Defaults to
"start", if not specified. Other value supported is"top".
position
java.lang.String
alignment of the elements. Defaults to
"center", if not specified. Other values are "start",
"end", "top", and "bottom".
alignment
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the user-visible text of the item
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelFormLayout lays out input form controls, such that their labels and fields line up vertically. The children of this component are input controls, they are inputText, inputHidden, inputFile, inputColor, inputListOfValues, inputDate, selectBooleanCheckBox, selectBooleanRadio, selectOneChoice, selectOneListBox, selectOneRadio, selectManyListBox and panelLabelAndMessage. These components must have their "simple" attribute set to false (the default). For cases where other controls are required inside panelFormLayout, wrap them in a panelLabelAndMessage.
This component can be used to lay out multiple columns using the rows attribute. The children are laid out down and then across. Note that this layout is not a table layout so there is no overall table row. Instead, rows are unique per column; in one column a row may consume more vertical space than a nearby row in another column.
The panelFormLayout is an example of one of the components that has support for grouping its children components.
If you place panelFormLayout child items inside of a group, separators will be drawn around the group of form items if adjacent to other form items (separators won't be drawn at the top if the group is the first item in the column or, similarly, at the bottom if the group is the last item in the column).
Grouped panelFormLayout items are kept in the same column of the panelFormLayout even when the assigned rows attribute is set to a value smaller than the number of items in the group.
The panelFormLayout component also supports the group component in its footer facet so you can place more than one item in the footer. You can even group footer items one additional time to get separators to appear.
panelFormLayout
org.apache.myfaces.trinidad.CorePanelFormLayout
org.apache.myfaces.trinidad.FormLayout
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
The preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified.
This attribute is not supported on the following agent types:
phone, voice.
labelWidth
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
The alignment of label prompts for the form items.
labelAlignment
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Sets the number of rows after which to start a new column. This attribute defaults to Integer.MAX_VALUE. The number of rows actually rendered depends also on the "maxColumns" property. If the children will not fit in the given number of rows and columns, the number of rows will increase to accomodate the children.
This attribute is not supported on the following agent types:
phone, voice.
rows
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The preferred width of the field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified.
This attribute is not supported on the following agent types:
phone, voice.
fieldWidth
java.lang.String
Sets the maximum number of columns to show. This attribute defaults to 3 and 2 on PDAs. If this panelFormLayout is inside of another panelFormLayout, this will always be 1.
This attribute is not supported on the following agent types:
phone, voice.
maxColumns
int
A panel component that displays its children in a group.
panelGroupLayout
org.apache.myfaces.trinidad.CorePanelGroupLayout
org.apache.myfaces.trinidad.GroupLayout
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Type of layout, either "vertical", "horizontal" (no wrapping) or"default" (horizontal with wrapping).
layout
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelHeader control places a label and optional icon at the top of a section.
panelHeader
org.apache.myfaces.trinidad.CorePanelHeader
org.apache.myfaces.trinidad.Header
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the URI for the icon of the header.
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the label of the header.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Set if an error, info, confirmation, or warning header is needed.
messageType
java.lang.String
Size of this panelHeader. The largest is 0 and corresponds to an H1 header
the smallest is 5 and corresponds to an H6 Header. Note that this version of the tag will
display all sizes above 2 the same as size 2. Setting the size to a negative number will
allow the header to be calculated according to its parent header. The default value for
this property is -1.
size
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelHorizontalLayout control is a layout element that
arranges its children horizontally. The vertical and horizontal alignment
can be specified.
panelHorizontalLayout
org.apache.myfaces.trinidad.CorePanelHorizontalLayout
org.apache.myfaces.trinidad.HorizontalLayout
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the horizontal alignment to one of start, end, left,
right, or center.
halign
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
the vertical alignment to one of top, bottom, middle, or baseline.
valign
java.lang.String
This component lays out a label and children.
Typically, the only child of this component will be an input element of some sort,
but as many children as necessary can be added. When using panelLabelAndMessage with
a Trinidad input component, you should always set simple="true" on the input component.
Non-simple Trinidad input components already effectively have all the functionality of
panelLabelAndMessage. Note that the label and messages that are rendered only apply to the
"for" component so messages and labels will not be shown if there are multiple input
child components.
To lay out multiple panelLabelAndMessage components - or multiple non-simple Trinidad
input components - you can use the panelForm component. When panelLabelAndMessage
components are placed inside a panelForm the labels will line up.
panelLabelAndMessage
org.apache.myfaces.trinidad.CorePanelLabelAndMessage
org.apache.myfaces.trinidad.LabelAndMessage
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether the panel should show an indicator that its contents are required.
showRequired
boolean
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
The ID of the component that this component's label refers to.
for
java.lang.String
Specifies inline styles for the label portion of the component, e.g. "vertical-align: bottom;" to align the label to the bottom of the container.
labelStyle
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
An attribute that will simultaneously set both the "label" and "accessKey" attributes from a single value, using conventional ampersand notation. For example, setting this attribute to "T&ext" will set the label to "Text" and the access key to 'e'.
labelAndAccessKey
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelList control outputs each visible child
in a list with a bullet next to it.
panelList
org.apache.myfaces.trinidad.CorePanelList
org.apache.myfaces.trinidad.List
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Styles the list. For example, you can style the list to be squares like this:
listStyle='list-style-type:square'
listStyle
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
Sets
the number of rows after which to start a new column.
This attribute defaults to Integer.MAX_VALUE.
The number of rows actually rendered depends also on the
"maxColumns" attribute.
If the children will not fit in the given number
of rows and columns, the number of rows will
increase to accomodate the children.
This attribute is not supported on the following agent types:
phone, voice.
rows
int
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Sets
the maximum number of columns to show.
This attribute defaults to 3 and defaults to 2 for PDA's
This attribute is not supported on the following agent types:
phone, voice.
maxColumns
int
PanelPage lays out an entire page.
panelPage
org.apache.myfaces.trinidad.CorePanelPage
org.apache.myfaces.trinidad.Page
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
auxiliary1Size
int
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
auxiliary2Size
int
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
auxiliaryGlobalSize
int
PanelPageHeader lays out the top portion of a page.
panelPageHeader
org.apache.myfaces.trinidad.CorePanelPageHeader
org.apache.myfaces.trinidad.PageHeader
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
what the chromeType is for the page: compact or expanded. If
compact, the productBranding will be shown alongside the
corporate branding instead of below the corporate branding.
chromeType
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelPopup is used to place ancillary information on a page,
made visible via a clickable link.
panelPopup
org.apache.myfaces.trinidad.CorePanelPopup
org.apache.myfaces.trinidad.Popup
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
The position of the content container when visible. Defaults to
"relative" if not specified. Other values are "centered" (centered on screen).
position
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
The title of the panel when visible. The titlebar is not rendered if this attribute
is not specified.
title
java.lang.String
Set the height of the popup. If not present the width defaults to the height of the content.
height
int
an onmouseup Javascript handler.
onmouseup
java.lang.String
The display mode of the panel. Defaults to "false" (non-modal).
Non-Modal panels will close when the user clicks off the panel. Modal popups are
rendered with a titlebar and close icon. Clicking the close icon will close the
modal popup.
modal
boolean
Defines the launch behaviour of the popup. If set to 'click' the popup will
appear when the trigger is clicked, and disappear when you click off the popup. The 'hover' value
will cause the popup to appear while the mouse is over the trigger, and disappear when the mouse
leaves either the trigger or the popup panel.
triggerType
java.lang.String
The icon to render as a link to launch the popup panel. If the 'trigger'
facet is defined, then this attribute is ignored. If the 'text' attribute is also specified,
then the icon and text will both be rendered.
icon
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
The text to render as a link to launch the popup panel. If the 'trigger'
facet is defined, then this attribute is ignored.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
The popup's vertical offset in pixels from the current mouse position.
This property only applies to popups using relative positioning.
yoffset
int
an onmouseout Javascript handler.
onmouseout
java.lang.String
Set the width of the popup. If not present the width defaults to the width of the content.
width
int
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
The popup's horizontal offset in pixels from the current mouse position.
This property only applies to popups using relative positioning.
xoffset
int
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
The inline style of the content region.
contentStyle
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelRadio control creates, contains and shows a series of items defined by showDetailItem nodes.
panelRadio
org.apache.myfaces.trinidad.CorePanelRadio
org.apache.myfaces.trinidad.Radio
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
position of the control elements. Defaults to
"start", if not specified. Other value supported is"top".
position
java.lang.String
alignment of the elements. Defaults to
"center", if not specified. Other values are "start",
"end", "top", and "bottom".
alignment
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the user-visible text of the item
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelSideBar control renders a side navigation bar.
panelSideBar
org.apache.myfaces.trinidad.CorePanelSideBar
org.apache.myfaces.trinidad.SideBar
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
the width of the panelSideBar in pixels or as a percentage.
width
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelTabbed control creates, contains and shows a series of items defined by showDetailItem nodes.
panelTabbed
org.apache.myfaces.trinidad.CorePanelTabbed
org.apache.myfaces.trinidad.Tab
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the position of the tab bar. Defaults to
"both", if not specified. Other values are "above" and "below".
position
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The panelTip tag provides a container for page or section level hints
to the user.
panelTip
org.apache.myfaces.trinidad.CorePanelTip
org.apache.myfaces.trinidad.Tip
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
This components polls the server periodically so that any dependent
components get a chance to update themselves.
poll
org.apache.myfaces.trinidad.CorePoll
org.apache.myfaces.trinidad.Poll
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether data validation
should be skipped when poll
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.
immediate
boolean
a method reference to a poll listener
pollListener
void myMethod(org.apache.myfaces.trinidad.event.PollEvent)
the time between poll events, in milliseconds.
The default is 5000. If in screen-reader mode,
make sure the interval is long enough for the
screen reader to read through the re-render before a
new poll occurs.
interval
int
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
ProcessChoiceBar is a UIXProcess component that renders a previous
button, a choice bar, and a next button.
processChoiceBar
org.apache.myfaces.trinidad.CoreProcessChoiceBar
org.apache.myfaces.trinidad.ChoiceBar
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The progressIndicator component can be used to give users
an understanding that there is a back end task in progress.
progressIndicator
org.apache.myfaces.trinidad.CoreProgressIndicator
org.apache.myfaces.trinidad.Indicator
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
A method reference to an action listener.
This is invoked after the task in progress is complete.
actionListener
void myMethod(javax.faces.event.ActionEvent)
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
whether data validation - client-side or
server-side -
will be skipped when
events are generated by this component.
When immediate is true, the command's action and
ActionListeners, including the default ActionListener
provided by the JavaServer Faces implementation,
will be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase. Because
validation runs during Process Validators (after
Apply Request Values, but before Invoke Application),
setting immediate to true will skip validation.
immediate
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
The data model being used by this progress component.
The model should be of type
org.apache.myfaces.trinidad.model.BoundedRangeModel.
value
java.lang.Object
A reference to an action method sent by the progress component,
or the static outcome of an action. This is invoked when the task
under progress is complete.
action
java.lang.String myMethod()
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The reset button control creates a push button which will
reset the content of a form.
resetButton
org.apache.myfaces.trinidad.CoreResetButton
org.apache.myfaces.trinidad.Button
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
<html>
Character used to gain quick access to this button.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong> exist in the
<code>Text</code> attribute of this button instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is
to use textAndAccessKey.
</p></html>
accessKey
char
the textual label of the button.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the reset button should be disabled.
disabled
boolean
The selectBooleanCheckbox control is a standard browser input
checkbox. It supports displaying a prompt, text, and messages.
selectBooleanCheckbox
org.apache.myfaces.trinidad.CoreSelectBooleanCheckbox
org.apache.myfaces.trinidad.Checkbox
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
<html>
Character used to gain quick access to this checkbox.
For accessibility reasons, this functionality is not supported in
screen reader mode.
<p>
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong>exist in the
<code>text</code>attribute of this selectBooleanCheckbox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
</p></html>
accessKey
char
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
whether or not the component is
currently selected. This is a typesafe alias for the "value"
attribute. Note that "selected" and "value" attributes should not be used at the same time to avoid conflict.
selected
boolean
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the text value of the checkbox.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectBooleanRadio control maps to a single browser input
radio, grouped with all other selectBooleanRadio controls
in the same form which share the same "group" attribute.
It supports displaying a prompt, text, and messages.
selectBooleanRadio
org.apache.myfaces.trinidad.CoreSelectBooleanRadio
org.apache.myfaces.trinidad.Radio
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
<html>
Character used to gain quick access to this radio button.
For accessibility reasons, this functionality is not supported in
screen reader mode.
<p>
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
</p><p>
This attribute is sometimes referred to as the "mnemonic".
</p><p>
The character specified by this attribute
<strong>must</strong>exist in the
<code>text</code>attribute of this CheckBox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
</p></html>
accessKey
char
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
<html>
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p></html>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
whether or not the component is
currently selected. This is a typesafe alias for the "value"
attribute. Note that "selected" and "value" attributes should not be used at the same time to avoid conflict.
selected
boolean
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the text of the radio button.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
group
java.lang.String
whether the element is disabled.
disabled
boolean
The selectItem tag represents a single item that the user
may select from a list, choice, radio, or shuttle Trinidad control.
selectItem
org.apache.myfaces.trinidad.CoreSelectItem
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the value used to identify this item when the
parent control is submitted to the server. If no value is specified
for a particular item, the item's contents will be used as its
value.
value
java.lang.Object
the description associated with this option.
This is used in selectManyShuttle and selectOrderShuttle, and ignored otherwise.
longDesc
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
the user-visible text of the item
label
java.lang.String
The short description of the bean. This text
is commonly used by user agents to display advisory information about the option.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
whether the item is disabled. By default, no
items are disabled.
disabled
boolean
The selectManyCheckbox component creates a component which allows
the user to select many values from a series of checkboxes.
selectManyCheckbox
org.apache.myfaces.trinidad.CoreSelectManyCheckbox
org.apache.myfaces.trinidad.Checkbox
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
whether the control displays the buttons
horizontally or vertically.The valid values are "horizontal" and
"vertical",the default being "vertical".
layout
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectManyListbox component creates a component which allows
the user to select many values from a list of items.
selectManyListbox
org.apache.myfaces.trinidad.CoreSelectManyListbox
org.apache.myfaces.trinidad.Listbox
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
how many items should be visible. Small values may be overridden if the platform cannot render a list of that size correctly.
size
int
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectManyShuttle component provides a mechanism for selecting
multiple values from a list of values by allowing the user to move
items between two lists.
selectManyShuttle
org.apache.myfaces.trinidad.CoreSelectManyShuttle
org.apache.myfaces.trinidad.Shuttle
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the header of the leading list of the shuttle.
leadingHeader
java.lang.String
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
whether or not the leading list has an area to display descriptions.
leadingDescShown
boolean
whether or not the trailing list has an area to display descriptions.
trailingDescShown
boolean
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
the header of the trailing list of the shuttle.
trailingHeader
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the label for the shuttle that is used to identify the component only when displaying error messages. The label specified does not otherwise appear on the page.
label
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
the display size(number of items) of the lists. The size
specified must be between 10 and 20 items. If the attribute is not
set or has a value less than 10, the size would have a default or
minimum value of 10. If the attribute value specified is more than
20 items, the size would have the maximum value of 20.
size
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectOneChoice component creates a menu-style component, which allows the user to select a single value from a list of items.
selectOneChoice
org.apache.myfaces.trinidad.CoreSelectOneChoice
org.apache.myfaces.trinidad.Choice
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
The label for the option that represents a value of null, meaning nothing is selected. If unselectedLabel is not set and if the component does not have a selected value, then an option with an empty string as the label and value is rendered as the first option in the choice box (if there isn't an empty option already defined). Once an option has been successfully selected, and if unselectedLabel is not set, then the empty option will not be rendered.
unselectedLabel
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectOneListbox component creates a component which allows
the user to select a single value from a list of items.
selectOneListbox
org.apache.myfaces.trinidad.CoreSelectOneListbox
org.apache.myfaces.trinidad.Listbox
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the label for an additional item that indicates no selection has
been made. When the user selects this item, "required" validation will
not pass, or a null value will be set if the component is not "required".
unselectedLabel
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
The number of items that should be visible in the list. The renderer may constrain the maximum and minimum number of items shown.
size
int
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectOneRadio component creates a component
which allows the user to select a single value from a set of items
displayed as a series of radio buttons.
selectOneRadio
org.apache.myfaces.trinidad.CoreSelectOneRadio
org.apache.myfaces.trinidad.Radio
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Character used to gain quick access to
the form element specified by the
<code>for</code>, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
<p>
This attribute is sometimes referred to as the "mnemonic".
</p></html>
accessKey
char
whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the
"showRequired" attribute must be false for the visual indication not to be displayed.
showRequired
boolean
a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
simple
boolean
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
the label for an additional item that indicates no selection has
been made. When the user selects this item, "required" validation will
not pass, or a null value will be set if the component is not "required".
unselectedLabel
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
autoSubmit
boolean
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
whether the control displays the buttons
horizontally or vertically.The valid values are "horizontal" and
"vertical", the default being "vertical".
layout
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
the label of the bean.
label
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "L&amp;abel" will
set the label to "Label" and the access key to 'a'.
</p></html>
labelAndAccessKey
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
contentStyle
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
The selectOrderShuttle component provides a mechanism for selecting
multiple values from a list of values by allowing the user to move
items between two lists, and reordering that list of values.
selectOrderShuttle
org.apache.myfaces.trinidad.CoreSelectOrderShuttle
org.apache.myfaces.trinidad.Shuttle
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the header of the leading list of the shuttle.
leadingHeader
java.lang.String
a method reference to a validator method
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
whether or not the leading list has an area to display descriptions.
leadingDescShown
boolean
whether or not the trailing list has an area to display descriptions.
trailingDescShown
boolean
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a value change listener
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
whether or not the values are passed through to
the client. When valuePassThru is false
the value and the options' values
are converted to indexes before being sent to the client.
Therefore, when valuePassThru is false,
there is no need to write your own converter when you are using custom Objects
as your values and/or options.
If you need to know the actual values on the client-side, then you can set
valuePassThru to true. This will pass the values through to the client,
using your custom converter if it is available; a custom converter is
needed if you are using custom objects. The default is false.
valuePassThru
boolean
a converter object
converter
javax.faces.convert.Converter
the event handler for the component losing the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onblur
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the value of the component. If the EL binding
for the "value" points to a bean property with a getter but no setter, and
this is an editable component, the component will be rendered
in read-only mode.
value
java.lang.Object
whether the shuttle is in "reorder only" mode, where the user can reorder the list of values, but cannot add or remove them.
reorderOnly
boolean
whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
required
boolean
the header of the trailing list of the shuttle.
trailingHeader
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
<html> the message to be displayed, if 'required' validation fails.
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
</ul>
</p></html>
requiredMessageDetail
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
the label for the shuttle that is used to identify the component only when displaying error messages. The label specified does not otherwise appear on the page.
label
java.lang.String
the event handler for the component gaining the focus.
This attribute is not supported on the following agent types:
pda, phone, voice.
onfocus
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
event handler for when the value is changed.
onchange
java.lang.String
the display size(number of items) of the lists. The size
specified must be between 10 and 20 items. If the attribute is not
set or has a value less than 10, the size would have a default or
minimum value of 10. If the attribute value specified is more than
20 items, the size would have the maximum value of 20.
size
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
immediate
boolean
whether the element is read-only.
readOnly
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether the element is disabled.
disabled
boolean
SelectRangeChoiceBar is used to allow the user to select a range of
records to display among a larger set of records.
It allows the user to move back and forth through these records
through a choice and buttons.
selectRangeChoiceBar
org.apache.myfaces.trinidad.CoreSelectRangeChoiceBar
org.apache.myfaces.trinidad.ChoiceBar
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the name of the EL variable that provides access to the "start"
and "end" variables that point to the start and end row in
the each range from the data model. This can be used to customize
the range text.
var
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
<html> the data model being used by this component.
The specific model class is
<code>org.apache.myfaces.trinidad.model.CollectionModel</code>.
You may also use other model instances, e.g.,
<code>java.util.List</code> ,
array, and <code>javax.faces.model.DataModel</code>.
This component will automatically convert the instance
into a <code>CollectionModel</code>.</html>
value
java.lang.Object
a method reference to a rangeChange listener that
will be called when a new range is selected.
rangeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.RangeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the maximum number of rows to display in a single range of rows.
Some ranges might have fewer
than the number of rows specified by this attribute (eg: the last range
might have an insufficient number of rows).
To display all rows at once, set this attribute to 0.
rows
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation
should be skipped when range change
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.
immediate
boolean
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
the index of the first row in the currently range of rows.
This index is zero-based. This attribute is used to control
which range of rows to display to the user.
first
int
The separator is used anywhere to create a horizontal separator
between items.
separator
org.apache.myfaces.trinidad.CoreSeparator
org.apache.myfaces.trinidad.Separator
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
the CSS styles to use for this component.
inlineStyle
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
The showDetail provides a means of toggling a group of components between being
hidden or shown. If the "prompt" facet is present, the component in the facet
will be put next to the disclosure icon. If the prompt facet is not present
but either the disclosedText or the undisclosedText attributes are set, then
the text in that attribute will be displayed next to the disclosure icon.
If the prompt facet is not set but both the disclosedText and undisclosedText
attributes are set then the disclosedText will be displayed when disclosed="true"
and undisclosedText will be displayed when disclosed="false". If the prompt
facet is not set and neither the disclosedText or undisclosedText attributes are
set, then the label will default to "Hide" for the disclosed text and "Show" for
the undisclosed text. For the purposes of EL, setting disclosedText or
undisclosedText to null is the same as not setting the value.
showDetail
org.apache.myfaces.trinidad.CoreShowDetail
org.apache.myfaces.trinidad.ShowDetail
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
stops the local value of disclosed from being set
by renderers. This allows the value to always be taken from the value of the disclosed
value expression. Disclosed values must be updated in other ways (i.e. from a
disclosure listener)
This attribute is not supported on the following agent types:
phone, voice.
disclosedTransient
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the text to display when the children are undisclosed. If this attribute is set
and the disclosedText attribute is not set, this text will be displayed for
both the disclosed state AND the undisclosed state.
This attribute is not supported on the following agent types:
phone, voice.
undisclosedText
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the text to display when the children are disclosed. If this attribute is set
and the undisclosedText attribute is not set, this text will be displayed for
both the disclosed state AND the undisclosed state.
This attribute is not supported on the following agent types:
phone, voice.
disclosedText
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation - client-side or
server-side - should be skipped when
events are generated by this component.
When immediate is false (the default), the disclosure event will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, the disclosure
event will be executed during the Apply Request Values phase.
immediate
boolean
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether or not to disclose the children
This attribute is not supported on the following agent types:
phone, voice.
disclosed
boolean
a method reference to a disclosure listener
disclosureListener
void myMethod(org.apache.myfaces.trinidad.event.DisclosureEvent)
The showDetailHeader provides a means of toggling the contents under a header
between being disclosed(shown) or undisclosed(hidden).
showDetailHeader
org.apache.myfaces.trinidad.CoreShowDetailHeader
org.apache.myfaces.trinidad.Header
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
stops the local value of disclosed from being set
by renderers. This allows the value to always be taken from the value of the disclosed
value expression. Disclosed values must be updated in other ways (i.e. from a
disclosure listener)
This attribute is not supported on the following agent types:
phone, voice.
disclosedTransient
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the URI for the icon of the header.
icon
java.lang.String
the label of the header.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Set if an error, info, confirmation, or warning header is needed.
messageType
java.lang.String
an onmouseover Javascript handler.
onmouseover
java.lang.String
Size of this panelHeader. The largest is 0 and corresponds to an H1 header
the smallest is 5 and corresponds to an H6 Header. Note that this version of the tag will
display all sizes above 2 the same as size 2. Setting the size to a negative number will
allow the header to be calculated according to its parent header. The default value for
this property is -1.
size
int
whether data validation - client-side or
server-side - should be skipped when
events are generated by this component.
When immediate is false (the default), the disclosure event will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, the disclosure
event will be executed during the Apply Request Values phase.
immediate
boolean
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether or not to disclose the children
This attribute is not supported on the following agent types:
phone, voice.
disclosed
boolean
a method reference to a disclosure listener
disclosureListener
void myMethod(org.apache.myfaces.trinidad.event.DisclosureEvent)
The showDetailItem represents a single item with specific
contents that can be selected by users to be shown in a showOne component.
showDetailItem
org.apache.myfaces.trinidad.CoreShowDetailItem
org.apache.myfaces.trinidad.Item
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Character used to gain quick access to this showDetailItem.
For accessibility reasons, this functionality is not supported
in screen reader mode.
<p>
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
</p>
<p>
This attribute is sometimes referred to as the "mnemonic".
</p>
accessKey
char
An attribute that will simultaneously set both the "text"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
<p>
For example, setting this attribute to "T&amp;ext" will
set the text to "Text" and the access key to 'e'.
</p>
textAndAccessKey
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
stops the local value of disclosed from being set
by renderers. This allows the value to always be taken from the value of the disclosed
value expression. Disclosed values must be updated in other ways (i.e. from a
disclosure listener)
This attribute is not supported on the following agent types:
phone, voice.
disclosedTransient
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
an onmousemove Javascript handler.
onmousemove
java.lang.String
the textual label of the showDetailItem.
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
A non-negative integer that indicates the flexibility of this
component in its container. If the container supports it, flex
is used to determine how space is distributed among its children.
Components with larger flex values will be made larger than
components with lower flex values. This is done so at the ratio
determined by the flex of each of the two components. The actual
value is only relevant if there are other flexible components
(components with flex values larger than zero) within the same
container.
flex
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
whether data validation - client-side or
server-side - should be skipped when
events are generated by this component.
When immediate is false (the default), the disclosure event will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, the disclosure
event will be executed during the Apply Request Values phase.
immediate
boolean
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
whether or not to disclose the children
This attribute is not supported on the following agent types:
phone, voice.
disclosed
boolean
a method reference to a disclosure listener
disclosureListener
void myMethod(org.apache.myfaces.trinidad.event.DisclosureEvent)
If value is "true", the component becomes non-interactive.
Otherwise,the default value is "false" and component assumes
its expected behavior.
disabled
boolean
SingleStepButtonBar renders a Previous button,
text describing the current step and the maximum steps, and a Next button.
singleStepButtonBar
org.apache.myfaces.trinidad.CoreSingleStepButtonBar
org.apache.myfaces.trinidad.ButtonBar
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
a method reference to an action listener
that will be called when the singleStep component navigates
to the previous step.
previousActionListener
void myMethod(javax.faces.event.ActionEvent)
a reference to an action method
that will be called when the singleStep component navigates
to the next step, or the static outcome of the action.
nextAction
java.lang.String myMethod()
the last possible step. If this value is not known,
it should be set to
MAX_VALUE_UNKNOWN (-1),
which is also the default value. If maxStep is
MAX_VALUE_UNKNOWN, then no text is rendered between the Back/Next
buttons. When maxStep is 2 and selectedStep
is 1, then only a Continue button is rendered.
maxStep
int
a reference to an action method
that will be called when the singleStep component navigates
to the previous step, or the static outcome of the action.
previousAction
java.lang.String myMethod()
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
a method reference to an action listener
that will be called when the singleStep component navigates
to the next step.
nextActionListener
void myMethod(javax.faces.event.ActionEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the text description of items being navigated.
The default is "Step".
text
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the current step. The valid range is 1 to maxStep.
It defaults to 1.
selectedStep
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
an onclick Javascript handler.
onclick
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onmousedown Javascript handler.
onmousedown
java.lang.String
spacers occupy a fixed amount of
space in a layout.
spacer
org.apache.myfaces.trinidad.CoreSpacer
org.apache.myfaces.trinidad.Spacer
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the IDs of the components that should trigger a partial update.
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.
partialTriggers
java.lang.String[]
the height of the spacer item.
height
java.lang.String
the width of the spacer item.
width
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
the short description of the bean. This text
is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
The statusIndicator component shows whether the page
is busy processing or is ready. By default, the component
shows predefined icons for both readyand busy state. However,
if a facet is specified, be it rendered or not, none of the
default icon is going to be rendered. That behavior enable an
easy emulation of GMail behavior specifying only a busy
facet.
statusIndicator
org.apache.myfaces.trinidad.CoreStatusIndicator
org.apache.myfaces.trinidad.StatusIndicator
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The subform tag represents an independently submittable
region of a page. The contents of a subform will only be validated
(or otherwise processed) if a component inside of the subform is
responsible for submitting the page or if the default attribute is set to true.
subform
org.apache.myfaces.trinidad.CoreSubform
org.apache.myfaces.trinidad.Subform
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
whether the subform should assume it
has been submitted. When set to "true", "submitted" will be
considered true if no other subform has been submitted.
default
boolean
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
The Trinidad Table is used to display tabular data. It also supports selection (both single and multiple), sorting, record navigation and detail-disclosure.
table
org.apache.myfaces.trinidad.CoreTable
org.apache.myfaces.trinidad.Table
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the summary of this table's purpose and structure
for user agents rendering to non-visual media.
summary
java.lang.String
whether or not to enable the show/hide all
links above the table,
which allow the user to show/hide all the detail rows.
To enable the detail rows, a "detailStamp" facet must be set on
this Table.
This attribute is not supported on the following agent types:
phone, voice.
allDetailsEnabled
boolean
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
the interval between which the column banding alternates. For example, a columnBandingInterval of 1 would display alternately banded columns.
columnBandingInterval
int
text displayed when a table is empty.
emptyText
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a selection listener
selectionListener
void myMethod(org.apache.myfaces.trinidad.event.SelectionEvent)
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.). This only takes effect if rowSelection attribute enabled.
autoSubmit
boolean
if the horizontal grid lines will be drawn.
horizontalGridVisible
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
the data model being used by this component.
The specific model class is
<code>org.apache.myfaces.trinidad.model.CollectionModel</code>.
You may also use other model instances, e.g.,
<code>java.util.List</code> ,
array, and <code>javax.faces.model.DataModel</code>.
This component will automatically convert the instance
into a <code>CollectionModel</code>.
value
java.lang.Object
a method reference to a rangeChange listener that
will be called when a new range is selected.
rangeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.RangeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
whether rows in this table selectable. Valid values are "none", "single", "multiple"
rowSelection
java.lang.String
the set of disclosed rows for this component.
Each entry in the set is a rowKey.
disclosedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
the width of the table. The value must either be a number of pixels or a percentage - it is not a CSS width.
width
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the maximum number of rows to display in a single range of rows.
Some ranges might have fewer
than the number of rows specified by this attribute (eg: the last range
might have an insufficient number of rows).
To display all rows at once, set this attribute to 0.
The default is 25.
rows
int
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
the interval between which the row banding alternates. For example, rowBandingInterval=1 would displayalternately banded rows in the Grid.
rowBandingInterval
int
whether or not data validation - client-side or
server-side -
should take place when
events are generated by this component.
When immediate is true, the default ActionListener
provided by the JavaServer Faces implementation
should be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase.
immediate
boolean
the selection state for this component.
selectedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
a method reference to an ExpansionListener
rowDisclosureListener
void myMethod(org.apache.myfaces.trinidad.event.RowDisclosureEvent)
a method reference to a sort listener
sortListener
void myMethod(org.apache.myfaces.trinidad.event.SortEvent)
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
if the vertical grid lines will be drawn.
verticalGridVisible
boolean
the index of the first row in the currently range of rows.
This index is zero-based. This attribute is used to control
which range of rows to display to the user.
first
int
Train is a UIXProcess component that renders a train.
A train is a horizontal series of train stations connected by
a horizontal line. Each train station
is an image and text describing the page in the multi-page process.
train
org.apache.myfaces.trinidad.CoreTrain
org.apache.myfaces.trinidad.Train
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
Represents an interactive tree component.
tree
org.apache.myfaces.trinidad.CoreTree
org.apache.myfaces.trinidad.Tree
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
the rowKey of the currently focused row.
The rowKeys of the ancestor rows of the focus row are added
to the expandedRowKeys RowKeySet by default.
focusRowKey
java.lang.Object
a method reference to a focus listener
focusListener
void myMethod(org.apache.myfaces.trinidad.event.FocusEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
If upon initial rendering, the current subtree under the focused row path
should be expanded. A RowDisclosureEvent is broadcast from the encode begin of the
component so that listeners are properly notified of the disclosure.
initiallyExpanded
boolean
a method reference to a selection listener
selectionListener
void myMethod(org.apache.myfaces.trinidad.event.SelectionEvent)
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of tree data - must be of type
org.apache.myfaces.trinidad.model.TreeModel
value
java.lang.Object
an onmousemove Javascript handler.
onmousemove
java.lang.String
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
the set of disclosed rows for this component.
Each entry in the set is a rowKey.
disclosedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
whether or not data validation - client-side or
server-side -
should take place when
events are generated by this component.
When immediate is true, the default ActionListener
provided by the JavaServer Faces implementation
should be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase.
immediate
boolean
the selection state for this component.
selectedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
a method reference to an ExpansionListener
rowDisclosureListener
void myMethod(org.apache.myfaces.trinidad.event.RowDisclosureEvent)
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
The Trinidad TreeTable is used to display data that is structured in a hierarchical format.
treeTable
org.apache.myfaces.trinidad.CoreTreeTable
org.apache.myfaces.trinidad.TreeTable
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
the summary of this table's purpose and structure
for user agents rendering to non-visual media.
summary
java.lang.String
the maximum number of records that can be displayed at
one time (range size).
Each level of depth in the tree can have a different range size.
The first number in the array sets the range size for the root
collection. Each subsequent number sets the range size for the
corresponding depth. The last number becomes the default for
each subsequent level of depth.
If a node has more children than
the range size, navigation rows will be rendered above and
below the child nodes.
rowsByDepth
int[]
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
the rowKey of the currently focused row.
The rowKeys of the ancestor rows of the focus row are added
to the expandedRowKeys RowKeySet by default.
focusRowKey
java.lang.Object
a method reference to a focus listener
focusListener
void myMethod(org.apache.myfaces.trinidad.event.FocusEvent)
the interval between which the column banding alternates. For example, a columnBandingInterval of 1 would display alternately banded columns.
columnBandingInterval
int
text displayed when a table is empty.
emptyText
java.lang.String
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to a selection listener
selectionListener
void myMethod(org.apache.myfaces.trinidad.event.SelectionEvent)
If upon initial rendering, the current subtree under the focused row path
should be expanded. A RowDisclosureEvent is broadcast from the encode begin of the
component so that listeners are properly notified of the disclosure.
initiallyExpanded
boolean
If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.). This only takes effect if rowSelection attribute enabled.
autoSubmit
boolean
if the horizontal grid lines will be drawn.
horizontalGridVisible
boolean
an onmouseup Javascript handler.
onmouseup
java.lang.String
the hierarchy of tree data - must be of type
org.apache.myfaces.trinidad.model.TreeModel
value
java.lang.Object
a method reference to a rangeChange listener that
will be called when a new range is selected.
rangeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.RangeChangeEvent)
If the root node should be rendered or not. Defaults to true.
rootNodeRendered
boolean
Whether the Expand All, Collapse All links should be rendered.
expandAllEnabled
boolean
an onmousemove Javascript handler.
onmousemove
java.lang.String
whether rows in this table selectable. Valid values are "none", "single", "multiple"
rowSelection
java.lang.String
the set of disclosed rows for this component.
Each entry in the set is a rowKey.
disclosedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
the IDs of the components that should trigger a partial update.
<p>
This component will listen on the trigger components. If one of the
trigger components receives an event that will cause it to update
in some way, this component will request to be updated too.</p>
<p>
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
</p>
<p>
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
or use multiple colons to move up through the NamingContainer. For example,
"::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
":::" will pop out of two naming containers, etc. The search for
the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
component with id = commandButton1 after popping out of two naming containers relative to this component.
To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
partialTriggers
java.lang.String[]
an ondblclick Javascript handler.
ondblclick
java.lang.String
the CSS styles to use for this component.
inlineStyle
java.lang.String
an onmouseout Javascript handler.
onmouseout
java.lang.String
a CSS style class to use for this component.
styleClass
java.lang.String
the width of the table. The value must either be a number of pixels or a percentage - it is not a CSS width.
width
java.lang.String
an onkeyup Javascript handler.
onkeyup
java.lang.String
an onkeydown Javascript handler.
onkeydown
java.lang.String
an onkeypress Javascript handler.
onkeypress
java.lang.String
The short description of the component. This text is commonly used by user agents to display tooltip help text.
shortDesc
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
an onmouseover Javascript handler.
onmouseover
java.lang.String
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
the interval between which the row banding alternates. For example, rowBandingInterval=1 would displayalternately banded rows in the Grid.
rowBandingInterval
int
whether or not data validation - client-side or
server-side -
should take place when
events are generated by this component.
When immediate is true, the default ActionListener
provided by the JavaServer Faces implementation
should be executed during Apply Request Values phase
of the request processing lifecycle, rather than
waiting until the Invoke Application phase.
immediate
boolean
the selection state for this component.
selectedRowKeys
org.apache.myfaces.trinidad.model.RowKeySet
a method reference to an ExpansionListener
rowDisclosureListener
void myMethod(org.apache.myfaces.trinidad.event.RowDisclosureEvent)
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
an onclick Javascript handler.
onclick
java.lang.String
an onmousedown Javascript handler.
onmousedown
java.lang.String
if the vertical grid lines will be drawn.
verticalGridVisible
boolean
The group component is an invisible control that aggregates semantically-related children; the group itself has no associated client representation (visual or API).
Some parent components may have special representation for groups like adding separators around the group but this is a special case and is not always rendered this way.
In most cases, only the children of the group will be rendered directly to the page.
There will be no layout applied to the children so the natural layout behavior of the underlying HTML elements will apply.
If you require a more predictable layout, you should use a layout component such as panelGroupLayout.
group
org.apache.myfaces.trinidad.Group
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
<html>
a title value for the group. Whether anything is done with this title value is up to the
group's parent component.
</html>
title
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
<html>
indicates if a visual group end boundary is desired. The default value of 'dontCare'
indicates no preference. A value of 'show' indicates a preference to show an end boundary.
A value of 'hide' indicates a preference to not show an end boundary. Regardless of the
end boundary value, whether a visual boundary will be displayed is up to the group's
parent component.
</html>
endBoundary
java.lang.String
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
<html>
indicates if a visual group start boundary is desired. The default value of 'dontCare'
indicates no preference. A value of 'show' indicates a preference to show a start boundary.
A value of 'hide' indicates a preference to not show a start boundary. Regardless of the
start boundary value, whether a visual boundary will be displayed is up to the group's
parent component.
</html>
startBoundary
java.lang.String
UIXIterator is a component that performs iteration
over its child components. It is like a UIXTable without any chrome.
While functionally similar to a forEach tag, an iterator is a component
that does its processing during rendering, while forEach runs during
the assembly of the component tree, and doesn't leave behind a component in the
heirarchy.
iterator
org.apache.myfaces.trinidad.Iterator
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:<ul><li>"model" - returns the CollectionModel for this component</li><li>"index" - returns the zero based row index</li></ul></html>
varStatus
java.lang.String
Name of the EL variable used to reference each element of this collection.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
var
java.lang.String
the data model being used by this component.
The specific model class is
<code>org.apache.myfaces.trinidad.model.CollectionModel</code>.
You may also use other model instances, e.g.,
<code>java.util.List</code> ,
array, and <code>javax.faces.model.DataModel</code>.
This component will automatically convert the instance
into a <code>CollectionModel</code>.
value
java.lang.Object
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
the index of the first row in the currently range of rows.
This index is zero-based. This attribute is used to control
which range of rows to display to the user.
first
int
the maximum number of rows to display in a single range of rows.
Some ranges might have fewer
than the number of rows specified by this attribute (eg: the last range
might have an insufficient number of rows).
To display all rows at once, set this attribute to 0.
The default is 25.
rows
int
The switcher component dynamically decides which facet component
should be rendered.
switcher
org.apache.myfaces.trinidad.Switcher
org.apache.myfaces.trinidadinternal.facelets.TrinidadComponentHandler
a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
attributeChangeListener
void myMethod(org.apache.myfaces.trinidad.event.AttributeChangeEvent)
<html>the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
</ul></html>
id
java.lang.String
the name of the facet to render and process.
facetName
java.lang.String
the name of the facet to render and process if "facetName"
is null or otherwise does not refer to an existing facet.
defaultFacet
java.lang.String
an EL reference that will store the component instance on a
bean. This can be used to give programmatic access to a component
from a backing bean, or to move creation of the component to a backing bean.
binding
javax.faces.component.UIComponent
whether the component is rendered. When set to false, no output will be
delivered for this component (the component will not in any way be rendered,
and cannot be made visible on the client). If you want to change a component's
rendered attribute from false to true
using PPR, set the partialTrigger attribute of its parent component so the
parent refreshes and in turn will render this component.
rendered
boolean
Validate the byte length of strings when encoded.
validateByteLength
org.apache.myfaces.trinidad.ByteLength
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
maximum number of allowable bytes when the string is encoded
maximum
int
the Java encoding used for the string.
encoding
java.lang.String
<p>
Custom error message to be used, for creating detail part of
faces message, when conversion fails for input that
exceeds the maximum byte length.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the maximum length
</li>
</ul>
</p>
messageDetailMaximum
java.lang.String
Validate that the date entered is within a given restriction.
validateDateRestriction
org.apache.myfaces.trinidad.DateRestriction
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
Specify the month which are invalid for your use case.
The attribute takes a whitespace delimited list of months.
Possible values are jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
invalidMonths
java.lang.String[]
Specify the weekdays which are invalid for your use case.
The attribute takes whitespace delimited list of weekdays.
Possible values are sun, mon, tue, wed, thu, fri, sat.
invalidDaysOfWeek
java.lang.String[]
To specifiy a concrete List of Dates, use the invalidDays attribute and wire it
to a DateListProvider implementation. This returns a list of dates, which are invalid.
invalidDays
org.apache.myfaces.trinidad.model.DateListProvider
<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>invalidMonths</code> value
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid month
</li>
</ul>
</p>
messageDetailInvalidMonths
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>invalidDaysOfWeek</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid weekday
</li>
</ul>
</p>
messageDetailInvalidDaysOfWeek
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>invalidDate</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the invalid date
</li>
</ul>
</p>
messageDetailInvalidDays
java.lang.String
Validate that the date entered is within a given range.
validateDateTimeRange
org.apache.myfaces.trinidad.DateTimeRange
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
the maximum java.util.Date.
ISO 8601 date strings, of the form 'yyyy-MM-dd'
(for example 2004-06-22) is also allowed.
This will be parsed to date. When binding to Date objects, it is advised to create the Date object with
maximum value for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds)
to allow the largest range of values to be accepted.
maximum
java.util.Date
The minimum java.util.Date.
ISO 8601 date strings, of the form 'yyyy-MM-dd'
(for example 2004-06-22) are also allowed.
This will be parsed to date. When binding to Date objects, it is advised to create the Date object with zeroed-out
values for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds)
to allow the largest range of values to be accepted.]]
minimum
java.util.Date
<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>maximum</code> value
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the maximum allowed date
</li>
</ul>
</p>
messageDetailMaximum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>minimum</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed date
</li>
</ul>
</p>
messageDetailMinimum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
if input value is not with in the range, when
<code>minimum</code> and <code>maximum</code> is
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed date
</li>
<li>
{3} the maximum allowed date
</li>
</ul>
</p>
messageDetailNotInRange
java.lang.String
Validate that the date entered is within a given range.
validateDoubleRange
org.apache.myfaces.trinidad.DoubleRange
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
The maximum double value of the entered value.
maximum
double
The minimum double value of the entered value..
minimum
double
<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>maximum</code> value
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the maximum allowed value
</li>
</ul>
</p>
messageDetailMaximum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>minimum</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed value
</li>
</ul>
</p>
messageDetailMinimum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
if input value is not with in the range, when
<code>minimum</code> and <code>maximum</code> is
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed value
</li>
<li>
{3} the maximum allowed value
</li>
</ul>
</p>
messageDetailNotInRange
java.lang.String
Validate that the string entered is of a given length.
validateLength
org.apache.myfaces.trinidad.Length
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
the maximum length of the entered value.
maximum
int
the minimum length of the entered value.
minimum
int
<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>maximum</code> length
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the maximum allowed length
</li>
</ul>
</p>
messageDetailMaximum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>minimum</code>
length.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed length
</li>
</ul>
</p>
messageDetailMinimum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
if input value is not of an acceptable length, when both
<code>minimum</code> and <code>maximum</code> are
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed length
</li>
<li>
{3} the maximum allowed length
</li>
</ul>
</p>
messageDetailNotInRange
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
if input value is not of an acceptable length, when both
<code>minimum</code> and <code>maximum</code> are
set to the same value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the allowed length
</li>
</ul>
</p>
messageDetailExact
java.lang.String
Validate that the date entered is within a given range.
validateLongRange
org.apache.myfaces.trinidad.LongRange
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
The maximum long value of the entered value.
maximum
long
The minimum long value of the entered value..
minimum
long
<p>
The detail error message to be used for constructing faces messages,
when input value exceeds the <code>maximum</code> value
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the maximum allowed value
</li>
</ul>
</p>
messageDetailMaximum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
when input value is less than the set <code>minimum</code>
value.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed value
</li>
</ul>
</p>
messageDetailMinimum
java.lang.String
<p>
The detail error message to be used for constructing faces messages,
if input value is not with in the range, when
<code>minimum</code> and <code>maximum</code> is
set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the minimum allowed value
</li>
<li>
{3} the maximum allowed value
</li>
</ul>
</p>
messageDetailNotInRange
java.lang.String
Validate expression using Java regular expression syntax.
If you want to match a metacharacter in a pattern, escape it with \\.
E.g. to match [ your regular expression pattern would be \\[.
validateRegExp
org.apache.myfaces.trinidad.RegExp
org.apache.myfaces.trinidadinternal.facelets.TrinidadValidatorHandler
the identifier for the validator
id
pattern to be matched in the input value.
pattern
java.lang.String
<p>
Custom error message to be used, for creating detail part of
faces message, when users input does not match the specified
pattern.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} represents the 'pattern' expected in the input
</li>
</ul>
</p>
messageDetailNoMatch
java.lang.String
Converts an string, to and from java.awt.Color objects.
convertColor
org.apache.myfaces.trinidad.Color
org.apache.myfaces.trinidadinternal.facelets.TrinidadConverterHandler
the identifier for the converter
id
The set of acceptable patterns, as a whitespace sepa
rated list.
The first pattern in the list will be used for formatting
java.awt.Color values. All patterns will be tried in
order to convert Strings back into java.awt.Colors.
If no patterns are set, the default is "#RRGGBB r,g,b".
patterns
java.lang.String[]
Whether the converter should allow generation of a "
transparent"
color (a black color with an alpha of zero). The converter uses
a String version of "transparent" that is translated for the
user's locale.
transparentAllowed
boolean
<html><p>
Custom error message to be used, for creating detail part of
faces message, when users input does not match the specified
pattern.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the pattern the converter is expecting
</li>
</ul>
</p></html>
messageDetailConvert
java.lang.String
Converts string into java.util.Date and vice versa based on the pattern
and style set.
convertDateTime
org.apache.myfaces.trinidad.DateTime
org.apache.myfaces.trinidadinternal.facelets.TrinidadConverterHandler
the identifier for the converter
id
<html><p>
Custom error message to be used, for creating detail part of
faces message, for values that cannot be converted to date when
the pattern / secondary pattern is set or when
<code>type</code> is set to
<code>'date'</code> and <code>pattern</code>
is not set or is null.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} an example of the format the converter is expecting
</li>
</ul>
</p></html>
messageDetailConvertDate
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of
faces message, for time based value that cannot be converted
to date when <code>type</code> is set to
<code>'time'</code>, <code>pattern</code> is
not set or is null
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} an example of the format the converter is expecting
</li>
</ul>
</p></html>
messageDetailConvertTime
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of
faces message, for date-time based value that cannot be converted
to date when <code>type</code> is set to
<code>'both'</code> and <code>pattern</code>
is not set or is null.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} an example of the format the converter is expecting
</li>
</ul>
</p></html>
messageDetailConvertBoth
java.lang.String
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". Valid values are "shortish", "short", "default",
"medium", "long", and "full". Default value is "shortish".
dateStyle
java.lang.String
Locale whose predefined styles for dates and times are used during
formatting or parsing. If not specified or if null, the Locale returned by
FacesContext.getViewRoot().getLocale() will be used.
locale
java.util.Locale
Custom formatting pattern which determines how the date/time string
should be formatted and parsed.
pattern
java.lang.String
Second pattern, which will be used as a second attempt to parse a
string if the primary pattern or styles fail, but is never used for
formatting strings.
secondaryPattern
java.lang.String
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". Valid values are "default", "short", "medium",
"long", and "full". Default value is "short".
timeStyle
java.lang.String
Time zone in which to interpret any time information in the date
string. If not set here, picks this value from
trinidad-config.xml configuration file. If not defined there, then
it is defaulted to the value returned by TimeZone.getDefault() which is usually the server JVM timezone.
timeZone
java.util.TimeZone
Specifies what contents the string value will be formatted to
include, or parsed. Valid values are "date", "time", and "both".
Default value is "date".
type
java.lang.String
Converts an string to a Number and vice versa based on the 'pattern' or the 'type' set.
convertNumber
org.apache.myfaces.trinidad.Number
org.apache.myfaces.trinidadinternal.facelets.TrinidadConverterHandler
the identifier for the converter
id
The ISO 4217 currency code, applied only when formatting currencies.
Currency code can also be set for the entire application in trinidad-config.xml file.
If currency code is not set on the converter, and if set on
trinidad-config.xml configuration file it will be used by calling
<code>RequestContext().getCurrenctInstance().getCurrencyCode().</code>
This currency code will be used during call to getAsString() for formatting,
provided type is set to 'currency'.
currencyCode
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of the
<code>FacesMessage</code>, when
<code>value</code> cannot be converted to a number, when
<code>type</code> is set to
<code>'currency'</code> and <code>pattern</code>
is null or not set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
</ul>
</p></html>
messageDetailConvertCurrency
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of the
<code>FacesMessage</code>, when
<code>value</code> cannot be converted to a number, when
<code>type</code> is set to <code>'number'</code>
and <code>pattern</code> is null or not set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
</ul>
</p></html>
messageDetailConvertNumber
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of the
<code>FacesMessage</code> message, when
<code>value</code> cannot be converted to a number, based
on the <code>pattern</code> set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
<li>
{2} the specified conversion pattern
</li>
</ul>
</p></html>
messageDetailConvertPattern
java.lang.String
<html><p>
Custom error message to be used, for creating detail part of the
<code>FacesMessage</code>, when
<code>value</code> cannot be converted to a number, when
<code>type</code> is set to
<code>'percent'</code> and <code>pattern</code>
is null or not set.
</p>
<p>
<strong>
Parameters:
</strong>
<ul>
<li>
{0} the label that identifies the component
</li>
<li>
{1} value entered by the user
</li>
</ul>
</p></html>
messageDetailConvertPercent
java.lang.String
Currency symbol, is applied only when formatting currencies.
If currency code is set then symbol will be ignored.
currencySymbol
java.lang.String
Flag specifying whether formatted output will contain grouping separators.
Default value is true.
groupingUsed
boolean
Flag specifying whether only the integer part of the value will be formatted
and parsed. Default value is false.
integerOnly
boolean
Locale whose predefined styles for numbers are used during formatting and parsing.
If not specified, the Locale returned by FacesContext.getViewRoot().getLocale()
will be used.
locale
java.util.Locale
Maximum number of digits that will be formatted in the fractional portion of the
output.
maxFractionDigits
int
Maximum number of digits that will be formatted in the integer portion of the
output.
maxIntegerDigits
int
Minimum number of digits that will be formatted in the fractional portion of
the output.
minFractionDigits
int
Minimum number of digits that will be formatted in the integer portion of the
output.
minIntegerDigits
int
Custom formatting pattern which determins how the number string should be
formatted and parsed.
pattern
java.lang.String
Specifies how the number string will be formatted and parsed.
Valid values are "number", "currency", and "percent".
Default value is "number".
type
java.lang.String