Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.rich.component.rich
Class RichDocument

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXDocument
                  extended by oracle.adf.view.rich.component.rich.RichDocument

All Implemented Interfaces:
javax.faces.component.StateHolder
public class RichDocument
extends org.apache.myfaces.trinidad.component.UIXDocument

The document component creates each of the standard root elements of an HTML page: <html>, <body>, and <head>, but by abstracting away from those components, can be used in non-HTML pages as well. Only one document component per page is allowed. Documents must not be placed inside of page templates.

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 events 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 java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static org.apache.myfaces.trinidad.bean.PropertyKey FAILED_CONNECTION_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INITIAL_FOCUS_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZED_KEY
           
static java.lang.String META_CONTAINER_FACET
           
static org.apache.myfaces.trinidad.bean.PropertyKey ONUNLOAD_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static java.lang.String STATE_SAVING_CLIENT
           
static java.lang.String STATE_SAVING_DEFAULT
           
static org.apache.myfaces.trinidad.bean.PropertyKey STATE_SAVING_KEY
           
static java.lang.String STATE_SAVING_SERVER
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey THEME_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNCOMMITTED_DATA_WARNING_KEY
           
static java.lang.String UNCOMMITTED_DATA_WARNING_OFF
           
static java.lang.String UNCOMMITTED_DATA_WARNING_ON
           
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
bindings

 

Constructor Summary
  RichDocument()
          Construct an instance of the RichDocument.
protected RichDocument(java.lang.String rendererType)
          Construct an instance of the RichDocument.

 

Method Summary
 void addResource(PageResource resource)
          Adds a resource to the document component to be rendered inside the <head> element of the HTML page.
 java.util.List<PageResource> getAddedPageResources()
          Obtains a read-only collection of page resources that have been added to the document during this request if a partial request, or the full list of resources for a full-submit.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 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 getFailedConnectionText()
          Gets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
 java.lang.String getFamily()
           
 java.lang.String getInitialFocusId()
          Gets the id of the component that you want to have focus when the full page renders.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getMetaContainer()
          Content to be rendered as meta data inside the "head" section.
 java.lang.String getOnunload()
          Gets an onunload Javascript handler.
 java.util.List<PageResource> getPageResources()
          Obtains a read-only collection of all page resources associated with the document.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStateSaving()
          Gets Specify the state saving behavior for this page.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.lang.String getTheme()
          Gets The component style theme to apply to this component.
 java.lang.String getTitle()
          Gets the title of the document.
 java.lang.String getUncommittedDataWarning()
          Gets Specifies whether users should be warned about uncommitted data when navigating off the page or region.
 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 invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
           
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isMaximized()
          Gets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px.
 boolean isVisible()
          Gets the visibility of the component.
 java.lang.Object processSaveState(javax.faces.context.FacesContext context)
           
 void queueEvent(javax.faces.event.FacesEvent event)
           
 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 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 setFailedConnectionText(java.lang.String failedConnectionText)
          Sets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
 void setInitialFocusId(java.lang.String initialFocusId)
          Sets the id of the component that you want to have focus when the full page renders.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setMaximized(boolean maximized)
          Sets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px.
 void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
          Content to be rendered as meta data inside the "head" section.
 void setOnunload(java.lang.String onunload)
          Sets an onunload Javascript handler.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setStateSaving(java.lang.String stateSaving)
          Sets Specify the state saving behavior for this page.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setTheme(java.lang.String theme)
          Sets The component style theme to apply to this component.
 void setTitle(java.lang.String title)
          Sets the title of the document.
 void setUncommittedDataWarning(java.lang.String uncommittedDataWarning)
          Sets Specifies whether users should be warned about uncommitted data when navigating off the page or region.
 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.
 boolean visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext, org.apache.myfaces.trinidad.component.visit.VisitCallback callback)
           

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

STATE_SAVING_DEFAULT

public static final java.lang.String STATE_SAVING_DEFAULT
See Also:
Constant Field Values

STATE_SAVING_CLIENT

public static final java.lang.String STATE_SAVING_CLIENT
See Also:
Constant Field Values

STATE_SAVING_SERVER

public static final java.lang.String STATE_SAVING_SERVER
See Also:
Constant Field Values

UNCOMMITTED_DATA_WARNING_ON

public static final java.lang.String UNCOMMITTED_DATA_WARNING_ON
See Also:
Constant Field Values

UNCOMMITTED_DATA_WARNING_OFF

public static final java.lang.String UNCOMMITTED_DATA_WARNING_OFF
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

THEME_KEY

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

TITLE_KEY

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

STATE_SAVING_KEY

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

ONUNLOAD_KEY

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

INITIAL_FOCUS_ID_KEY

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

FAILED_CONNECTION_TEXT_KEY

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

MAXIMIZED_KEY

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

UNCOMMITTED_DATA_WARNING_KEY

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

META_CONTAINER_FACET

public static final java.lang.String META_CONTAINER_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

RichDocument

public RichDocument()
Construct an instance of the RichDocument.

RichDocument

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

Method Detail

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)
Overrides:
queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException
Overrides:
invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXComponentBase
Throws:
javax.faces.FacesException

visitTree

public boolean visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext,
                         org.apache.myfaces.trinidad.component.visit.VisitCallback callback)
Overrides:
visitTree in class org.apache.myfaces.trinidad.component.UIXComponent

addResource

public void addResource(PageResource resource)
Adds a resource to the document component to be rendered inside the <head> element of the HTML page. Should only be called during JSF component tree construction.
Parameters:
resource - The resource to add

getAddedPageResources

public java.util.List<PageResource> getAddedPageResources()
Obtains a read-only collection of page resources that have been added to the document during this request if a partial request, or the full list of resources for a full-submit. The collection is ordered by the order in which addResource(PageResource) was called.
Returns:
a read-only collection of page resources

getPageResources

public java.util.List<PageResource> getPageResources()
Obtains a read-only collection of all page resources associated with the document. The collection is ordered by the order in which addResource(PageResource) was called.
Returns:
a read-only collection of page resources

processSaveState

public java.lang.Object processSaveState(javax.faces.context.FacesContext context)
Overrides:
processSaveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

getMetaContainer

public final javax.faces.component.UIComponent getMetaContainer()
Content to be rendered as meta data inside the "head" section.

setMetaContainer

public final void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
Content to be rendered as meta data inside the "head" section.

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

getTheme

public final java.lang.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 added to its list of style classes. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme will remove the current theme, and a value of "inherit", 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", "light", and "default".
Returns:
the new theme value

setTheme

public final void setTheme(java.lang.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 added to its list of style classes. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme will remove the current theme, and a value of "inherit", 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", "light", and "default".
Parameters:
theme - the new theme value

getTitle

public final java.lang.String getTitle()
Gets the title of the document. (This title doesn't have to match the title on any contained panelPage.)
Returns:
the new title value

setTitle

public final void setTitle(java.lang.String title)
Sets the title of the document. (This title doesn't have to match the title on any contained panelPage.)
Parameters:
title - the new title value

getStateSaving

public final java.lang.String getStateSaving()
Gets Specify the state saving behavior for this page. client=force to be (full) client; server=force to be server-side; default=follows the settings of the web.xml
Returns:
the new stateSaving value

setStateSaving

public final void setStateSaving(java.lang.String stateSaving)
Sets Specify the state saving behavior for this page. client=force to be (full) client; server=force to be server-side; default=follows the settings of the web.xml
Parameters:
stateSaving - the new stateSaving value

getOnunload

public final java.lang.String getOnunload()
Gets an onunload Javascript handler.
Returns:
the new onunload value

setOnunload

public final void setOnunload(java.lang.String onunload)
Sets an onunload Javascript handler.
Parameters:
onunload - the new onunload value

getInitialFocusId

public final java.lang.String getInitialFocusId()
Gets the id of the component that you want to have focus when the full page renders. Note that if you are setting the initialFocusId to a component that is not normally available when rendered on the client, then you will also need to set the clientComponent attribute on that component to 'true'. Also, be aware that initialFocusId will be ignored when accessibility-mode is set to "screenReader". This is because there may be interesting content at the beginning of the page, like text content or a header.

Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.

Returns:
the new initialFocusId value

setInitialFocusId

public final void setInitialFocusId(java.lang.String initialFocusId)
Sets the id of the component that you want to have focus when the full page renders. Note that if you are setting the initialFocusId to a component that is not normally available when rendered on the client, then you will also need to set the clientComponent attribute on that component to 'true'. Also, be aware that initialFocusId will be ignored when accessibility-mode is set to "screenReader". This is because there may be interesting content at the beginning of the page, like text content or a header.

Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.

Parameters:
initialFocusId - the new initialFocusId value

getFailedConnectionText

public final java.lang.String getFailedConnectionText()
Gets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
Returns:
the new failedConnectionText value

setFailedConnectionText

public final void setFailedConnectionText(java.lang.String failedConnectionText)
Sets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
Parameters:
failedConnectionText - the new failedConnectionText value

isMaximized

public final boolean isMaximized()
Gets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px. If the document is set to be maximized and if there is only a single effective visual root component, that component will stretch automatically to consume the browser's viewable area--if supported by that component. Examples of components that support this are panelStretchLayout and panelSplitter. As a convenience, the effective visual root component detection will also look inside the form component if it is a direct child of the document component and it will not count popups nor non-inline messages as visual root components.
Returns:
the new maximized value

setMaximized

public final void setMaximized(boolean maximized)
Sets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px. If the document is set to be maximized and if there is only a single effective visual root component, that component will stretch automatically to consume the browser's viewable area--if supported by that component. Examples of components that support this are panelStretchLayout and panelSplitter. As a convenience, the effective visual root component detection will also look inside the form component if it is a direct child of the document component and it will not count popups nor non-inline messages as visual root components.
Parameters:
maximized - the new maximized value

getUncommittedDataWarning

public final java.lang.String getUncommittedDataWarning()
Gets Specifies whether users should be warned about uncommitted data when navigating off the page or region. The default value is 'off' (warnings disabled). Setting this property to 'on' will enable the warnings.
Returns:
the new uncommittedDataWarning value

setUncommittedDataWarning

public final void setUncommittedDataWarning(java.lang.String uncommittedDataWarning)
Sets Specifies whether users should be warned about uncommitted data when navigating off the page or region. The default value is 'off' (warnings disabled). Setting this property to 'on' will enable the warnings.
Parameters:
uncommittedDataWarning - the new uncommittedDataWarning value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXDocument

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXDocument

Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.