User Tools

Site Tools


Widget that makes up a column in a DzDockArea.


Inherits :


Detailed Description

TODO: Add detailed description.


Number : depth()

Return Value:

  • The current depth of this column. This is the same as width() for Right and Left dock areas, or height() for Top and Bottom dock areas.

Number : getNumWindows()

Return Value:

  • The number of windows docked in this column.

Number : getPreferredDepth()

Return Value:

  • The preferred depth of this column.

DzDockWindow : getWindow( Number which )


  • which - The index of the window to return.

Return Value:

  • The docked window at the given index (if valid), otherwise NULL.

Boolean : isMinimized()

Return Value:

  • true if this column is currently minimized, otherwise false.

void : minimize()

Minimizes this column, if it is not already. The column shrinks so that only its resizing handle is visible.

Number : minimumDepth()

Return Value:

  • The minimum depth of this column.

void : restore()

Restores this column to its previous depth if this column is currently minimized.

void : setPreferredDepth( Number depth )

Sets the 'depth' of this column.


  • depth - The new depth for this column. If less than the minimum depth, this column becomes the minimum depth.


  • 'Depth' refers to the distance between the handle/divider used to resize this column and the opposite edge. If this column is in the Left, Center or Right DzDockArea, 'depth' refers to the width of this column. If this column is in the Top or Bottom DzDockArea, 'depth' refers to the height of this column (or row).

void : toggleMinimized()

Toggles whether or not this column is minimized - if minimized, this column restores itself, if full size this column becomes minimized.