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

Class: PhpExt_Menu_Separator

Source Location: /PhpExt/Menu/Separator.php

Class PhpExt_Menu_Separator

Class Overview

Adds a separator bar to a menu, used to divide logical groups of menu items.

Located in /PhpExt/Menu/Separator.php [line 24]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_Menu_BaseItem
            |
            --PhpExt_Menu_Separator

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Menu_BaseItem

PhpExt_Menu_BaseItem::$_items

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_Menu_BaseItem

PhpExt_Menu_BaseItem::__construct()
PhpExt_Menu_BaseItem::addCheckItem()
Helper function to quick add a checkitem
PhpExt_Menu_BaseItem::addSeparator()
Helper function to quick add a separator
PhpExt_Menu_BaseItem::addSubItem()
Helper function to quick add an item
PhpExt_Menu_BaseItem::addTextItem()
Helper function to quick add a textitem
PhpExt_Menu_BaseItem::getActiveCssClass()
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
PhpExt_Menu_BaseItem::getCanActivate()
True if this item can be visually activated (defaults to false)
PhpExt_Menu_BaseItem::getConfigParams()
PhpExt_Menu_BaseItem::getHandler()
A function that will handle the click event of this menu item (defaults to undefined)
PhpExt_Menu_BaseItem::getHideDelay()
Length of time in milliseconds to wait before hiding after a click (defaults to 100)
PhpExt_Menu_BaseItem::getHideOnClick()
True to hide the containing menu after this item is clicked (defaults to true)
PhpExt_Menu_BaseItem::getItems()
An array of items to be added to this menu. See add for a list of valid item types.
PhpExt_Menu_BaseItem::getScope()
The scope in which the handler function will be called.
PhpExt_Menu_BaseItem::setActiveCssClass()
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
PhpExt_Menu_BaseItem::setCanActivate()
True if this item can be visually activated (defaults to false)
PhpExt_Menu_BaseItem::setHandler()
A function that will handle the click event of this menu item (defaults to undefined)
PhpExt_Menu_BaseItem::setHideDelay()
Length of time in milliseconds to wait before hiding after a click (defaults to 100)
PhpExt_Menu_BaseItem::setHideOnClick()
True to hide the containing menu after this item is clicked (defaults to true)
PhpExt_Menu_BaseItem::setScope()
The scope in which the handler function will be called.

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
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. 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
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. 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_Menu_Separator   __construct()  
boolean   getHideOnClick()   True to hide the containing menu after this item is clicked (defaults to false)
string   getItemCssClass()   The default CSS class to use for separators (defaults to "x-menu-sep")
void   getJavascript()  
PhpExt_Menu_Separator   setHideOnClick()   True to hide the containing menu after this item is clicked (defaults to false)
PhpExt_Menu_Separator   setItemCssClass()   The default CSS class to use for separators (defaults to "x-menu-sep")

[ Top ]
Methods
Constructor __construct  [line 62]

  PhpExt_Menu_Separator __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Menu_BaseItem::__construct()

[ Top ]
getHideOnClick  [line 39]

  boolean getHideOnClick( )

True to hide the containing menu after this item is clicked (defaults to false)


API Tags:
Access:  public


Redefinition of:
PhpExt_Menu_BaseItem::getHideOnClick()
True to hide the containing menu after this item is clicked (defaults to true)

[ Top ]
getItemCssClass  [line 57]

  string getItemCssClass( )

The default CSS class to use for separators (defaults to "x-menu-sep")


API Tags:
Access:  public


[ Top ]
getJavascript  [line 74]

  void getJavascript( [ $lazy = false], [ $varName = null]  )

Parameters:
   $lazy: 
   $varName: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Object::getJavascript()

[ Top ]
setHideOnClick  [line 32]

  PhpExt_Menu_Separator setHideOnClick( boolean $value  )

True to hide the containing menu after this item is clicked (defaults to false)

Parameters:
boolean   $value: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Menu_BaseItem::setHideOnClick()
True to hide the containing menu after this item is clicked (defaults to true)

[ Top ]
setItemCssClass  [line 49]

  PhpExt_Menu_Separator setItemCssClass( string $value  )

The default CSS class to use for separators (defaults to "x-menu-sep")

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:59:32 -0500 by phpDocumentor 1.4.0