Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:viewColumn

Description

A control that displays a column in a view

Properties

• <xp:viewColumn
• accessibility
• role
• basics
• binding
• columnName
• displayAs
• htmlFilter
• id
• loaded
• rendered
• rendererType
• width
• data
• converter
• openDocAsReadonly
• pageUrl
• value
• events
• onclick
• format
• collapsedImage
• contentType
• expandedImage
• iconAlt
• iconSrc
• indentResponses
• showCheckbox
• styling
• disableTheme
• style
• styleClass
• themeId
• />

Java

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

accessibility

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

htmlFilter, string  [Inherited] HTML Filtering processor name Indicates which Active Content Filtering processor to use. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

displayAs, string  [Inherited] Display fields as Links Specifies how the field should be displayed. Currently 'link' and 'text' are supported. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

columnName, string  [Inherited] Column Name The name of the data column to display in the view column. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

width, string  [Inherited] Column Width Defines the width of the column when rendered Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

data

converter, f:converterInterface - javax.faces.convert.Converter  [Inherited] Converter Converter instance registered 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 field 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

value, generic  [Inherited] Value The current value of this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

pageUrl, string  [Inherited] Page URL Used to specify a custom URL for the columns link. If displayAs is set to "link", and a Page Url is set, the specified URL will be set on the link. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

events

onclick, string  [Inherited] Click Script JavaScript code executed when a pointer control is clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

format

contentType, string  [Inherited] Content Type Specifies the type of content to expect. HTML and Text are supported. Text is the default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

showCheckbox, boolean  [Inherited] Show Check Box Displays a check box beside each field Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

iconSrc, string  [Inherited] Icon Source URL to image that will appear to the left of each value - may be bound to a field (e.g. mail read/unread or doc importance level) Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

iconAlt, string  [Inherited] Alternate Text for Icon Alternative text to display if the image cannot be displayed. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

expandedImage, string  [Inherited] Expanded Image Image to be displayed when the column contains an expanded row entry. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

collapsedImage, string  [Inherited] Collapsed Image Image to be displayed when the column contains a collapsed row entry. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

indentResponses, boolean  [Inherited] Indent Responses Indicates if responses are to be indented for this column. If this view is dealing with data that can support responses, (typically to documents), then these responses will appear below their owner document. Visually, response documents are typically indented from the owning document and each level of response is indented more than the previous indent level. This flag will trigger this indenting to happen for this column. Typically this is only done on one column, most likely the first (non categorized) column. 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