Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:view

xp:view

Description

The top-level container for all controls used within a Form design element. The namespaces for the control libraries used within the page are declared on this tag.

Properties

Java

Java Class: com.ibm.xsp.component.UIViewRootEx2


basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
dir, string  [Inherited]
Direction
Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
navigationRules, Collection of xp:navigationRule - com.ibm.xsp.application.NavigationRule  [Inherited]
Navigation Rules
Defines a list of rules that effect the navigation between pages
Required Attribute false
resources, Collection of xp:resource - com.ibm.xsp.resource.Resource  [Inherited]
Resources
Specifies a list of resources that are to be included in the page, such as CSS style sheets
Required Attribute false
createForm, boolean  [Inherited]
Create Form Flag
Flag to indicate whether or not a form will be created if none already exists
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
viewState, string  [Inherited]
View State
Defines how the state of the view is maintained
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
pageTitle, string  [Inherited]
Page Title
String representing the title applied to the page on a web server.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
pageIcon, string  [Inherited]
Page Icon
String representing the icon applied to the page on a web server.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
pageManifest, string  [Inherited]
Page Manifest
String representing the HTML 5 manifest attribute to be added to the html tag.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
pageBaseUrl, xp:baseUrl - com.ibm.xsp.complex.ViewRootBaseUrl  [Inherited]
Page Base URL used by links
String representing the HTML page base URL, used by links.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
defaultLinkTarget, string  [Inherited]
Default Link Target
The Default Link Target when not specified directly on link
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

data, Collection of xp:dataInterface - com.ibm.xsp.model.DataSource  [Inherited]
Control Data
Control Data List
Required Attribute false
dataContexts, Collection of xp:dataContextInterface - com.ibm.xsp.model.DataContext  [Inherited]
Control Data Context
Control Data Context List
Required Attribute false
acl, xp:acl - com.ibm.xsp.acl.ACL  [Inherited]
Access Control List
Specifies a list of users and their permissions
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
readonly, boolean  [Inherited]
Read Only Flag
Indicates that this control is read only and switches the controls it contains to read only.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
properties, Collection of xp:parameter - com.ibm.xsp.complex.Parameter  [Inherited]
Properties
Specifies the list of properties to be defined at the view level.
Required Attribute false
enableModifiedFlag, boolean  [Inherited]
Enable Modified Flag
Allows this XPage to be notified when its participating controls have been modified.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
modifiedMessage, string  [Inherited]
Modified Message
Specifies the confirmation message to display to the user when closing a modified XPage.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
modifiedControl, string  [Inherited]
Modified Control
The control that associates its action to be the action to execute when saving a modified XPage.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

dojo

dojoTheme, boolean  [Inherited]
Use Dojo Theme
Flag to indicate whether a dojo theme should be used. This property can be forced by some controls when they require a Dojo theme to be used (ex: the rich text editor)
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoForm, boolean  [Inherited]
Create a Dojo Form
Flag to indicate if the View should generate a dojo Form (dojoType='dijit.form.Form') and insert the Dojo module as a resource to the page.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoParseOnLoad, boolean  [Inherited]
Trigger Dojo parser on load
Flag to indicate whether the dojo parser should be triggered on load. This property can be forced by some controls when the parser is required (ex: the rich text editor)
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

events

onClientLoad, string  [Inherited]
On Client Load
This event allows you to add events to run as soon as your page loads in the web browser
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
beforePageLoad,   [Inherited]
Before Page Load Method Binding
Triggered before a page is loaded
Required Attribute false
afterPageLoad,   [Inherited]
After Page Load Method Binding
Triggered after a page is loaded
Required Attribute false
afterRestoreView,   [Inherited]
After Restore View Method Binding
Triggered after the Restore View phase of the JSF lifecycle
Required Attribute false
beforeRenderResponse,   [Inherited]
Before Render Response Method Binding
Triggered before the Render Response phase of the JSF lifecycle
Required Attribute false
afterRenderResponse,   [Inherited]
After Render Response Method Binding
Triggered after the Render Response phase of the JSF lifecycle
Required Attribute false

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
styleClass, string  [Inherited]
CSS Style Classes
Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
style, string  [Inherited]
CSS Styles
Specifies CSS style(s) to be applied when this control is rendered.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true