Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:pager

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

Description

A common control that allows traversal of data pages

Properties

Java

Java Class: com.ibm.xsp.component.xp.XspPager


accessibility

title, string
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
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
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
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
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
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
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
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
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

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

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