Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:message

Description

A control that displays warning, information, and error messages for one control on a page.

Properties

• <xp:message
• accessibility
• role
• title
• basics
• binding
• dir
• for
• id
• lang
• loaded
• rendered
• rendererType
• format
• showDetail
• showSummary
• tooltip
• styling
• disableTheme
• errorClass
• errorStyle
• fatalClass
• fatalStyle
• infoClass
• infoStyle
• style
• styleClass
• themeId
• warnClass
• warnStyle
• />

Java

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

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

for, string  [Inherited] Associated Client ID Identifies the control for which to display messages Required Attribute true Localizable false Allow Runtime Binding true 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

format

showDetail, boolean  [Inherited] Show Detail Indicates whether the detail portion of displayed messages should be included. Defaults to true. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

showSummary, boolean  [Inherited] Show Summary Indicates whether the summary portion of displayed messages should be included. Defaults to false. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

tooltip, boolean Tool Tip Flag indicating whether the detail portion of the message should be displayed as a tool tip 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

errorClass, string Error Class CSS style class to apply to any message with a severity class of "ERROR" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

errorStyle, string Error Styles CSS style(s) to apply to any message with a severity class of "ERROR" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

fatalClass, string Fatal Class CSS style class to apply to any message with a severity class of "FATAL" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

fatalStyle, string Fatal Styles CSS style(s) to apply to any message with a severity class of "FATAL" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

infoClass, string Info Class CSS style class to apply to any message with a severity class of "INFO" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

infoStyle, string Info Styles CSS style(s) to apply to any message with a severity class of "INFO" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

warnClass, string Warning Class CSS style class to apply to any message with a severity class of "WARN" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

warnStyle, string Warning Styles CSS style(s) to apply to any message with a severity class of "WARN" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true