|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXDocument
oracle.adf.view.rich.component.rich.RichDocument
public class RichDocument
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. <section name="Geometry_Management"> <html:ul> <html:li>To stretch a document, set maximized to true (the default). This will cause the page's outer-most margin and padding to 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 af:form, af:panelStretchLayout, af:panelSplitter, and af:panelGroupLayout with layout=scroll.</html:li> </html:ul> </section>
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 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 |
LARGE_ICON_SOURCE_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 org.apache.myfaces.trinidad.bean.PropertyKey |
SMALL_ICON_SOURCE_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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
RichDocument() Construct an instance of the RichDocument. |
protected |
RichDocument(java.lang.String rendererType) Construct an instance of the RichDocument. |
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
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. |
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String |
getDefaultEventName() |
java.util.Collection<java.lang.String> |
getEventNames() |
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. |
java.lang.String |
getLargeIconSource() Gets Specifies a large icon that the browser may use when bookmarking this page to your device's home screen. |
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 |
getSmallIconSource() Gets Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon"). |
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 |
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. |
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
resourcesRendered() Called from the document renderer, this method notifies this component that the resources have been rendered. |
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 |
setLargeIconSource(java.lang.String largeIconSource) Sets Specifies a large icon that the browser may use when bookmarking this page to your device's home screen. |
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 |
setSmallIconSource(java.lang.String smallIconSource) Sets Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon"). |
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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXDocument |
---|
invokeOnComponent, visitTree |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STATE_SAVING_DEFAULT
public static final java.lang.String STATE_SAVING_CLIENT
public static final java.lang.String STATE_SAVING_SERVER
public static final java.lang.String UNCOMMITTED_DATA_WARNING_ON
public static final java.lang.String UNCOMMITTED_DATA_WARNING_OFF
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey THEME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STATE_SAVING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ONUNLOAD_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INITIAL_FOCUS_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FAILED_CONNECTION_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNCOMMITTED_DATA_WARNING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SMALL_ICON_SOURCE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LARGE_ICON_SOURCE_KEY
public static final java.lang.String META_CONTAINER_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichDocument()
protected RichDocument(java.lang.String rendererType)
Method Detail |
---|
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addResource(PageResource resource)
resource
- The resource to addpublic void resourcesRendered()
public java.util.List<PageResource> getAddedPageResources()
addResource(PageResource)
was called.public java.util.List<PageResource> getPageResources()
addResource(PageResource)
was called.public final javax.faces.component.UIComponent getMetaContainer()
public final void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String getTheme()
public final void setTheme(java.lang.String theme)
theme
- the new theme valuepublic final java.lang.String getTitle()
public final void setTitle(java.lang.String title)
title
- the new title valuepublic final java.lang.String getStateSaving()
public final void setStateSaving(java.lang.String stateSaving)
stateSaving
- the new stateSaving valuepublic final java.lang.String getOnunload()
public final void setOnunload(java.lang.String onunload)
onunload
- the new onunload valuepublic final java.lang.String getInitialFocusId()
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.
public final void setInitialFocusId(java.lang.String initialFocusId)
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.
initialFocusId
- the new initialFocusId valuepublic final java.lang.String getFailedConnectionText()
public final void setFailedConnectionText(java.lang.String failedConnectionText)
failedConnectionText
- the new failedConnectionText valuepublic final boolean isMaximized()
public final void setMaximized(boolean maximized)
maximized
- the new maximized valuepublic final java.lang.String getUncommittedDataWarning()
public final void setUncommittedDataWarning(java.lang.String uncommittedDataWarning)
uncommittedDataWarning
- the new uncommittedDataWarning valuepublic final java.lang.String getSmallIconSource()
public final void setSmallIconSource(java.lang.String smallIconSource)
smallIconSource
- the new smallIconSource valuepublic final java.lang.String getLargeIconSource()
public final void setLargeIconSource(java.lang.String largeIconSource)
largeIconSource
- the new largeIconSource valuepublic java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXDocument
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXDocument
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |