Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:viewPager

f:javax.faces.Component
   f:javax.faces.Panel
      xp:com.ibm.xsp.UIPager
         xp:pager
            xp:viewPager

Description

A control that navigates pages of data. Also known as a pager, this control can be positioned either in the header or footer of views

Properties

Java

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


accessibility

title, string  [Inherited]
Advisory Title
Provides title information for controls.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
role, string  [Inherited]
Control Identifier
Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

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
lang, string  [Inherited]
Language Code
Describes the language used in the generated markup of the control.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
for, string  [Inherited]
For Identifier
Holds the id of the Table that this pager is to effect
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
pageCount, int  [Inherited]
Page Count
The number of pages displayed in a group control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
partialRefresh, boolean  [Inherited]
Partial Refresh
Only refreshes the control (table, repeat...) that the pager points to, using an Ajax request.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
partialExecute, boolean  [Inherited]
Partial Execute
Specifies to only execute the control that the pager points to, thus bypassing the lifecycle for other controls.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
alwaysCalculateLast, boolean  [Inherited]
Always Calculate Last
Always calculate last document in container. There can be an associated performance hit when this is set to true.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
srcNext, string
Next Image
The URL to an image representing the next button
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
srcPrevious, string
Previous Image
The URL to an image representing the previous button
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
srcFirst, string
First Image
The URL to an image representing the first button
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
srcLast, string
Last Image
The URL to an image representing the last button
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
tabindex, string
Tab Index
Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
enableAjax, boolean
Enable AJAX Support
Enables AJAX behavior on the pager. Setting this property to true, means that all requests for different pages, are done through AJAX and no longer fire of a standard submit.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

format

layout, string  [Inherited]
Pager Layout
Default layout of the child controls within the pager
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
panelPosition, string  [Inherited]
Navigator Position
Specifies where in the specified location, the pager should appear. Valid values are top, left, right and bottom. If the pager and the view title are set to the same position, the title will always appear before the pager.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
location, string
Navigator location
Indicates if there is to be a pager present in the cell above the table data, or below the table data (valid values are top and bottom).If it is intended that the pager be located outside of the view panel, some where else on the page, then the standard data table pager can be used in its place, as the location (and panelPosition properties will be ignored).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
useButtons, string
Use Buttons
Render text buttons instead of images
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
hideDisabledButtons, string
Hide Disabled Buttons
Specifies whether unused buttons should be hidden or not
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
imageGotoButton, string
Pager Image for Goto Button
Represents a URL to the image that should appear on the "Goto" button of the Goto Navigator (pager).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
imageGotoAlt, string
Pager Image Alt Text for Goto Button
Alternate textual description of the Goto Button.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
type, string
Navigator Type
The type property specifies how the pager should look, the pager internally creates to different types of pagers, a goto pager, and a deluxe pager, the user can specify the type to affect which of these two pagers will be visible, the valid values are "goto", "navigator" or "both", which will show the goto pager only, the deluxe pager only, or both the goto and deluxe pagers respectively. Default is "both".
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true

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
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
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
outerStyleClass, string  [Inherited]
CSS Outer Style Classes
Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style 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