Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xe:djBorderPane

Description

A Dojo Border pane

Properties

• <xe:djBorderPane
• basics
• binding
• id
• loaded
• rendered
• rendererType
• dojo
• dojoAttributes
• dojoType
• dojo-widget
• dir
• dragRestriction
• errorMessage
• extractContent
• group
• href
• lang
• loadingMessage
• maxSize
• minSize
• parseOnLoad
• partialRefresh
• preload
• preventCache
• refreshOnShow
• region
• splitter
• waiRole
• waiState
• events
• onBlur
• onClick
• onClose
• onContentError
• onDblClick
• onDownloadEnd
• onDownloadError
• onDownloadStart
• onFocus
• onKeyDown
• onKeyPress
• onKeyUp
• onLoad
• onMouseDown
• onMouseEnter
• onMouseLeave
• onMouseMove
• onMouseOut
• onMouseOver
• onMouseUp
• onUnload
• styling
• disableTheme
• style
• styleClass
• themeId
• />

Java

Java Class: com.ibm.xsp.extlib.component.dojo.layout.UIDojoBorderPane

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  [Inherited] 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  [Inherited] Dojo Attributes Specifies a list of Dojo attributes. Required Attribute false

dojo-widget

dir, string  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] ARIA Role ARIA Role Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

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

href, string  [Inherited] Href Used to designate the external data the pane should load. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

extractContent, boolean  [Inherited] Extract Content If true, the visible content between the BODY tags of the document the ContentPane retrieves is extracted from it and placed into the pane. false by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

parseOnLoad, boolean  [Inherited] Parse On Load If true, any dijits returned in the data are automatically parsed and rendered. true by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

preventCache, boolean  [Inherited] Prevent Cache Acts just like the preventCacheparameter for a dojo.xhrGet. If true, an additional parameter is passed that changes with each request to prevent caching from occurring. false by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

preload, boolean  [Inherited] Preload Used to force the pane to load content, even if it is not initially visible. (If the node is styled with display:none then content may not load unless preload is set to true.) false by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

refreshOnShow, boolean  [Inherited] Refresh On Show Used to indicate whether the pane should reload every time the pane goes from a hidden state to a visible state. false by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

loadingMessage, string  [Inherited] Loading Message Defined in dijit.nls.loading. Provides a default message to the user while a load is in process. "Loading..." by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

errorMessage, string  [Inherited] Error Message Defined in dijit.nls.loading. Provides a default message to the user when a load fails. "Sorry, an error occurred" by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

partialRefresh, boolean  [Inherited] Partial Refresh Defines if the panel should use partial refresh to refresh its content. This is an XPages extension to the Dojo content pane. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

minSize, int Minimum Size If provided, the minimum size in pixels of the ContentPane is restricted to this value. By default, this value is 0. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

maxSize, int Maximum Size If provided, the maximum size in pixels of the ContentPane is restricted to this value. By default, this value is Infinity. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

splitter, boolean Splitter If provided, a splitter appears on the edge of the ContentPane so that resizing can occur. By default, this value is false, which means that the content is not resizable. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

region, string Region A region attribute specifies how to lay out the widget within its container. Valid values include "top", "bottom", "left", "right", and "center". By default, this value is an empty String. Values of "leading" and "trailing" are also possible and differ from "left" and "right" in that they are relative to the bidirectional layout orientation. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

events

onBlur, string  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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  [Inherited] 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

onLoad, string  [Inherited] On Load Extension point that is called after the load (and optional parsing of widgets) takes place. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onUnload, string  [Inherited] On Unload Extension point that is called before existing content is cleared by a refresh, setHref, or setContent. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onDownloadStart, string  [Inherited] On Download Start Extension point that is called just before the download begins. By default, returns the string that is displayed as the loading message. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onContentError, string  [Inherited] On Content error Extension point that is called when DOM errors occur. The string that is returned is what is displayed to the user. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onDownloadError, string  [Inherited] On Download error Extension point that is called if an error occurs during the download. By default, returns the string that is displayed as the error message. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onDownloadEnd, string  [Inherited] On Download End Extension point that is called when the download completes. 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] 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  [Inherited] Style Class HTML class attribute Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true