PhpExt : Layout [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Layout_BorderLayoutData

Source Location: /PhpExt/Layout/BorderLayoutData.php

Class PhpExt_Layout_BorderLayoutData

Method Summary
static PhpExt_Layout_BorderLayoutData   createCenterRegion()   Creates a region
static PhpExt_Layout_BorderLayoutData   createEastRegion()   Creates a region
static PhpExt_Layout_BorderLayoutData   createNorthRegion()   Creates a region
static PhpExt_Layout_BorderLayoutData   createSouthRegion()   Creates a region
static PhpExt_Layout_BorderLayoutData   createWestRegion()   Creates a region
boolean   getAnimCollapse()   When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat to false will prevent the open and close of these floated panels from being animated (defaults to true).
boolean   getAutoHide()   When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is true, the panel will automatically hide after the user mouses out of the panel. If autoHide is false, the panel will continue to display until the user clicks outside of the panel (defaults to true).
object   getCMargins()   An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)}
string   getCollapseMode()   By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the region's title bar. Optionally, when collapseMode is set to 'mini' the region's split bar will also display a small collapse button in the center of the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. By default collapseMode is undefined, and the only two supported values are undefined and 'mini'. Note that if a collapsible region does not have a title bar, then collapseMode must be set to 'mini' in order for the region to be collapsible by the user as the tool button will not be rendered.
boolean   getCollapsible()   True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note that a title bar is required to display the toggle button -- if no region title is specified, the region will only be collapsible if collapseMode is set to 'mini'.
boolean   getFloatable()   True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).
mixed   getMargins()   An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} or a string with the margin values in the format "left top right bottom"
integer   getMaxSize()   The maximum size of the resizing element. (Defaults to 2000)
integer   getMinHeight()   The minimum allowable height in pixels for this region (defaults to 50)
integer   getMinSize()   The minimum size of the resizing element. (Defaults to 0)
integer   getMinWidth()   The minimum allowable width in pixels for this region (defaults to 50)
string   getRegion()   The region to render the related component. Posible values are:
boolean   getSplit()   True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a minSize and maxSize for the region.
string   getSplitTip()   The tooltip to display when the user hovers over a non-collapsible region's split bar (defaults to "Drag to resize."). Only applies if useSplitTips = true.
boolean   getUseShim()   Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.
boolean   getUseSplitTips()   True to display a tooltip when the user hovers over a region's split bar (defaults to false). The tooltip text will be the value of either splitTip or collapsibleSplitTip as appropriate.
PhpExt_Layout_BorderLayoutData   __construct()  
PhpExt_Layout_BorderLayoutData   setAnimCollapse()   When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat to false will prevent the open and close of these floated panels from being animated (defaults to true).
PhpExt_Layout_BorderLayoutData   setAutoHide()   When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is true, the panel will automatically hide after the user mouses out of the panel. If autoHide is false, the panel will continue to display until the user clicks outside of the panel (defaults to true).
PhpExt_Layout_BorderLayoutData   setCMargins()   An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)}
PhpExt_Layout_BorderLayoutData   setCollapseMode()   By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the region's title bar. Optionally, when collapseMode is set to 'mini' the region's split bar will also display a small collapse button in the center of the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. By default collapseMode is undefined, and the only two supported values are undefined and 'mini'. Note that if a collapsible region does not have a title bar, then collapseMode must be set to 'mini' in order for the region to be collapsible by the user as the tool button will not be rendered.
PhpExt_Layout_BorderLayoutData   setCollapsible()   True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note that a title bar is required to display the toggle button -- if no region title is specified, the region will only be collapsible if collapseMode is set to 'mini'.
PhpExt_Layout_BorderLayoutData   setFloatable()   True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).
PhpExt_Layout_BorderLayoutData   setMargins()   An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} or a string with the margin values in the format "left top right bottom"
PhpExt_Layout_BorderLayoutData   setMaxSize()   The maximum size of the resizing element. (Defaults to 2000)
PhpExt_Layout_BorderLayoutData   setMinHeight()   The minimum allowable height in pixels for this region (defaults to 50)
PhpExt_Layout_BorderLayoutData   setMinSize()   The minimum size of the resizing element. (Defaults to 0)
PhpExt_Layout_BorderLayoutData   setMinWidth()   The minimum allowable width in pixels for this region (defaults to 50)
PhpExt_Layout_BorderLayoutData   setRegion()   The region to render the related component. Posible values are:
PhpExt_Layout_BorderLayoutData   setSplit()   True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a minSize and maxSize for the region.
PhpExt_Layout_BorderLayoutData   setSplitTip()   The tooltip to display when the user hovers over a non-collapsible region's split bar (defaults to "Drag to resize."). Only applies if useSplitTips = true.
PhpExt_Layout_BorderLayoutData   setUseShim()   Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.
PhpExt_Layout_BorderLayoutData   setUseSplitTips()   True to display a tooltip when the user hovers over a region's split bar (defaults to false). The tooltip text will be the value of either splitTip or collapsibleSplitTip as appropriate.

[ Top ]
Methods
static method createCenterRegion  [line 371]

  static PhpExt_Layout_BorderLayoutData createCenterRegion( )

Creates a region


API Tags:
Access:  public


[ Top ]
static method createEastRegion  [line 379]

  static PhpExt_Layout_BorderLayoutData createEastRegion( )

Creates a region


API Tags:
Access:  public


[ Top ]
static method createNorthRegion  [line 355]

  static PhpExt_Layout_BorderLayoutData createNorthRegion( )

Creates a region


API Tags:
Access:  public


[ Top ]
static method createSouthRegion  [line 387]

  static PhpExt_Layout_BorderLayoutData createSouthRegion( )

Creates a region


API Tags:
Access:  public


[ Top ]
static method createWestRegion  [line 363]

  static PhpExt_Layout_BorderLayoutData createWestRegion( )

Creates a region


API Tags:
Access:  public


[ Top ]
getAnimCollapse  [line 50]

  boolean getAnimCollapse( )

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat to false will prevent the open and close of these floated panels from being animated (defaults to true).


API Tags:
Access:  public


[ Top ]
getAutoHide  [line 68]

  boolean getAutoHide( )

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is true, the panel will automatically hide after the user mouses out of the panel. If autoHide is false, the panel will continue to display until the user clicks outside of the panel (defaults to true).


API Tags:
Access:  public


[ Top ]
getCMargins  [line 86]

  object getCMargins( )

An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)}


API Tags:
Access:  public


[ Top ]
getCollapseMode  [line 104]

  string getCollapseMode( )

By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the region's title bar. Optionally, when collapseMode is set to 'mini' the region's split bar will also display a small collapse button in the center of the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. By default collapseMode is undefined, and the only two supported values are undefined and 'mini'. Note that if a collapsible region does not have a title bar, then collapseMode must be set to 'mini' in order for the region to be collapsible by the user as the tool button will not be rendered.


API Tags:
Access:  public


[ Top ]
getCollapsible  [line 122]

  boolean getCollapsible( )

True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note that a title bar is required to display the toggle button -- if no region title is specified, the region will only be collapsible if collapseMode is set to 'mini'.


API Tags:
Access:  public


[ Top ]
getFloatable  [line 140]

  boolean getFloatable( )

True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).


API Tags:
Access:  public


[ Top ]
getMargins  [line 158]

  mixed getMargins( )

An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} or a string with the margin values in the format "left top right bottom"


API Tags:
Access:  public


[ Top ]
getMaxSize  [line 301]

  integer getMaxSize( )

The maximum size of the resizing element. (Defaults to 2000)

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.


API Tags:
Access:  public


[ Top ]
getMinHeight  [line 176]

  integer getMinHeight( )

The minimum allowable height in pixels for this region (defaults to 50)


API Tags:
Access:  public


[ Top ]
getMinSize  [line 319]

  integer getMinSize( )

The minimum size of the resizing element. (Defaults to 0)

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.


API Tags:
Access:  public


[ Top ]
getMinWidth  [line 194]

  integer getMinWidth( )

The minimum allowable width in pixels for this region (defaults to 50)


API Tags:
Access:  public


[ Top ]
getRegion  [line 222]

  string getRegion( )

The region to render the related component. Posible values are:

<li>PhpExt_Layout_BorderLayoutData::REGION_NORTH</li> <li>PhpExt_Layout_BorderLayoutData::REGION_WEST</li> <li>PhpExt_Layout_BorderLayoutData::REGION_CENTER</li> <li>PhpExt_Layout_BorderLayoutData::REGION_EAST</li> <li>PhpExt_Layout_BorderLayoutData::REGION_SOUTH</li>


API Tags:
Access:  public


[ Top ]
getSplit  [line 241]

  boolean getSplit( )

True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a minSize and maxSize for the region.


API Tags:
Access:  public


[ Top ]
getSplitTip  [line 259]

  string getSplitTip( )

The tooltip to display when the user hovers over a non-collapsible region's split bar (defaults to "Drag to resize."). Only applies if useSplitTips = true.


API Tags:
Access:  public


[ Top ]
getUseShim  [line 337]

  boolean getUseShim( )

Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.


API Tags:
Access:  public


[ Top ]
getUseSplitTips  [line 277]

  boolean getUseSplitTips( )

True to display a tooltip when the user hovers over a region's split bar (defaults to false). The tooltip text will be the value of either splitTip or collapsibleSplitTip as appropriate.


API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 344]

  PhpExt_Layout_BorderLayoutData __construct( $region  )

Parameters:
   $region: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Layout_ContainerLayoutData::__construct()

[ Top ]
setAnimCollapse  [line 42]

  PhpExt_Layout_BorderLayoutData setAnimCollapse( boolean $value  )

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat to false will prevent the open and close of these floated panels from being animated (defaults to true).

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setAutoHide  [line 60]

  PhpExt_Layout_BorderLayoutData setAutoHide( boolean $value  )

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is true, the panel will automatically hide after the user mouses out of the panel. If autoHide is false, the panel will continue to display until the user clicks outside of the panel (defaults to true).

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setCMargins  [line 78]

  PhpExt_Layout_BorderLayoutData setCMargins( object $value  )

An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)}

Parameters:
object   $value: 

API Tags:
Access:  public


[ Top ]
setCollapseMode  [line 96]

  PhpExt_Layout_BorderLayoutData setCollapseMode( string $value  )

By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the region's title bar. Optionally, when collapseMode is set to 'mini' the region's split bar will also display a small collapse button in the center of the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. By default collapseMode is undefined, and the only two supported values are undefined and 'mini'. Note that if a collapsible region does not have a title bar, then collapseMode must be set to 'mini' in order for the region to be collapsible by the user as the tool button will not be rendered.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setCollapsible  [line 114]

  PhpExt_Layout_BorderLayoutData setCollapsible( boolean $value  )

True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note that a title bar is required to display the toggle button -- if no region title is specified, the region will only be collapsible if collapseMode is set to 'mini'.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setFloatable  [line 132]

  PhpExt_Layout_BorderLayoutData setFloatable( boolean $value  )

True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setMargins  [line 150]

  PhpExt_Layout_BorderLayoutData setMargins( mixed $value  )

An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} or a string with the margin values in the format "left top right bottom"

Parameters:
mixed   $value: 

API Tags:
Access:  public


[ Top ]
setMaxSize  [line 293]

  PhpExt_Layout_BorderLayoutData setMaxSize( integer $value  )

The maximum size of the resizing element. (Defaults to 2000)

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMinHeight  [line 168]

  PhpExt_Layout_BorderLayoutData setMinHeight( integer $value  )

The minimum allowable height in pixels for this region (defaults to 50)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMinSize  [line 311]

  PhpExt_Layout_BorderLayoutData setMinSize( integer $value  )

The minimum size of the resizing element. (Defaults to 0)

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMinWidth  [line 186]

  PhpExt_Layout_BorderLayoutData setMinWidth( integer $value  )

The minimum allowable width in pixels for this region (defaults to 50)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setRegion  [line 209]

  PhpExt_Layout_BorderLayoutData setRegion( string $value  )

The region to render the related component. Posible values are:

<li>PhpExt_Layout_BorderLayoutData::REGION_NORTH</li> <li>PhpExt_Layout_BorderLayoutData::REGION_WEST</li> <li>PhpExt_Layout_BorderLayoutData::REGION_CENTER</li> <li>PhpExt_Layout_BorderLayoutData::REGION_EAST</li> <li>PhpExt_Layout_BorderLayoutData::REGION_SOUTH</li>

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setSplit  [line 233]

  PhpExt_Layout_BorderLayoutData setSplit( boolean $value  )

True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a minSize and maxSize for the region.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setSplitTip  [line 251]

  PhpExt_Layout_BorderLayoutData setSplitTip( string $value  )

The tooltip to display when the user hovers over a non-collapsible region's split bar (defaults to "Drag to resize."). Only applies if useSplitTips = true.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setUseShim  [line 329]

  PhpExt_Layout_BorderLayoutData setUseShim( boolean $value  )

Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.

Inherited from SpliBar Config Options:

The border layout inherits the properties from the splitbar for the regions split element.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setUseSplitTips  [line 269]

  PhpExt_Layout_BorderLayoutData setUseSplitTips( boolean $value  )

True to display a tooltip when the user hovers over a region's split bar (defaults to false). The tooltip text will be the value of either splitTip or collapsibleSplitTip as appropriate.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
Constants
REGION_CENTER = 'center' [line 32]

[ Top ]
REGION_EAST = 'east' [line 33]

[ Top ]
REGION_NORTH = 'north' [line 30]

[ Top ]
REGION_SOUTH = 'south' [line 34]

[ Top ]
REGION_WEST = 'west' [line 31]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:50:24 -0500 by phpDocumentor 1.4.0