Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xe:com.ibm.xsp.dojo.Widget

Description

Base Dojo widget

Properties

• basics
• binding
• id
• loaded
• rendered
• rendererType
• dojo
• dojoAttributes
• dojoType
• dojo-widget
• dir
• dragRestriction
• group
• lang
• waiRole
• waiState
• events
• onBlur
• onClick
• onClose
• onDblClick
• onFocus
• onKeyDown
• onKeyPress
• onKeyUp
• onMouseDown
• onMouseEnter
• onMouseLeave
• onMouseMove
• onMouseOut
• onMouseOver
• onMouseUp
• styling
• disableTheme
• style
• styleClass
• themeId

Java

Java Class: com.ibm.xsp.extlib.component.dojo.UIDojoWidget

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

dojo

dojoType, string Dojo Type Sets the default Dojo Type used to create this control in the browser. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute Dojo Attributes Specifies a list of Dojo attributes. Required Attribute false

dojo-widget

dir, string Direction Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl". Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dragRestriction, boolean Drag Restriction To remove the drag capability Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

group, string Group Defines a group belonging. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

lang, string Lang Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us). Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

waiRole, string ARIA Role ARIA Role Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

waiState, string ARIA State ARIA State Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

events

onBlur, string On Blur Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onClick, string On Click Connect to this function to receive notifications of mouse click events Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onClose, string On Close Callback if someone tries to close the child, child will be closed if func returns true Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onDblClick, string On Double Click Connect to this function to receive notifications of mouse double click events Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onFocus, string On Focus Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onKeyDown, string On Key Down Connect to this function to receive notifications of keys being pressed down Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onKeyPress, string On Key Press Connect to this function to receive notifications of printable keys being typed. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onKeyUp, string On Key Up Connect to this function to receive notifications of keys being released Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseDown, string On Mouse Down Connect to this function to receive notifications of when the mouse button is pressed down Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseEnter, string On Mouse Enter Connect to this function to receive notifications of when the mouse moves onto this widget Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseLeave, string on Mouse Leave Connect to this function to receive notifications of when the mouse moves off of this widget Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseMove, string On Mouse Move Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseOut, string On Mouse Out Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseOver, string On Mouse Over Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onMouseUp, string On Mouse Uo Connect to this function to receive notifications of when the mouse button is released 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 Style HTML style attributes as cssText string or name/value hash Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styleClass, string Style Class HTML class attribute Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true