Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:platformEvent

Description

A common control that handles a platform event

Properties

• <xp:platformEvent
• basics
• binding
• eventName
• id
• loaded
• rendered
• rendererType
• events
• onevent
• styling
• disableTheme
• themeId
• />

Java

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

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

eventName, string Event Name Specifies the name of the event handled by the control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

events

onevent, string On Event The script executed when the associated component event occurs, as determined by the Event Name property. 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