photonui.BoxLayout Class
Vertical and horizontal box layout.
Layout Options:
{
align: <String (stretch|expand, start|left|top, center|middle, end|right|bottom), default=stretch>,
order: <Number default=null (auto)>
minWidth: <Number (null=auto), default=null>,
maxWidth: <Number (null=auto), default=null>,
width: <Number (null=auto), default=null>,
minHeight: <Number (null=auto), default=null>,
maxHeight: <Number (null=auto), default=null>,
height: <Number (null=auto), default=null>
}Constructor
photonui.BoxLayout
()
Item Index
Methods
- __onContextMenu
- __onLocaleChanged
- _bindEvent
- _buildHtml
- _callCallbacks
- _computeLayoutOptions
- _lockUpdate
- _registerWEvents
- _unbindEvent
- _updateLayout
- _updateProperties deprecated
- _visibilityChanged
- addChild
- addClass
- destroy
- empty
- hide
- registerCallback
- removeCallback
- removeChild
- removeClass
- show
- unparent
Properties
- __callbacks
- __events
- __html
- absolutePosition
- child
- childName
- children
- childrenNames
- containerNode
- contextMenu
- contextMenuName
- data
- horizontalChildExpansion
- horizontalPadding
- html
- layoutOptions
- name
- offsetHeight
- offsetWidth
- orientation
- parent
- parentName
- spacing
- stretchToParentHeight
- tooltip
- verticalChildExpansion
- verticalPadding
- visible
Methods
__onContextMenu
(
private
-
event
Called when the context menu should be displayed.
Parameters:
-
eventObject
__onLocaleChanged
()
private
Called when the locale is changed.
_bindEvent
(
private
-
id -
element -
evName -
callback -
[options]
Javascript event binding (for internal use).
Parameters:
_buildHtml
()
private
Build the widget HTML.
_callCallbacks
(
private
-
wEvent -
params
Call all callbacks for the given wEvent.
NOTE: the first argument passed to the callback is the current widget.
NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.
_computeLayoutOptions
(
Object
private
-
widget
Returns a normalized layoutOption for a given widget.
Parameters:
-
widgetphotonui.Widget
Returns:
Object:
the layout options
_lockUpdate
()
private
Lock the update of the layout.
_updateLayout
()
private
Update the layout.
_updateProperties
(
deprecated
private
-
properties
Force the update of the given properties.
This method is deprecated.
One should use '@photonui-update' abitbol's annotation on concerned properties.
Parameters:
-
propertiesArrayThe properties to update.
_visibilityChanged
(
private
-
visibility
Called when the visibility changes.
Parameters:
-
visibilityBooleanCurrent visibility state (otptional, defaut=this.visible)
addChild
(
-
widget -
layoutOption
Add a widget to the layout.
Parameters:
-
widgetphotonui.WidgetThe widget to add. -
layoutOptionObjectSpecific option for the layout (optional).
addClass
(
-
className
Add a class to the outer HTML element of the widget.
Parameters:
-
classNameStringThe class to add.
destroy
()
Destroy the widget.
empty
()
Destroy all children of the layout
hide
()
Hide the widget (equivalent to widget.visible = false).
registerCallback
(
-
id -
wEvent -
callback -
thisArg
Register a callback for any PhotonUI/Widget event (called wEvent).
Callback signature:
function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])
removeChild
(
-
widget
Remove a widget from the layout.
Parameters:
-
widgetphotonui.WidgetThe widget to remove.
removeClass
(
-
className
Remove a class from the outer HTML element of the widget.
Parameters:
-
classNameStringThe class to remove.
show
()
Display the widget (equivalent to widget.visible = true).
unparent
()
Detache the widget from its parent.