Skip navigation links

oracle.adf.view.rich.component.rich.layout
Class RichPanelBox

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelBox

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichPanelBox

extends org.apache.myfaces.trinidad.component.UIXPanel

implements javax.faces.component.behavior.ClientBehaviorHolder

<html:p> The panelBox is used to place ancillary information on a page, offset by a certain color. </html:p> <html:p> 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. </html:p> <html:p> Content containers can have header text, icons and a toolbar facet. Set the text and icon attributes to gain these items. The toolbar is a facet that can contain any content within reason (remeber this is a header so don't stick a table in here and think it should look nice!). Most of the time you should be adding simple components like a link, command toolbar button, etc. It is highliy recommended that you use a toolbox with a single toolbar with your specific components inside the toolbar. Doing so allows you to take advantage of the geometry management inside the toolbar and toolbox and gives you automatic access to the overflow capability. If you do not set header text or icon or toolbar facet then the header portion will not render. The content container will only display its children. If you only declare a single one of these (header text or icon or toolbar facet) a header but no 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. In addition if you define a toolbar facet then this will always be right aligned to the end of the header. If an icon is set but no header text, the icon will still be displayed on the left but no header text will be visible. If a toolbar facet then this content will be right aligned to the end of the header. NOTE: Anytime the toolbar facet is defined the alignment attribute is ignored. This means setting this value will have no effect. </html:p> <html:p> Content containers can have various color schemes, which can be specified by setting a combination of the ramp and background attributes. The values for the background attribute are default, light, medium, and dark. The default is default. There are two distinct color schemes controlled by the ramp attribute. The value for ramp can be core or highlight with core as the default Please note that changing the background attribute may also change the appearance of the title bar. </html:p> <html:p> You can make changes to the style of the content region of this component by adding your custom styles to the contentStyle attribute. </html:p> <html:p> 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, but please note that it does not layout these children in any way. </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component will be stretched if: <html:ul> <html:li>type="default" and its parent layout component is stretching the panelBox (e.g. panelDashboard)</html:li> <html:li>type="stretch"</html:li> </html:ul> </html:li> <html:li>This component will not be stretched if: <html:ul> <html:li>type="default" and its parent layout component is not stretching the panelBox (e.g. panelGroupLayout)</html:li> <html:li>type="flow"</html:li> </html:ul> </html:li> <html:li>The panelBox component will only stretch its children if it is being stretched by its parent (or if type="stretch"). If the children are being stretched but you don't want them to be stretched, simply wrap the children in a panelGroupLayout layout="scroll". </html:li> </html:ul> </section>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.DisclosureEvent	Apply Request Values Invoke Application	The disclosure event is delivered when a node is disclosed.
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.

Field Summary

static java.lang.String	BACKGROUND_DARK
static java.lang.String	BACKGROUND_DEFAULT
static org.apache.myfaces.trinidad.bean.PropertyKey	BACKGROUND_KEY
static java.lang.String	BACKGROUND_LIGHT
static java.lang.String	BACKGROUND_MEDIUM
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSURE_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static java.lang.String	HANDLE_DISCLOSURE_CLIENT
static org.apache.myfaces.trinidad.bean.PropertyKey	HANDLE_DISCLOSURE_KEY
static java.lang.String	HANDLE_DISCLOSURE_SERVER
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICON_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	IMMEDIATE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static java.lang.String	RAMP_CORE
static java.lang.String	RAMP_HIGHLIGHT
static org.apache.myfaces.trinidad.bean.PropertyKey	RAMP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_DISCLOSURE_KEY
static java.lang.String	SHOW_HEADER_ALWAYS
static java.lang.String	SHOW_HEADER_IF_NEEDED
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_HEADER_KEY
static java.lang.String	SHOW_HEADER_NEVER
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_KEY
static java.lang.String	TITLE_HALIGN_CENTER
static java.lang.String	TITLE_HALIGN_END
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_HALIGN_KEY
static java.lang.String	TITLE_HALIGN_LEFT
static java.lang.String	TITLE_HALIGN_RIGHT
static java.lang.String	TITLE_HALIGN_START
static java.lang.String	TOOLBAR_FACET
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static java.lang.String	TYPE_DEFAULT
static java.lang.String	TYPE_FLOW
static org.apache.myfaces.trinidad.bean.PropertyKey	TYPE_KEY
static java.lang.String	TYPE_STRETCH
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

	RichPanelBox() Construct an instance of the RichPanelBox.
protected	RichPanelBox(java.lang.String rendererType) Construct an instance of the RichPanelBox.

Method Summary

void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
void	addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Adds a disclosure listener.
void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getBackground() Gets the appearance type of the content container.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getContentStyle() Gets the inline style of the content region.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getDefaultEventName()
javax.el.MethodExpression	getDisclosureListener() Gets a method reference to a disclosure listener
org.apache.myfaces.trinidad.event.DisclosureListener[]	getDisclosureListeners() Returns an array of attached disclosure listeners.
java.lang.String[]	getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getHandleDisclosure() Gets How the disclosure is handled.
java.lang.String	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
java.lang.String	getIcon() Gets the URI of an image to be displayed in the panelBox header.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String[]	getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
java.lang.String	getRamp() Gets the appearance type of the content container.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getShowHeader() Gets the display strategy for the panelBox's header.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getText() Gets the header text of the panelBox.
java.lang.String	getTitleHalign() Gets the alignment of the text and icon within the title bar.
javax.faces.component.UIComponent	getToolbar() Header location for toolbar content.
java.lang.String	getType() Gets how the panelBox will handle geometry management.
java.util.Set<java.lang.String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isDisclosed() Gets whether or not to disclose the children
boolean	isImmediate() Gets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
boolean	isShowDisclosure() Gets Whether or not to render the disclosure icon.
boolean	isVisible() Gets the visibility of the component.
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent e)
void	removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener) Removes a disclosure listener.
void	setBackground(java.lang.String background) Sets the appearance type of the content container.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentStyle(java.lang.String contentStyle) Sets the inline style of the content region.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisclosed(boolean disclosed) Sets whether or not to disclose the children
void	setDisclosureListener(javax.el.MethodExpression disclosureListener) Sets a method reference to a disclosure listener
void	setDontPersist(java.lang.String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setHandleDisclosure(java.lang.String handleDisclosure) Sets How the disclosure is handled.
void	setHelpTopicId(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setIcon(java.lang.String icon) Sets the URI of an image to be displayed in the panelBox header.
void	setImmediate(boolean immediate) Sets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPersist(java.lang.String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setRamp(java.lang.String ramp) Sets the appearance type of the content container.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setShowDisclosure(boolean showDisclosure) Sets Whether or not to render the disclosure icon.
void	setShowHeader(java.lang.String showHeader) Sets the display strategy for the panelBox's header.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setText(java.lang.String text) Sets the header text of the panelBox.
void	setTitleHalign(java.lang.String titleHalign) Sets the alignment of the text and icon within the title bar.
void	setToolbar(javax.faces.component.UIComponent toolbarFacet) Header location for toolbar content.
void	setType(java.lang.String type) Sets how the panelBox will handle geometry management.
void	setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.
protected boolean	visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HANDLE_DISCLOSURE_CLIENT

public static final java.lang.String HANDLE_DISCLOSURE_CLIENT

See Also:

Constant Field Values

HANDLE_DISCLOSURE_SERVER

public static final java.lang.String HANDLE_DISCLOSURE_SERVER

See Also:

Constant Field Values

TYPE_DEFAULT

public static final java.lang.String TYPE_DEFAULT

See Also:

Constant Field Values

TYPE_FLOW

public static final java.lang.String TYPE_FLOW

See Also:

Constant Field Values

TYPE_STRETCH

public static final java.lang.String TYPE_STRETCH

See Also:

Constant Field Values

SHOW_HEADER_NEVER

public static final java.lang.String SHOW_HEADER_NEVER

See Also:

Constant Field Values

SHOW_HEADER_IF_NEEDED

public static final java.lang.String SHOW_HEADER_IF_NEEDED

See Also:

Constant Field Values

SHOW_HEADER_ALWAYS

public static final java.lang.String SHOW_HEADER_ALWAYS

See Also:

Constant Field Values

RAMP_CORE

public static final java.lang.String RAMP_CORE

See Also:

Constant Field Values

RAMP_HIGHLIGHT

public static final java.lang.String RAMP_HIGHLIGHT

See Also:

Constant Field Values

BACKGROUND_LIGHT

public static final java.lang.String BACKGROUND_LIGHT

See Also:

Constant Field Values

BACKGROUND_MEDIUM

public static final java.lang.String BACKGROUND_MEDIUM

See Also:

Constant Field Values

BACKGROUND_DARK

public static final java.lang.String BACKGROUND_DARK

See Also:

Constant Field Values

BACKGROUND_DEFAULT

public static final java.lang.String BACKGROUND_DEFAULT

See Also:

Constant Field Values

TITLE_HALIGN_START

public static final java.lang.String TITLE_HALIGN_START

See Also:

Constant Field Values

TITLE_HALIGN_END

public static final java.lang.String TITLE_HALIGN_END

See Also:

Constant Field Values

TITLE_HALIGN_CENTER

public static final java.lang.String TITLE_HALIGN_CENTER

See Also:

Constant Field Values

TITLE_HALIGN_LEFT

public static final java.lang.String TITLE_HALIGN_LEFT

See Also:

Constant Field Values

TITLE_HALIGN_RIGHT

public static final java.lang.String TITLE_HALIGN_RIGHT

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

DISCLOSED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

DISCLOSURE_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSURE_LISTENER_KEY

IMMEDIATE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY

PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY

DONT_PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY

SHOW_DISCLOSURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_DISCLOSURE_KEY

HANDLE_DISCLOSURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HANDLE_DISCLOSURE_KEY

TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY

TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY

SHOW_HEADER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_HEADER_KEY

RAMP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RAMP_KEY

BACKGROUND_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BACKGROUND_KEY

ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

TITLE_HALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_HALIGN_KEY

TOOLBAR_FACET

public static final java.lang.String TOOLBAR_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichPanelBox

public RichPanelBox()

Construct an instance of the RichPanelBox.

RichPanelBox

protected RichPanelBox(java.lang.String rendererType)

Construct an instance of the RichPanelBox.

Method Detail

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class org.apache.myfaces.trinidad.component.UIXComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class org.apache.myfaces.trinidad.component.UIXComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class org.apache.myfaces.trinidad.component.UIXComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

visitChildren

protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext,
                                javax.faces.component.visit.VisitCallback callback)

Overrides:

visitChildren in class org.apache.myfaces.trinidad.component.UIXComponent

getToolbar

public final javax.faces.component.UIComponent getToolbar()

Header location for toolbar content. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)

Header location for toolbar content. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets 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 are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets 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 are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

isDisclosed

public final boolean isDisclosed()

Gets whether or not to disclose the children

Returns:

the new disclosed value

setDisclosed

public final void setDisclosed(boolean disclosed)

Sets whether or not to disclose the children

Parameters:

disclosed - the new disclosed value

getHelpTopicId

public final java.lang.String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider. Note that for this component dynamic help information is shown on the header and will only be shown when the header is shown.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)

Sets the id used to look up a topic in a helpProvider. Note that for this component dynamic help information is shown on the header and will only be shown when the header is shown.

Parameters:

helpTopicId - the new helpTopicId value

getDisclosureListener

public final javax.el.MethodExpression getDisclosureListener()

Gets a method reference to a disclosure listener

Returns:

the new disclosureListener value

setDisclosureListener

public final void setDisclosureListener(javax.el.MethodExpression disclosureListener)

Sets a method reference to a disclosure listener

Parameters:

disclosureListener - the new disclosureListener value

isImmediate

public final boolean isImmediate()

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

Returns:

the new immediate value

setImmediate

public final void setImmediate(boolean immediate)

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

Parameters:

immediate - the new immediate value

getPersist

public final java.lang.String[] getPersist()

Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Parameters:

dontPersist - the new dontPersist value

isShowDisclosure

public final boolean isShowDisclosure()

Gets Whether or not to render the disclosure icon. If this is set to false all other attributes that deal with disclosure are ignored.

Returns:

the new showDisclosure value

setShowDisclosure

public final void setShowDisclosure(boolean showDisclosure)

Sets Whether or not to render the disclosure icon. If this is set to false all other attributes that deal with disclosure are ignored.

Parameters:

showDisclosure - the new showDisclosure value

getHandleDisclosure

public final java.lang.String getHandleDisclosure()

Gets How the disclosure is handled. If client side, the disclosure state of the client component is not propagated to the server until another event triggers a round trip to the server.

Returns:

the new handleDisclosure value

setHandleDisclosure

public final void setHandleDisclosure(java.lang.String handleDisclosure)

Sets How the disclosure is handled. If client side, the disclosure state of the client component is not propagated to the server until another event triggers a round trip to the server.

Parameters:

handleDisclosure - the new handleDisclosure value

getText

public final java.lang.String getText()

Gets the header text of the panelBox.

Returns:

the new text value

setText

public final void setText(java.lang.String text)

Sets the header text of the panelBox.

Parameters:

text - the new text value

getType

public final java.lang.String getType()

Gets how the panelBox will handle geometry management. Options are:

• default - either flow or stretch, depending on the container the panelBox is inside
• flow - does not support being stretched and will not attempt to stretch the children; the height of the panelBox will be determined by the browser based on the children
• stretch - supports being stretched and will attempt to stretch the sole child or will wrap the children without stretching them; the height of the panelBox is in no way determined by the children. If helpTopicId is also specified, no instruction text will be displayed when stretched because there would be no space allocated for it.

Returns:

the new type value

setType

public final void setType(java.lang.String type)

Sets how the panelBox will handle geometry management. Options are:

• default - either flow or stretch, depending on the container the panelBox is inside
• flow - does not support being stretched and will not attempt to stretch the children; the height of the panelBox will be determined by the browser based on the children
• stretch - supports being stretched and will attempt to stretch the sole child or will wrap the children without stretching them; the height of the panelBox is in no way determined by the children. If helpTopicId is also specified, no instruction text will be displayed when stretched because there would be no space allocated for it.

Parameters:

type - the new type value

getShowHeader

public final java.lang.String getShowHeader()

Gets the display strategy for the panelBox's header. It should be either "never", "ifNeeded", or "always". No header will be shown if the value is "never". If the value is "always", the header will always be shown. This value is useful when the panelBox has a drag source attached or when you want the user to have access to the disclosure control. If the value is "ifNeeded", the header will only be shown if the "icon" or "text" properties are set, if the "toolbar" facet is populated, or if the panelBox has a drag source attached. The default is "ifNeeded" for backwards compatibility

Returns:

the new showHeader value

setShowHeader

public final void setShowHeader(java.lang.String showHeader)

Sets the display strategy for the panelBox's header. It should be either "never", "ifNeeded", or "always". No header will be shown if the value is "never". If the value is "always", the header will always be shown. This value is useful when the panelBox has a drag source attached or when you want the user to have access to the disclosure control. If the value is "ifNeeded", the header will only be shown if the "icon" or "text" properties are set, if the "toolbar" facet is populated, or if the panelBox has a drag source attached. The default is "ifNeeded" for backwards compatibility

Parameters:

showHeader - the new showHeader value

getRamp

public final java.lang.String getRamp()

Gets the appearance type of the content container. It should be either "core" or "highlight"

Returns:

the new ramp value

setRamp

public final void setRamp(java.lang.String ramp)

Sets the appearance type of the content container. It should be either "core" or "highlight"

Parameters:

ramp - the new ramp value

getBackground

public final java.lang.String getBackground()

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

Returns:

the new background value

setBackground

public final void setBackground(java.lang.String background)

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

Parameters:

background - the new background value

getIcon

public final java.lang.String getIcon()

Gets the URI of an image to be displayed in the panelBox header. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Returns:

the new icon value

setIcon

public final void setIcon(java.lang.String icon)

Sets the URI of an image to be displayed in the panelBox header. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Parameters:

icon - the new icon value

getContentStyle

public final java.lang.String getContentStyle()

Gets the inline style of the content region.

Returns:

the new contentStyle value

setContentStyle

public final void setContentStyle(java.lang.String contentStyle)

Sets the inline style of the content region.

Parameters:

contentStyle - the new contentStyle value

getTitleHalign

public final java.lang.String getTitleHalign()

Gets the alignment of the text and icon within the title bar. Supported values are:

• "start": left side of the bar in left-to-right mode, right of the bar in right-to-left mode (this is the default)
• "end": right side of the bar in left-to-right mode, left side of the bar in right-to-left mode
• "center": in the center
• "left": left side of the bar
• "right": right side of the bar

This value is ignored if the toolbar facet is defined.

Returns:

the new titleHalign value

setTitleHalign

public final void setTitleHalign(java.lang.String titleHalign)

Sets the alignment of the text and icon within the title bar. Supported values are:

• "start": left side of the bar in left-to-right mode, right of the bar in right-to-left mode (this is the default)
• "end": right side of the bar in left-to-right mode, left side of the bar in right-to-left mode
• "center": in the center
• "left": left side of the bar
• "right": right side of the bar

This value is ignored if the toolbar facet is defined.

Parameters:

titleHalign - the new titleHalign value

addDisclosureListener

public final void addDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)

Adds a disclosure listener.

Parameters:

listener - the disclosure listener to add

removeDisclosureListener

public final void removeDisclosureListener(org.apache.myfaces.trinidad.event.DisclosureListener listener)

Removes a disclosure listener.

Parameters:

listener - the disclosure listener to remove

getDisclosureListeners

public final org.apache.myfaces.trinidad.event.DisclosureListener[] getDisclosureListeners()

Returns an array of attached disclosure listeners.

Returns:

an array of attached disclosure listeners.

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXPanel

Skip navigation links