Skip navigation links

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

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

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 RichPanelSplitter

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

implements javax.faces.component.behavior.ClientBehaviorHolder

<html:p> PanelSplitters are used to divide a region into two parts with a repositionable divider. The two parts are identified as the "first" facet and the "second" facet. If the contained component supports it, the contents of a section will stretch to fill up all available space in that section. The panel splitter can be adjusted with the mouse, by pressing a collapse button, or by use of the arrow keys when the splitter is selected. A panel splitter can split horizontally or vertically based on the orientation attribute. With focus on the page, pressing Ctrl+Alt+P will move to the next splitter collapse/restore button. Subsequently pressing Ctrl+Alt+P will then cycle focus among the splitter buttons on the page. </html:p> <section name="Errors_on_components_in_collapsed_panes"> <html:p> If a splitter's collapsed pane contains a component that has an error, e.g. a required input with no value, no error will be reported to the user. </html:p> </section> <section name="Printable_Pages"> <html:p> If you use an <af:showPrintablePageBehavior> within one of the panes of the splitter, only that pane will be present for printing when the user activates that behavior. If the behavior is outside of the splitter, the printed result will be roughly in line with the normal layout, which may mean that not all content will be visible. It's therefore encouraged to support printing from within any pane of a splitter where printing is important. </html:p> </section> <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 panelSplitter is set to "parent".</html:li> <html:li>This component uses <f:facet name="first"> and <f:facet name="second"> to organize content into each splitter panel. 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 panelSplitter to be as tall as the children. When using this "children" setting, if orientation="vertical" then the contents of the collapsible panel will not contribute to the size of the panelSplitter since that facet's contents must be constrained to the size specified in splitterPosition. Also, any height assignment (e.g. inlineStyle or styleClass) on the panelSplitter 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 panelSplitter 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 panelSplitter 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 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 org.apache.myfaces.trinidad.bean.PropertyKey	COLLAPSED_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	DISABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static String	FIRST_BORDER_ALL
static org.apache.myfaces.trinidad.bean.PropertyKey	FIRST_BORDER_KEY
static String	FIRST_BORDER_NONE
static String	FIRST_BORDER_SKIN
static String	FIRST_FACET
static String	FIRST_LANDMARK_BANNER
static String	FIRST_LANDMARK_COMPLEMENTARY
static String	FIRST_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	FIRST_LANDMARK_KEY
static String	FIRST_LANDMARK_MAIN
static String	FIRST_LANDMARK_NAVIGATION
static String	FIRST_LANDMARK_NONE
static String	FIRST_LANDMARK_SEARCH
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static String	ORIENTATION_HORIZONTAL
static org.apache.myfaces.trinidad.bean.PropertyKey	ORIENTATION_KEY
static String	ORIENTATION_VERTICAL
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITIONED_FROM_END_KEY
static String	SECOND_BORDER_ALL
static org.apache.myfaces.trinidad.bean.PropertyKey	SECOND_BORDER_KEY
static String	SECOND_BORDER_NONE
static String	SECOND_BORDER_SKIN
static String	SECOND_FACET
static String	SECOND_LANDMARK_BANNER
static String	SECOND_LANDMARK_COMPLEMENTARY
static String	SECOND_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	SECOND_LANDMARK_KEY
static String	SECOND_LANDMARK_MAIN
static String	SECOND_LANDMARK_NAVIGATION
static String	SECOND_LANDMARK_NONE
static String	SECOND_LANDMARK_SEARCH
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SPLITTER_POSITION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
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

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

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
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
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.
Collection<String>	getEventNames()
String	getFamily()
javax.faces.component.UIComponent	getFirst() The first pane of this splitter.
String	getFirstBorder() Gets Specifies how you want borders to be displayed around the contents of the "first" facet.
String	getFirstLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the first facet.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getOrientation() Gets whether a horizontal or vertical split is created.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
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.
javax.faces.component.UIComponent	getSecond() The second pane of this splitter.
String	getSecondBorder() Gets Specifies how you want borders to be displayed around the contents of the "second" facet.
String	getSecondLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the second facet.
String	getShortDesc() Gets the short description of the component.
int	getSplitterPosition() Gets the initial position of the repositionable divider.
String	getStyleClass() Gets a CSS style class to use for this component.
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	isCollapsed() Gets whether the splitter is in a collapsed state.
boolean	isDisabled() Gets an attribute which if set to "true", the component becomes non-interactive.
boolean	isPositionedFromEnd() Gets an attribute which if set to "false" (the default), the initial position of the repositionable divider is measured from the start side (the top or start).If the value is "true", the initial position of the repositionable divider is measured from the end side (the bottom or end).
boolean	isVisible() Gets the visibility of the component.
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	setCollapsed(boolean collapsed) Sets whether the splitter is in a collapsed state.
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	setDisabled(boolean disabled) Sets an attribute which if set to "true", the component becomes non-interactive.
void	setDontPersist(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	setFirst(javax.faces.component.UIComponent firstFacet) The first pane of this splitter.
void	setFirstBorder(String firstBorder) Sets Specifies how you want borders to be displayed around the contents of the "first" facet.
void	setFirstLandmark(String firstLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the first facet.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setOrientation(String orientation) Sets whether a horizontal or vertical split is created.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPersist(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	setPositionedFromEnd(boolean positionedFromEnd) Sets an attribute which if set to "false" (the default), the initial position of the repositionable divider is measured from the start side (the top or start).If the value is "true", the initial position of the repositionable divider is measured from the end side (the bottom or end).
void	setSecond(javax.faces.component.UIComponent secondFacet) The second pane of this splitter.
void	setSecondBorder(String secondBorder) Sets Specifies how you want borders to be displayed around the contents of the "second" facet.
void	setSecondLandmark(String secondLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the second facet.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setSplitterPosition(int splitterPosition) Sets the initial position of the repositionable divider.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
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

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

ORIENTATION_HORIZONTAL

public static final String ORIENTATION_HORIZONTAL

See Also:

Constant Field Values

ORIENTATION_VERTICAL

public static final String ORIENTATION_VERTICAL

See Also:

Constant Field Values

FIRST_BORDER_SKIN

public static final String FIRST_BORDER_SKIN

See Also:

Constant Field Values

FIRST_BORDER_ALL

public static final String FIRST_BORDER_ALL

See Also:

Constant Field Values

FIRST_BORDER_NONE

public static final String FIRST_BORDER_NONE

See Also:

Constant Field Values

SECOND_BORDER_SKIN

public static final String SECOND_BORDER_SKIN

See Also:

Constant Field Values

SECOND_BORDER_ALL

public static final String SECOND_BORDER_ALL

See Also:

Constant Field Values

SECOND_BORDER_NONE

public static final String SECOND_BORDER_NONE

See Also:

Constant Field Values

FIRST_LANDMARK_NONE

public static final String FIRST_LANDMARK_NONE

See Also:

Constant Field Values

FIRST_LANDMARK_BANNER

public static final String FIRST_LANDMARK_BANNER

See Also:

Constant Field Values

FIRST_LANDMARK_COMPLEMENTARY

public static final String FIRST_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

FIRST_LANDMARK_CONTENTINFO

public static final String FIRST_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

FIRST_LANDMARK_MAIN

public static final String FIRST_LANDMARK_MAIN

See Also:

Constant Field Values

FIRST_LANDMARK_NAVIGATION

public static final String FIRST_LANDMARK_NAVIGATION

See Also:

Constant Field Values

FIRST_LANDMARK_SEARCH

public static final String FIRST_LANDMARK_SEARCH

See Also:

Constant Field Values

SECOND_LANDMARK_NONE

public static final String SECOND_LANDMARK_NONE

See Also:

Constant Field Values

SECOND_LANDMARK_BANNER

public static final String SECOND_LANDMARK_BANNER

See Also:

Constant Field Values

SECOND_LANDMARK_COMPLEMENTARY

public static final String SECOND_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

SECOND_LANDMARK_CONTENTINFO

public static final String SECOND_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

SECOND_LANDMARK_MAIN

public static final String SECOND_LANDMARK_MAIN

See Also:

Constant Field Values

SECOND_LANDMARK_NAVIGATION

public static final String SECOND_LANDMARK_NAVIGATION

See Also:

Constant Field Values

SECOND_LANDMARK_SEARCH

public static final String SECOND_LANDMARK_SEARCH

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

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

DIMENSIONS_FROM_KEY

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

DISABLED_KEY

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

ORIENTATION_KEY

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

POSITIONED_FROM_END_KEY

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

SPLITTER_POSITION_KEY

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

COLLAPSED_KEY

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

FIRST_BORDER_KEY

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

SECOND_BORDER_KEY

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

FIRST_LANDMARK_KEY

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

SECOND_LANDMARK_KEY

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

FIRST_FACET

public static final String FIRST_FACET

See Also:

Constant Field Values

SECOND_FACET

public static final String SECOND_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

RichPanelSplitter

public RichPanelSplitter()

Construct an instance of the RichPanelSplitter.

RichPanelSplitter

protected RichPanelSplitter(String rendererType)

Construct an instance of the RichPanelSplitter.

Method Detail

getFirst

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

The first pane of this splitter. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

setFirst

public final void setFirst(javax.faces.component.UIComponent firstFacet)

The first pane of this splitter. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

getSecond

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

The second pane of this splitter. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

setSecond

public final void setSecond(javax.faces.component.UIComponent secondFacet)

The second pane of this splitter. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

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

getPersist

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

getDimensionsFrom

public final String getDimensionsFrom()

Gets

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

• auto - either "children" or "parent", depending on the container the panelSplitter is inside; if the panelSplitter is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
• children - the panelSplitter will get its dimensions from the children (note that if orientation="vertical" then the contents of the collapsible panel will not contribute to the size of the panelSplitter since that facet's contents must be constrained to the size specified in splitterPosition). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelSplitter must be omitted or else there would be a competing assignment for how tall the component will be.
• parent (the default) - the panelSplitter 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.

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 panelSplitter come from:

• auto - either "children" or "parent", depending on the container the panelSplitter is inside; if the panelSplitter is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
• children - the panelSplitter will get its dimensions from the children (note that if orientation="vertical" then the contents of the collapsible panel will not contribute to the size of the panelSplitter since that facet's contents must be constrained to the size specified in splitterPosition). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelSplitter must be omitted or else there would be a competing assignment for how tall the component will be.
• parent (the default) - the panelSplitter 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.

Parameters:

dimensionsFrom - the new dimensionsFrom value

isDisabled

public final boolean isDisabled()

Gets an attribute which if set to "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets an attribute which if set to "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Parameters:

disabled - the new disabled value

getOrientation

public final String getOrientation()

Gets whether a horizontal or vertical split is created. The string literal value of "horizontal" indicates that the splitter panes will be side-by-side, and a string literal value of "vertical" indicates the panes will be on top of each other.

Returns:

the new orientation value

setOrientation

public final void setOrientation(String orientation)

Sets whether a horizontal or vertical split is created. The string literal value of "horizontal" indicates that the splitter panes will be side-by-side, and a string literal value of "vertical" indicates the panes will be on top of each other.

Parameters:

orientation - the new orientation value

isPositionedFromEnd

public final boolean isPositionedFromEnd()

Gets an attribute which if set to "false" (the default), the initial position of the repositionable divider is measured from the start side (the top or start).If the value is "true", the initial position of the repositionable divider is measured from the end side (the bottom or end).

Returns:

the new positionedFromEnd value

setPositionedFromEnd

public final void setPositionedFromEnd(boolean positionedFromEnd)

Sets an attribute which if set to "false" (the default), the initial position of the repositionable divider is measured from the start side (the top or start).If the value is "true", the initial position of the repositionable divider is measured from the end side (the bottom or end).

Parameters:

positionedFromEnd - the new positionedFromEnd value

getSplitterPosition

public final int getSplitterPosition()

Gets the initial position of the repositionable divider. The panelSplitter separates two areas with a separator. The user may drag this separator to adjust how much space is allocated for each area. This attribute specifies the number of pixels for the width or height (depending on the orientation) for one of the areas and the other area gets the remaining space. The positionedFromEnd attribute determines which area is sized and which area gets the remaining space.

Returns:

the new splitterPosition value

setSplitterPosition

public final void setSplitterPosition(int splitterPosition)

Sets the initial position of the repositionable divider. The panelSplitter separates two areas with a separator. The user may drag this separator to adjust how much space is allocated for each area. This attribute specifies the number of pixels for the width or height (depending on the orientation) for one of the areas and the other area gets the remaining space. The positionedFromEnd attribute determines which area is sized and which area gets the remaining space.

Parameters:

splitterPosition - the new splitterPosition value

isCollapsed

public final boolean isCollapsed()

Gets whether the splitter is in a collapsed state. When the splitter is collapsed (collapsed="true") and the splitter is positioned from the beginning (positionedFromEnd="false"), the first pane is hidden such that the second pane stretches to fill all available space. When the splitter is positioned from the end (positionedFromEnd="true"), collapsing the splitter hides the second pane. By default collapse is "false", which means that both panes are displayed.

Returns:

the new collapsed value

setCollapsed

public final void setCollapsed(boolean collapsed)

Sets whether the splitter is in a collapsed state. When the splitter is collapsed (collapsed="true") and the splitter is positioned from the beginning (positionedFromEnd="false"), the first pane is hidden such that the second pane stretches to fill all available space. When the splitter is positioned from the end (positionedFromEnd="true"), collapsing the splitter hides the second pane. By default collapse is "false", which means that both panes are displayed.

Parameters:

collapsed - the new collapsed value

getFirstBorder

public final String getFirstBorder()

Gets Specifies how you want borders to be displayed around the contents of the "first" facet. The "first" facet contents will have a border surrounding it if either this value is set to "all" or if set to "skin" and the active skin's "-tr-first-border" property is set "all". The "first" facet contents will not have a border surrounding it if either this value is set to "none" or if set to "skin" and the active skin's "-tr-first-border" property is set "none". The default value is "skin". It is important to note that this attribute (just like inlineStyle) can easily be abused. More times than not, you should not use this attribute because by using it, you are likely optimizing your page design for a specific skin. You should only force the borders on or off for cases where the contents of the pane would either provide enough or not enough delineation among the 2 panes of your splitter. For example, forcing borders off on a splitter that surrounds your entire page or forcing borders on for a pane that needs emphasis. You may want to test your application in a variety of skins to see if your use of these kinds of styling attributes will prevent others from being able to display your application with custom skins.

Returns:

the new firstBorder value

setFirstBorder

public final void setFirstBorder(String firstBorder)

Sets Specifies how you want borders to be displayed around the contents of the "first" facet. The "first" facet contents will have a border surrounding it if either this value is set to "all" or if set to "skin" and the active skin's "-tr-first-border" property is set "all". The "first" facet contents will not have a border surrounding it if either this value is set to "none" or if set to "skin" and the active skin's "-tr-first-border" property is set "none". The default value is "skin". It is important to note that this attribute (just like inlineStyle) can easily be abused. More times than not, you should not use this attribute because by using it, you are likely optimizing your page design for a specific skin. You should only force the borders on or off for cases where the contents of the pane would either provide enough or not enough delineation among the 2 panes of your splitter. For example, forcing borders off on a splitter that surrounds your entire page or forcing borders on for a pane that needs emphasis. You may want to test your application in a variety of skins to see if your use of these kinds of styling attributes will prevent others from being able to display your application with custom skins.

Parameters:

firstBorder - the new firstBorder value

getSecondBorder

public final String getSecondBorder()

Gets Specifies how you want borders to be displayed around the contents of the "second" facet. The "second" facet contents will have a border surrounding it if either this value is set to "all" or if set to "skin" and the active skin's "-tr-second-border" property is set "all". The "second" facet contents will not have a border surrounding it if either this value is set to "none" or if set to "skin" and the active skin's "-tr-second-border" property is set "none". The default value is "skin". It is important to note that this attribute (just like inlineStyle) can easily be abused. More times than not, you should not use this attribute because by using it, you are likely optimizing your page design for a specific skin. You should only force the borders on or off for cases where the contents of the pane would either provide enough or not enough delineation among the 2 panes of your splitter. For example, forcing borders off on a splitter that surrounds your entire page or forcing borders on for a pane that needs emphasis. You may want to test your application in a variety of skins to see if your use of these kinds of styling attributes will prevent others from being able to display your application with custom skins.

Returns:

the new secondBorder value

setSecondBorder

public final void setSecondBorder(String secondBorder)

Sets Specifies how you want borders to be displayed around the contents of the "second" facet. The "second" facet contents will have a border surrounding it if either this value is set to "all" or if set to "skin" and the active skin's "-tr-second-border" property is set "all". The "second" facet contents will not have a border surrounding it if either this value is set to "none" or if set to "skin" and the active skin's "-tr-second-border" property is set "none". The default value is "skin". It is important to note that this attribute (just like inlineStyle) can easily be abused. More times than not, you should not use this attribute because by using it, you are likely optimizing your page design for a specific skin. You should only force the borders on or off for cases where the contents of the pane would either provide enough or not enough delineation among the 2 panes of your splitter. For example, forcing borders off on a splitter that surrounds your entire page or forcing borders on for a pane that needs emphasis. You may want to test your application in a variety of skins to see if your use of these kinds of styling attributes will prevent others from being able to display your application with custom skins.

Parameters:

secondBorder - the new secondBorder value

getFirstLandmark

public final String getFirstLandmark()

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

Returns:

the new firstLandmark value

setFirstLandmark

public final void setFirstLandmark(String firstLandmark)

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

Parameters:

firstLandmark - the new firstLandmark value

getSecondLandmark

public final String getSecondLandmark()

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

Returns:

the new secondLandmark value

setSecondLandmark

public final void setSecondLandmark(String secondLandmark)

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

Parameters:

secondLandmark - the new secondLandmark 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