Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xe:forumView

f:javax.faces.Component
   xp:com.ibm.xsp.UIDataIterator
      xe:com.ibm.xsp.extlib.DataSourceIterator
         xe:com.ibm.xsp.extlib.AbstractDataView
            xe:forumView

Description

A high level control that renders an hierarchical view.

Properties

Java

Java Class: com.ibm.xsp.extlib.component.data.UIForumView


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
removeRepeat, boolean  [Inherited]
Remove Repeat
Specifies if the repeat should be removed after repeating it's child controls. Note: This only works if it repeats a single child which is a naming container.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
repeatControls, boolean  [Inherited]
Repeat Controls
Specifies if the controls should be created multiple times or the single set of controls should be iterated over multiple times
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
partialRefresh, boolean  [Inherited]
Partial Refresh
Specifies that the built-in component actions should partial refresh the component, or the one it is 'for'
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
refreshId, string  [Inherited]
Partial Refresh Id
Defines the id of the component to refresh if partial refresh is specified. If empty, then the component will partial refresh itself or the component it is 'for'
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
partialExecute, boolean  [Inherited]
Partial Execute
Specifies that the built-in component actions should partial execute only the component
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
expandedDetail, boolean  [Inherited]
Expanded Detail
Specifies if the detail section should be expanded by default. Note that this property not re-evaluated per row, see the Force Expanded Detail to recompute for every row.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
showItemsFlat, boolean  [Inherited]
Display the items flat
Display the view item 'flat', ignoring the response hiererachy.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
detailsOnClient, boolean  [Inherited]
Expand/Collapse details on client
Process expand/collapse actions on the client. The full detail content is sent to the client, and the expand/collapse action does not trigger a server roundtrip.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
collapsibleDetail, boolean  [Inherited]
Collapsible Detail
Specifies if the detail is collapsible
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
pageName, string  [Inherited]
Page Name
The page used to open the document when the summary link is clicked.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

var, string  [Inherited]
Var
Specifies the variable name under which row data is made available to children.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
first, int  [Inherited]
First Index
Specifies the (zero based) index of the first row of data to start iterating from
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rows, int  [Inherited]
Rows to Process
Specifies the number of rows to iterate over, starting from the index. When this is not explicitly set, the default behavior depends on the value of the Repeat Controls property. When Repeat Controls is enabled, it defaults to processing all the rows, otherwise it will only process 30 rows.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
indexVar, string  [Inherited]
Index Var
Specifies the variable name under which the row index is made available to its children
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
value, generic  [Inherited]
Value
Specifies the value which typically returns a collection, list or array which is used to iterate over repeating the children of the control for each iteration. This value is then typically used to supply the data to the repeating children.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
data, xp:dataInterface - com.ibm.xsp.model.DataSource  [Inherited]
Data
Specifies the data associated with this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
openDocAsReadonly, boolean  [Inherited]
Open Document as Read-only
When the summary link is clicked this flag indicates if the document to be opened should be in read-only mode or editable.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

format

showCheckbox, boolean  [Inherited]
Show Check Box
Shows a check box that allows the selection of the row
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
showHeaderCheckbox, boolean  [Inherited]
Show Check Box in Header
Shows a check box in the titke that selects all the rows
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
summaryColumn, xe:viewSummaryColumn - com.ibm.xsp.extlib.component.data.SummaryColumn  [Inherited]
Summary Column
Defines the summary column
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  [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
rowStyle, string  [Inherited]
Row CSS Styles
Defines CSS style(s) used to display the rows
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rowStyleClass, string  [Inherited]
Row CSS Style Classes
Defines space-separated list of CSS style class(es) to be applied to the view rows
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true