Class Container

Object
   |
   +--Widget
         |
         +--Container

Direct Known Subclasses:

RadioGroup, Form, Table, TableRow, Tree, Splitter, Menu, StatusBar, IconCaption, DatePickerList, TabbedPane.TabContainer, List, Table.Head, Toolbar, TreeNode

class Container

extends Widget

Defined in container.js

Field Detail

children

WidgetList children

A list containing this container's children. All the elements in the list are widgets. This property should be considered read-only. (ie. do not reassign it, and do not call list-mutating methods on it, but it's OK to iterate over the list, ask its length, etc.)

Container

function Container(<boolean> scrolling, <string> tagName, <LayoutManager> layout)

Creates a widget container. A container is used to group widgets together on the screen. The positions of the contained widgets are governed by a layout manager. So far we only have GridLayout and FlowLayout, but others may be added.

Parameters:
scrolling - (Optional) - a boolean to indicate whether or not the container should grow scrollbars or clip its content when the content is too big. Defaults to false, which implies clipping.
tagName - (Optional) - a string to use as the tag-name for the container's HTML node. Defaults to 'div'.
layout - (Optional) - a layout manager to use. Defaults to a do-nothing layout manager that leaves all widgets in an implementation-defined location.

appendChild

void appendChild(<Widget> widget, <boolean> layout)

Inserts widget into the container after all other children. Does nothing if widget is null. If layout is true, then this.layout() is called after widget has been inserted.

Parameters:
widget - the widget to be inserted
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the insertion. Defaults to false.

clear

void clear()

Removes every element from this container.

contains

boolean contains(<Widget> widget)

Returns true if this container (or one of its descendants) contains widget, and false otherwise.

Parameters:
widget - the widget to check

Returns:
whether or not widget is in this container or one of its descendants

insertAfter

void insertAfter(<Widget> newWidget, <Widget> oldWidget, <boolean> layout)

Inserts newWidget into the container after oldWidget. If oldWidget is null then newWidget is prepended to the container. If layout is true, then this.layout() is called after newWidget has been inserted.

Note: insertAfter is implemented in terms of insertBefore and prependChild. Subclassers may want to avoid calling this implementation of insertAfter if it would be incorrect to call both the new implementation of insertAfter and the new implementation of either insertBefore or prependChild.

Parameters:
newWidget - a widget to be inserted
oldWidget - either null or a widget in this container
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the insertion. Defaults to false.

insertAt

void insertAt(<Widget> widget, <int> index, <boolean> layout)

Inserts widget at the index'th position in this container. Moves existing widgets down in the list.

Parameters:
widget - the widget to insert
index - the index at which to insert widget
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the insertion. Defaults to false.

insertBefore

void insertBefore(<Widget> newWidget, <Widget> oldWidget, <boolean> layout)

Inserts newWidget into the container before oldWidget. If oldWidget is null then newWidget is appended to the container. If layout is true, then this.layout() is called after newWidget has been inserted.

Parameters:
newWidget - a widget to be inserted
oldWidget - either null or a widget in this container
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the insertion. Defaults to false.

isEmpty

boolean isEmpty()

Returns true if the container is empty and false otherwise.

Returns:
whether or not the container is empty

prependChild

void prependChild(<Widget> widget, <boolean> layout)

Inserts widget into the container before all other children. Does nothing if widget is null. If layout is true, then this.layout() is called after widget has been inserted.

Parameters:
widget - the widget to be inserted
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the insertion. Defaults to false.

removeChild

void removeChild(<Widget> widget, <boolean> layout)

Removes widget from the container. Does nothing if widget is null. If layout is true, then this.layout() is called after widget has been removed.

Parameters:
widget - the widget to be removed
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the removal. Defaults to false.

replaceChild

void replaceChild(<Widget> newWidget, <Widget> oldWidget, <boolean> layout)

Replaces oldWidget with newWidget. Does nothing if either newWidget or oldWidget is null. If layout is true, then this.layout() is called after the replacement has been made.

Parameters:
newWidget - the widget to be inserted
oldWidget - the widget to be removed
layout - (Optional) - a boolean indicating whether or not to call this.layout() after the replacement. Defaults to false.

setEnabled

void setEnabled(<boolean> isEnabled)

Set the enabled state of this widget.

Parameters:
isEnabled - a boolean indicating whether or not to enable the widget. true enables the widget and false disables it.

setLayout

void setLayout(<LayoutManager> layout)

Sets the layout manager for this container.

Parameters:
layout - a layout manager (for example, FlowLayout or GridLayout)