Class: PhpExt_BoxComponent

Source Location: /PhpExt/BoxComponent.php

Class PhpExt_BoxComponent

Class Overview

Base class for any visual PhpExt_Component that uses a box container.

BoxComponent provides automatic box model adjustments for sizing and positioning and will work correctly within the Component rendering model. All container classes should subclass BoxComponent so that they will work consistently when nested within other Ext layout containers.

Located in /PhpExt/BoxComponent.php [line 27]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent

Author(s):

API Tags:

See:

PhpExt_Component

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Container	Base class for any Ext.BoxComponent that can contain other components. Containers handle the basic behavior of containing items, namely adding, inserting and removing them. The specific layout logic required to visually render contained items is delegated to any one of the different layout classes available. This class is intended to be extended and should generally not need to be created directly via the new keyword.
PhpExt_DataView	A mechanism for displaying data using custom layout templates and formatting.
PhpExt_Form_Field
PhpExt_ProgressBar	An updateable progress bar component. The progress bar supports two different modes: manual and automatic.
PhpExt_Toolbar_Toolbar	Basic Toolbar class.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Component

PhpExt_Component::$_layoutData

PhpExt_Component::$_ownerCollection

PhpExt_Component::$_plugins

PhpExt_Component::$_xType

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Component

PhpExt_Component::__construct()

** Overrides ***

PhpExt_Component::getAllowDomMove()

Whether the component can move the Dom node when rendering (defaults to true).

PhpExt_Component::getApplyTo()

The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.

PhpExt_Component::getAutoShow()

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).

PhpExt_Component::getConfigParams()

PhpExt_Component::getContainerCssClass()

An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

PhpExt_Component::getCssClass()

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

PhpExt_Component::getCssStyle()

A custom style specification to be applied to this component's Element.

PhpExt_Component::getDisabledCssClass()

CSS class added to the component when it is disabled (defaults to "x-item-disabled").

PhpExt_Component::getEl()

The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.

PhpExt_Component::getHideMode()

How this component should hidden. Supported values are
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
PhpExt_Component::HIDE_MODE_DISPLAY

.

PhpExt_Component::getHideParent()

True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.

PhpExt_Component::getId()

The unique id of this component (defaults to an auto-assigned id).

PhpExt_Component::getLayoutData()

PhpExt_Component::getOwnerCollection()

PhpExt_Component::getPlugins()

An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

PhpExt_Component::getRenderTo()

The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

PhpExt_Component::render()

** Ext Object Methods ***

PhpExt_Component::setAllowDomMove()

Whether the component can move the Dom node when rendering (defaults to true).

PhpExt_Component::setApplyTo()

The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.

PhpExt_Component::setAutoShow()

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).

PhpExt_Component::setContainerCssClass()

An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

PhpExt_Component::setCssClass()

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

PhpExt_Component::setCssStyle()

A custom style specification to be applied to this component's Element.

PhpExt_Component::setDisabledCssClass()

CSS class added to the component when it is disabled (defaults to "x-item-disabled").

PhpExt_Component::setEl()

The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.

PhpExt_Component::setExtClassInfo()

PhpExt_Component::setHideMode()

How this component should hidden. Supported values are
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
PhpExt_Component::HIDE_MODE_DISPLAY

.

PhpExt_Component::setHideParent()

True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.

PhpExt_Component::setId()

The unique id of this component (defaults to an auto-assigned id).

PhpExt_Component::setLayoutData()

Layout specific properties for the corresponding layout of the container.

PhpExt_Component::setOwnerCollection()

PhpExt_Component::setRenderTo()

The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()

PhpExt_Observable::attachListener()

Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.

PhpExt_Observable::getConfigParams()

PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

Inherited From PhpExt_Component

PhpExt_Component::HIDE_MODE_DISPLAY

PhpExt_Component::HIDE_MODE_OFFSETS

PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]

Method Summary

PhpExt_BoxComponent	__construct()
boolean	getAutoHeight()	True to use height:'auto', false to use fixed height (defaults to false).
boolean	getAutoWidth()	True to use width:'auto', false to use fixed width (defaults to false).
integer	getHeight()	The height of this component in pixels (defaults to auto).
integer	getWidth()	The width of this component in pixels (defaults to auto).
PhpExt_BoxComponent	setAutoHeight()	True to use height:'auto', false to use fixed height (defaults to false).
PhpExt_BoxComponent	setAutoWidth()	True to use width:'auto', false to use fixed width (defaults to false).
PhpExt_BoxComponent	setHeight()	The height of this component in pixels (defaults to auto).
PhpExt_BoxComponent	setWidth()	The width of this component in pixels (defaults to auto).

[ Top ]

Properties

Methods

Constructor __construct [line 101]

PhpExt_BoxComponent __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Component::__construct(): ** Overrides ***

Redefined in descendants as:

[ Top ]

getAutoHeight [line 43]

boolean getAutoHeight(
)

True to use height:'auto', false to use fixed height (defaults to false).

API Tags:

Access:

public

[ Top ]

getAutoWidth [line 61]

boolean getAutoWidth(
)

True to use width:'auto', false to use fixed width (defaults to false).

API Tags:

Access:

public

[ Top ]

getHeight [line 79]

integer getHeight(
)

The height of this component in pixels (defaults to auto).

API Tags:

Access:

public

[ Top ]

getWidth [line 97]

integer getWidth(
)

The width of this component in pixels (defaults to auto).

API Tags:

Access:

public

[ Top ]

setAutoHeight [line 35]

PhpExt_BoxComponent setAutoHeight(
boolean
$value 
)

True to use height:'auto', false to use fixed height (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAutoWidth [line 53]

PhpExt_BoxComponent setAutoWidth(
boolean
$value 
)

True to use width:'auto', false to use fixed width (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHeight [line 71]

PhpExt_BoxComponent setHeight(
integer
$value 
)

The height of this component in pixels (defaults to auto).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setWidth [line 89]

PhpExt_BoxComponent setWidth(
integer
$value 
)

The width of this component in pixels (defaults to auto).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

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