ui.panel

Since 5.1

A singular pane of the Dashboard widget..

Panel serves as a container for other widgets inside Dashboard. It gets a set of coordinates that define its position, width and height. Each "panel" view contains a body, where you can place another view or a template.

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a object with properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
getChildViews returns child views of the calling component
getFormView returns master form for the input
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getTopParentView returns the top parent view
hasEvent checks whether the component has the specified event handler
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
queryView returns inner element/elements of a widget that correspond(s) to the defined parameters
resize adjusts the view to a new size
show makes the component visible
unbind breaks "bind" link
unblockEvent cancels events blocking that was enabled by the 'blockEvent' command
Events
onBindRequest fires when the component is ready to receive data from the master component
onDestruct occurs when component destroyed
onViewResize fires on resizing a view
onViewShow fires when any hidden view is shown
Properties
animate defines the type of animation, with which the view is shown, if it is a Multiview cell
body defines the panel content (a view or some HTML)
borderless used to hide the component borders
container an HTML container (or its ID) where the component should be initialized
css the name of the CSS class or the object with styles that will be applied to the view container
disabled indicates whether an item is enabled
gravity sets the view gravity
header sets the header for a panel
height sets the height of the component
hidden defines whether the view will be hidden initially
icon defines whether an icon will be displayed on a panel
id the ID of a widget
maxHeight defines the maximum height of the view
maxWidth defines the maximum width of the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
on allows attaching custom handlers to inner events of the component
padding defines the space between the element borders and content (applies the specified value to all sides).
paddingX sets the right and left padding (applies the specified value to both sides)
paddingY sets the top and bottom padding (applies the specified value to both sides)
resize enables resizing of a widget
type defines the layout borders
width sets the width of a widget
Other
$getSize returns the current size of the component
$height the current height of the view
$resizeEnd the method is called when the user ends dragging the "resize" handle (releases the mouse button)
$resizeMove the method is called when the user drags the "resize" handle
$setNode defines HTML element for the component
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to the top HTML element of the view
$width the current width of the view
config all options from the initial component configuration
name indicates the name of the component (a read-only property)
Back to top