Class: PhpExt_DataView

Source Location: /PhpExt/DataView.php

Class PhpExt_DataView

Class Overview

A mechanism for displaying data using custom layout templates and formatting.

DataView uses an PhpExt_XTemplate as its internal templating mechanisma, and is bound to an PhpExt_Data_Store so that as the data in the store changes the view is automatically updated to reflect the changes. The view also provides built-in behavior for many common events that can occur for its contained items including click, doubleclick, mouseover, mouseout, etc. as well as a built-in selection model. In order to use these features, an itemSelector config must be provided for the DataView to determine what nodes it will be working with.

Located in /PhpExt/DataView.php [line 26]

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

Methods

[ 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_BoxComponent

PhpExt_BoxComponent::__construct()

PhpExt_BoxComponent::getAutoHeight()

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

PhpExt_BoxComponent::getAutoWidth()

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

PhpExt_BoxComponent::getHeight()

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

PhpExt_BoxComponent::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).

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_DataView	__construct()
string	getEmptyText()	The text to display in the view when there is no data to display (defaults to '').
string	getItemCssSelector()	This is a required setting. A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.
string	getLoadingText()	A string to display during data load operations (defaults to undefined). If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.
boolean	getMultiSelect()	True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).
string	getOverCssClass()	A CSS class to apply to each item in the view on mouseover (defaults to undefined).
string	getSelectedCssClass()	A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
boolean	getSimpleSelect()	True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
boolean	getSingleSelect()	True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored
PhpExt_Data_Store	getStore()	The PhpExt_Data_Store or any of its children to bind this DataView to.
PhpExt_XTemplate	getTemplate()	The template used to render the DataView
PhpExt_DataView	setEmptyText()	The text to display in the view when there is no data to display (defaults to '').
PhpExt_DataView	setItemCssSelector()	This is a required setting. A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.
PhpExt_DataView	setLoadingText()	A string to display during data load operations (defaults to undefined). If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.
PhpExt_DataView	setMultiSelect()	True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).
PhpExt_DataView	setOverCssClass()	A CSS class to apply to each item in the view on mouseover (defaults to undefined).
PhpExt_DataView	setSelectedCssClass()	A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
PhpExt_DataView	setSimpleSelect()	True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
PhpExt_DataView	setSingleSelect()	True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored
PhpExt_DataView	setStore()	The PhpExt_Data_Store or any of its children to bind this DataView to.
PhpExt_DataView	setTemplate()	The template used to render the DataView

[ Top ]

Properties

Methods

Constructor __construct [line 211]

PhpExt_DataView __construct(
string
$itemSelector 
)

Parameters:

string

$itemSelector:

A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.

API Tags:

Access:

public

Redefinition of:

PhpExt_BoxComponent::__construct()

[ Top ]

getEmptyText [line 42]

string getEmptyText(
)

The text to display in the view when there is no data to display (defaults to '').

API Tags:

Access:

public

[ Top ]

getItemCssSelector [line 60]

string getItemCssSelector(
)

This is a required setting. A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.

API Tags:

Access:

public

[ Top ]

getLoadingText [line 78]

string getLoadingText(
)

A string to display during data load operations (defaults to undefined). If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.

API Tags:

Access:

public

[ Top ]

getMultiSelect [line 96]

boolean getMultiSelect(
)

True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).

API Tags:

Access:

public

[ Top ]

getOverCssClass [line 114]

string getOverCssClass(
)

A CSS class to apply to each item in the view on mouseover (defaults to undefined).

API Tags:

Access:

public

[ Top ]

getSelectedCssClass [line 132]

string getSelectedCssClass(
)

A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').

API Tags:

Access:

public

[ Top ]

getSimpleSelect [line 150]

boolean getSimpleSelect(
)

True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).

API Tags:

Access:

public

[ Top ]

getSingleSelect [line 168]

boolean getSingleSelect(
)

True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored

API Tags:

Access:

public

[ Top ]

getStore [line 186]

PhpExt_Data_Store getStore(
)

The PhpExt_Data_Store or any of its children to bind this DataView to.

API Tags:

Access:

public

[ Top ]

getTemplate [line 204]

PhpExt_XTemplate getTemplate(
)

The template used to render the DataView

API Tags:

Access:

public

[ Top ]

setEmptyText [line 34]

PhpExt_DataView setEmptyText(
string
$value 
)

The text to display in the view when there is no data to display (defaults to '').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setItemCssSelector [line 52]

PhpExt_DataView setItemCssSelector(
string
$value 
)

This is a required setting. A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setLoadingText [line 70]

PhpExt_DataView setLoadingText(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMultiSelect [line 88]

PhpExt_DataView setMultiSelect(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setOverCssClass [line 106]

PhpExt_DataView setOverCssClass(
string
$value 
)

A CSS class to apply to each item in the view on mouseover (defaults to undefined).

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSelectedCssClass [line 124]

PhpExt_DataView setSelectedCssClass(
string
$value 
)

A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSimpleSelect [line 142]

PhpExt_DataView setSimpleSelect(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setSingleSelect [line 160]

PhpExt_DataView setSingleSelect(
boolean
$value 
)

True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setStore [line 178]

PhpExt_DataView setStore(
PhpExt_Data_Store
$value 
)

The PhpExt_Data_Store or any of its children to bind this DataView to.

Parameters:

PhpExt_Data_Store

$value:

Descendats of PhpExt_Data_Store

API Tags:

Access:

public

[ Top ]

setTemplate [line 196]

PhpExt_DataView setTemplate(
PhpExt_XTemplate
$value 
)

The template used to render the DataView

Parameters:

PhpExt_XTemplate

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:52:36 -0500 by phpDocumentor 1.4.0