<af:document>

af:document document document

UIComponent class: oracle.adf.view.rich.component.rich.RichDocument
Component type: oracle.adf.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.

Geometry Management

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.

Code Example(s)

<f:view>
  <af:document title="My Page"
               smallIconSource="/afr/favicon.png /afr/favicon.ico"
               largeIconSource="/afr/touchicon.png">
    <af:form> ... </af:form>
  </af:document>
</f:view>

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.

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.

Name	Description
metaContainer	Content to be rendered as meta data inside the "head" section.

Name

Description

metaContainer

Content to be rendered as meta data inside the "head" section.

Attributes

Name	Type	Supports EL?	Description
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. 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.
binding	oracle.adf.view.rich.component.rich.RichDocument	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent	boolean	Yes	Default Value: false 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. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
customizationId	String	Yes	This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
failedConnectionText	String	Yes	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. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
id	String	No	the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
initialFocusId	String	Yes	the id of the component that you want to have focus when the full page renders. The component that you are referring to by this initialFocusId must be a component that has its clientComponent attribute set to 'true'. 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. Not supported on the following agents: pda
inlineStyle	String	Yes	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.
largeIconSource	String	Yes	Specifies a large icon that the browser may use when bookmarking this page to your device's home screen. If this attribute is not specified, the browser may default to using a file named "apple-touch-icon.png" located at the root of your server. (This default behavior is not something provided by this framework and may vary between browsers.) This attribute supports a space-delimited list of files (each file may be wrapped in quotes or apostrophes if the file path contains a space). If the file path specifies a single leading slash, this means that the file is located inside of the web application's root folder (so "/large-icon.png" would resolve to something like "http://www.oracle.com/adf-faces/large-icon.png"). If the file path specifies 2 leading slashes, this means that the file is located inside of the server's root folder (so "//large-icon.png" would resolve to something like "http://www.oracle.com/large-icon.png"). Browsers typically expect these files to be at least 57 pixels by 57 pixels but could be as big as 144 pixels by 144 pixels. Typically, the first listed file will be the one used. Otherwise, if a browser only supports certain kinds of files, the first file in the list that uses a supported file extension will be the one that is used for that browser. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
maximized	boolean	Yes	Default Value: true 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. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
onunload	String	Yes	an onunload Javascript handler. Not supported on the following renderkits: oracle.adf.rich
partialTriggers	String[]	Yes	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.
rendered	boolean	Yes	Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc	String	Yes	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.
smallIconSource	String	Yes	Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon"). If this attribute is not specified, the browser may default to using a file named "favicon.ico" located at the root of your server. (This default behavior is not something provided by this framework and may vary between browsers.) This attribute supports a space-delimited list of files (each file may be wrapped in quotes or apostrophes if the file path contains a space). If the file path specifies a single leading slash, this means that the file is located inside of the web application's root folder (so "/small-icon.png" would resolve to something like "http://www.oracle.com/adf-faces/small-icon.png"). If the file path specifies 2 leading slashes, this means that the file is located inside of the server's root folder (so "//small-icon.png" would resolve to something like "http://www.oracle.com/small-icon.png"). Browsers typically expect these files to be 16 pixels by 16 pixels. Typically, the first listed file will be the one used. Otherwise, if a browser only supports certain kinds of files, the first file in the list that uses a supported file extension will be the one that is used for that browser. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
stateSaving	String	Yes	Valid Values: default, client, server Default Value: default 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
styleClass	String	Yes	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'.
theme	String	Yes	The component style theme to apply to this component. Themes are cascaded down through all child components. All HTML elements that are rendered by a rich component within a themed component will have the theme applied to its DOM. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme (theme="") or a theme of "default" will remove the current theme (from the component as well as the children of the current component), and a value of "inherit", null (specified as theme="#{null}"), or not setting a theme will use the current theme. Skins are the sources of the the themes. Some skins may have no themed definitions. Suggested theme names include "dark", "medium" and "light".
title	String	Yes	the title of the document. (This title doesn't have to match the title on any contained panelPage.)
uncommittedDataWarning	String	Yes	Valid Values: on, off Default Value: off Specifies whether users should be warned about uncommitted data when navigating off the page. Setting this property to 'on' will enable the warnings. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
unsecure	java.util.Set	Yes	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.
visible	boolean	Yes	Default Value: true 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. Not supported on the following renderkits: org.apache.myfaces.trinidad.core

Name

Type

Supports EL?

Description

attributeChangeListener

javax.el.MethodExpression

Only EL

a method reference to an attribute change listener. 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.

binding

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

Only EL

an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.

clientComponent

boolean

Yes

Default Value: false

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.
For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.

customizationId

String

Yes

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

failedConnectionText

String

Yes

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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

String

the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:

They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).
Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).

initialFocusId

String

Yes

the id of the component that you want to have focus when the full page renders. The component that you are referring to by this initialFocusId must be a component that has its clientComponent attribute set to 'true'.

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.

Not supported on the following agents: pda

inlineStyle

String

Yes

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.

largeIconSource

String

Yes

Specifies a large icon that the browser may use when bookmarking this page to your device's home screen. If this attribute is not specified, the browser may default to using a file named "apple-touch-icon.png" located at the root of your server. (This default behavior is not something provided by this framework and may vary between browsers.) This attribute supports a space-delimited list of files (each file may be wrapped in quotes or apostrophes if the file path contains a space). If the file path specifies a single leading slash, this means that the file is located inside of the web application's root folder (so "/large-icon.png" would resolve to something like "http://www.oracle.com/adf-faces/large-icon.png"). If the file path specifies 2 leading slashes, this means that the file is located inside of the server's root folder (so "//large-icon.png" would resolve to something like "http://www.oracle.com/large-icon.png"). Browsers typically expect these files to be at least 57 pixels by 57 pixels but could be as big as 144 pixels by 144 pixels. Typically, the first listed file will be the one used. Otherwise, if a browser only supports certain kinds of files, the first file in the list that uses a supported file extension will be the one that is used for that browser.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

maximized

boolean

Yes

Default Value: true

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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

onunload

String

Yes

an onunload Javascript handler.
Not supported on the following renderkits: oracle.adf.rich

partialTriggers

String[]

Yes

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.

rendered

boolean

Yes

Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.

shortDesc

String

Yes

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.

smallIconSource

String

Yes

Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon"). If this attribute is not specified, the browser may default to using a file named "favicon.ico" located at the root of your server. (This default behavior is not something provided by this framework and may vary between browsers.) This attribute supports a space-delimited list of files (each file may be wrapped in quotes or apostrophes if the file path contains a space). If the file path specifies a single leading slash, this means that the file is located inside of the web application's root folder (so "/small-icon.png" would resolve to something like "http://www.oracle.com/adf-faces/small-icon.png"). If the file path specifies 2 leading slashes, this means that the file is located inside of the server's root folder (so "//small-icon.png" would resolve to something like "http://www.oracle.com/small-icon.png"). Browsers typically expect these files to be 16 pixels by 16 pixels. Typically, the first listed file will be the one used. Otherwise, if a browser only supports certain kinds of files, the first file in the list that uses a supported file extension will be the one that is used for that browser.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

stateSaving

String

Yes

Valid Values: default, client, server
Default Value: default

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

styleClass

String

Yes

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

theme

String

Yes

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

title

String

Yes

the title of the document. (This title doesn't have to match the title on any contained panelPage.)

uncommittedDataWarning

String

Yes

Valid Values: on, off
Default Value: off

Specifies whether users should be warned about uncommitted data when navigating off the page. Setting this property to 'on' will enable the warnings.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

unsecure

java.util.Set

Yes

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.

visible

boolean

Yes

Default Value: true

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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

<af:document>

Geometry Management

Code Example(s)

Events

Supported Facets

Attributes