Summary

The panelBox is used to place ancillary information on a page,
offset by a certain color.

There are four possible attributes to set for the content container.
The width of the container can be set to either an exact pixel size or
a percentage of the element the content container is within. This is
done by using the inlineStyle or styleClass attributes.

Content containers can have headers and icons. Set the text and icon
attributes to gain these items. If neither is set, the content
container will only display its children. If there is a header but no
icon, the header will show and the content will be offset to line up with
the start of the header. If an icon is set, the icon will appear to the
left of the header, but the content will still be offset to the left of the
header. If an icon is set but no header, the icon will still be displayed
on the left but no header text will be visible.

Content containers can have various color schemes, which can be specified
by setting the background attribute. The values for the background attribute
are light, medium, dark, and transparent. The default is light. Please note
that changing the background attribute may also change the appearance of the
title bar.

You can make changes to the style of the content region of this component by
adding your custom styles to the contentStyle attribute.

Content containers will generally have only one child with the actual
contents as its children. This child will describe how the content should be
displayed. However, the content container can have multiple children, in
which case the children are displayed in a stack fashion, lined up
vertically.

Supported Client Events for Client Behaviors

Events

Type

Phases

Description

org.apache.myfaces.trinidad.event.AttributeChangeEvent

Invoke Application,Apply Request Values

Event delivered to describe an attribute change. 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 event might include the width of a column that supported client-side resizing.

Attributes

Name

Type

Supports EL?

Description

attributeChangeListener

javax.el.MethodExpression

Only EL

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.

background

String

Yes

Valid Values: light, medium, dark, transparentDefault Value: light

the appearance type of the content container. It should be one of "light",
"medium", "dark", or "transparent"

binding

org.apache.myfaces.trinidad.component.core.layout.CorePanelBox

Only EL

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.

contentStyle

String

Yes

The inline style of the content region.

icon

String

Yes

An URL to an image to use for the icon of
the content container.

id

String

No

the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:

They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).

Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method,
dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers
be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component
that is a NamingContainer (if any).

inlineStyle

String

Yes

the CSS styles to use for this component.

onclick

String

Yes

an onclick Javascript handler.

ondblclick

String

Yes

an ondblclick Javascript handler.

onkeydown

String

Yes

an onkeydown Javascript handler.

onkeypress

String

Yes

an onkeypress Javascript handler.

onkeyup

String

Yes

an onkeyup Javascript handler.

onmousedown

String

Yes

an onmousedown Javascript handler.

onmousemove

String

Yes

an onmousemove Javascript handler.

onmouseout

String

Yes

an onmouseout Javascript handler.

onmouseover

String

Yes

an onmouseover Javascript handler.

onmouseup

String

Yes

an onmouseup Javascript handler.

partialTriggers

String[]

Yes

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.

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".

rendered

boolean

Yes

Default Value: true

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.

shortDesc

String

Yes

The short description of the component. This text is commonly used by user agents to display tooltip help text.