Skip navigation links

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

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

All Implemented Interfaces:

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

public class RichDecorativeBox

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

implements javax.faces.component.behavior.ClientBehaviorHolder

The decorativeBox component can be used to apply a bordered look to its children (i.e. rounded corners). It also supports changing of the rendered theme of its children, so can act as a look and feel transition between areas on a page. For example, a page that has a dark background for its template can use the decorative box to transition to a white background for its main area. This component stretches the child component in the center facet to fill all of available space. It is bordered by eight styled areas that are controlled using skinning keys. The areas listed below are documented in the skinning documentation: <html:ul> <html:li>top-start</html:li> <html:li>top</html:li> <html:li>top-end</html:li> <html:li>start</html:li> <html:li>end</html:li> <html:li>bottom-start</html:li> <html:li>bottom</html:li> <html:li>bottom-end</html:li> </html:ul> The height of the top area of the component depends on whether or not a component has been put into the top facet. When the facet is set, the topHeight attribute is used to specify the size the content should occupy. Without a component in the top facet, the -tr-height skin property will be used to determine the height. See the skinning keys documentation for more information on the available skinning keys and properties for the decorative box component. <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout if the dimensionsFrom attribute of this decorativeBox is set to "parent".</html:li> <html:li>This component uses <f:facet name="top"> and <f:facet name="center"> to organize content into each box. Examples of child components that can be stretched inside of these facets include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="children" for the decorativeBox to be as tall as the children. When using this "children" setting, the topHeight attribute will still be honored (unless percent units are specified) but any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the decorativeBox get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin.</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the decorativeBox is being stretched by its parent.</html:li> </html:ul> </section>

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.

Field Summary

static String	CENTER_FACET
static String	CENTER_LANDMARK_BANNER
static String	CENTER_LANDMARK_COMPLEMENTARY
static String	CENTER_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	CENTER_LANDMARK_KEY
static String	CENTER_LANDMARK_MAIN
static String	CENTER_LANDMARK_NAVIGATION
static String	CENTER_LANDMARK_NONE
static String	CENTER_LANDMARK_SEARCH
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 String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static String	DIMENSIONS_FROM_AUTO
static String	DIMENSIONS_FROM_CHILDREN
static org.apache.myfaces.trinidad.bean.PropertyKey	DIMENSIONS_FROM_KEY
static String	DIMENSIONS_FROM_PARENT
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	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THEME_KEY
static String	TOP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	TOP_HEIGHT_KEY
static String	TOP_LANDMARK_BANNER
static String	TOP_LANDMARK_COMPLEMENTARY
static String	TOP_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	TOP_LANDMARK_KEY
static String	TOP_LANDMARK_MAIN
static String	TOP_LANDMARK_NAVIGATION
static String	TOP_LANDMARK_NONE
static String	TOP_LANDMARK_SEARCH
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
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

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

Constructor Summary

	RichDecorativeBox() Construct an instance of the RichDecorativeBox.
protected	RichDecorativeBox(String rendererType) Construct an instance of the RichDecorativeBox.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getCenter() Content to be stretched in the center of the layout.
String	getCenterLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the center facet.
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String	getDimensionsFrom() Gets
Collection<String>	getEventNames()
String	getFamily()
String	getInlineStyle() Gets the CSS styles to use for this component.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
String	getTheme() Gets The component style theme to apply to this component.
javax.faces.component.UIComponent	getTop() Content to be rendered above the center facet.
String	getTopHeight() Gets the height of the top facet specified as a CSS length.
String	getTopLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the top facet.
Set<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	isVisible() Gets the visibility of the component.
void	setCenter(javax.faces.component.UIComponent centerFacet) Content to be stretched in the center of the layout.
void	setCenterLandmark(String centerLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the center facet.
void	setClientAttributes(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	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDimensionsFrom(String dimensionsFrom) Sets
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setTheme(String theme) Sets The component style theme to apply to this component.
void	setTop(javax.faces.component.UIComponent topFacet) Content to be rendered above the center facet.
void	setTopHeight(String topHeight) Sets the height of the top facet specified as a CSS length.
void	setTopLandmark(String topLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the top facet.
void	setUnsecure(Set<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.

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, 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, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LANDMARK_NONE

public static final String TOP_LANDMARK_NONE

See Also:

Constant Field Values

TOP_LANDMARK_BANNER

public static final String TOP_LANDMARK_BANNER

See Also:

Constant Field Values

TOP_LANDMARK_COMPLEMENTARY

public static final String TOP_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

TOP_LANDMARK_CONTENTINFO

public static final String TOP_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

TOP_LANDMARK_MAIN

public static final String TOP_LANDMARK_MAIN

See Also:

Constant Field Values

TOP_LANDMARK_NAVIGATION

public static final String TOP_LANDMARK_NAVIGATION

See Also:

Constant Field Values

TOP_LANDMARK_SEARCH

public static final String TOP_LANDMARK_SEARCH

See Also:

Constant Field Values

CENTER_LANDMARK_NONE

public static final String CENTER_LANDMARK_NONE

See Also:

Constant Field Values

CENTER_LANDMARK_BANNER

public static final String CENTER_LANDMARK_BANNER

See Also:

Constant Field Values

CENTER_LANDMARK_COMPLEMENTARY

public static final String CENTER_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

CENTER_LANDMARK_CONTENTINFO

public static final String CENTER_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

CENTER_LANDMARK_MAIN

public static final String CENTER_LANDMARK_MAIN

See Also:

Constant Field Values

CENTER_LANDMARK_NAVIGATION

public static final String CENTER_LANDMARK_NAVIGATION

See Also:

Constant Field Values

CENTER_LANDMARK_SEARCH

public static final String CENTER_LANDMARK_SEARCH

See Also:

Constant Field Values

DIMENSIONS_FROM_AUTO

public static final String DIMENSIONS_FROM_AUTO

See Also:

Constant Field Values

DIMENSIONS_FROM_CHILDREN

public static final String DIMENSIONS_FROM_CHILDREN

See Also:

Constant Field Values

DIMENSIONS_FROM_PARENT

public static final String DIMENSIONS_FROM_PARENT

See Also:

Constant Field Values

TYPE

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

TOP_HEIGHT_KEY

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

TOP_LANDMARK_KEY

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

CENTER_LANDMARK_KEY

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

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

THEME_KEY

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

DIMENSIONS_FROM_KEY

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

CENTER_FACET

public static final String CENTER_FACET

See Also:

Constant Field Values

TOP_FACET

public static final String TOP_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichDecorativeBox

public RichDecorativeBox()

Construct an instance of the RichDecorativeBox.

RichDecorativeBox

protected RichDecorativeBox(String rendererType)

Construct an instance of the RichDecorativeBox.

Method Detail

getCenter

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

Content to be stretched in the center of the layout. Must be only one component, multiple facet components in facelets are not supported by this facet.

setCenter

public final void setCenter(javax.faces.component.UIComponent centerFacet)

Content to be stretched in the center of the layout. Must be only one component, multiple facet components in facelets are not supported by this facet.

getTop

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

Content to be rendered above the center facet. If present and topHeight not specified, the height will be 50px. Must be only one component, multiple facet components in facelets are not supported by this facet.

setTop

public final void setTop(javax.faces.component.UIComponent topFacet)

Content to be rendered above the center facet. If present and topHeight not specified, the height will be 50px. Must be only one component, multiple facet components in facelets are not supported by this facet.

getTopHeight

public final String getTopHeight()

Gets the height of the top facet specified as a CSS length. If dimensionsFrom resolves to "children", percent units are not allowed and the default value is used instead.

Returns:

the new topHeight value

setTopHeight

public final void setTopHeight(String topHeight)

Sets the height of the top facet specified as a CSS length. If dimensionsFrom resolves to "children", percent units are not allowed and the default value is used instead.

Parameters:

topHeight - the new topHeight value

getTopLandmark

public final String getTopLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the top facet.

Returns:

the new topLandmark value

setTopLandmark

public final void setTopLandmark(String topLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the top facet.

Parameters:

topLandmark - the new topLandmark value

getCenterLandmark

public final String getCenterLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the center facet.

Returns:

the new centerLandmark value

setCenterLandmark

public final void setCenterLandmark(String centerLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the center facet.

Parameters:

centerLandmark - the new centerLandmark value

getInlineStyle

public final 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(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 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(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 String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<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(Set<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 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(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 Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final 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(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

getTheme

public final String getTheme()

Gets The component style theme to apply to this component. Themes are cascaded down through all child components. All HTML elements that are rendered by a rich component within a themed component will have the theme applied to its DOM. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme (theme="") or a theme of "default" will remove the current theme (from the component as well as the children of the current component), and a value of "inherit", null (specified as theme="#{null}"), or not setting a theme will use the current theme. Skins are the sources of the the themes. Some skins may have no themed definitions. Suggested theme names include "dark", "medium" and "light".

Returns:

the new theme value

setTheme

public final void setTheme(String theme)

Sets The component style theme to apply to this component. Themes are cascaded down through all child components. All HTML elements that are rendered by a rich component within a themed component will have the theme applied to its DOM. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme (theme="") or a theme of "default" will remove the current theme (from the component as well as the children of the current component), and a value of "inherit", null (specified as theme="#{null}"), or not setting a theme will use the current theme. Skins are the sources of the the themes. Some skins may have no themed definitions. Suggested theme names include "dark", "medium" and "light".

Parameters:

theme - the new theme value

getDimensionsFrom

public final String getDimensionsFrom()

Gets

determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:

• auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
• children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.
• parent - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Returns:

the new dimensionsFrom value

setDimensionsFrom

public final void setDimensionsFrom(String dimensionsFrom)

Sets

determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:

• auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
• children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.
• parent - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Parameters:

dimensionsFrom - the new dimensionsFrom value

getDefaultEventName

public String getDefaultEventName()

Specified by:

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

Overrides:

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

getEventNames

public Collection<String> getEventNames()

Specified by:

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

getClientBehaviors

public Map<String,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(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 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