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

Class: PhpExt_Form_FormPanel

Source Location: /PhpExt/Form/FormPanel.php

Class PhpExt_Form_FormPanel

Class Overview

Standard form container.

Although they are not listed, this class also accepts all the config options required to configure its internal Ext.form.BasicForm

FormPanel uses a Ext.layout.FormLayout internally, and that is required for fields and labels to work correctly within the FormPanel's layout. To nest additional layout styles within a FormPanel, you should nest additional Panels or other containers that can provide additional layout functionality. You should not override FormPanel's layout.

By default, Ext Forms are submitted through Ajax, using Ext.form.Action. To enable normal browser submission of the Ext Form contained in this FormPanel, use the StandardSubmit property.

Located in /PhpExt/Form/FormPanel.php [line 31]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent
            |
            --PhpExt_Container
               |
               --PhpExt_Panel
                  |
                  --PhpExt_Form_FormPanel

Properties

Methods

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

Inherited From PhpExt_Panel

PhpExt_Panel::$BaseCssClass
PhpExt_Panel::$_bottomToolbar
PhpExt_Panel::$_buttons
PhpExt_Panel::$_tools
PhpExt_Panel::$_topToolbar

Inherited From PhpExt_Container

PhpExt_Container::$_defaultLayout
PhpExt_Container::$_items
PhpExt_Container::$_layout

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_Panel

PhpExt_Panel::__construct()
PhpExt_Panel::addButton()
Adds a button to the footer
PhpExt_Panel::addTool()
A PhpExt_ToolConfigObject to add to the tools collection
PhpExt_Panel::getAnimCollapse()
True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.Fx class is available, otherwise false).
PhpExt_Panel::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 panel-specific structural markup. When applyTo is used, constituent parts of the panel can be specified by CSS class name within the main element, and the panel will automatically create those components from that markup. Any required components not specified in the markup will be autogenerated if necessary. The following class names are supported (baseCls will be replaced by BaseCssClass):
PhpExt_Panel::getAutoLoad()
PhpExt_Panel::getAutoScroll()
True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false).
PhpExt_Panel::getBaseCssClass()
The base CSS class to apply to this panel's element (defaults to 'x-panel').
PhpExt_Panel::getBodyBorder()
True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when border == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance.
PhpExt_Panel::getBodyStyle()
Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
PhpExt_Panel::getBorder()
True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
PhpExt_Panel::getBottomToolbar()
The bottom toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants. To access the bottom toolbar after javascript render, use getBottomToolbar.
PhpExt_Panel::getButtonAlign()
PhpExt_Panel::getButtons()
PhpExt_Panel::getCollapsed()
True to render the panel collapsed, false to render it expanded (defaults to false).
PhpExt_Panel::getCollapsedCssClass()
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
PhpExt_Panel::getCollapseFirst()
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true).
PhpExt_Panel::getCollapsible()
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false).
PhpExt_Panel::getConfigParams()
PhpExt_Panel::getContentElement()
The id of an existing HTML node to use as the panel's body content (defaults to '').
PhpExt_Panel::getDraggable()
True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true, although Ext.Panel.DD is an internal, undocumented class.
PhpExt_Panel::getElements()
A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be generated automatically based on the items added to the panel at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this list will allocate the required placeholders in the panel when it is rendered. Valid values are
PhpExt_Panel::getFloating()
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
PhpExt_Panel::getFooter()
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
PhpExt_Panel::getFrame()
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
PhpExt_Panel::getHeader()
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
PhpExt_Panel::getHeaderAsText()
True to display the panel title in the header, false to hide it (defaults to true).
PhpExt_Panel::getHideCollapseTool()
True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
PhpExt_Panel::getHtml()
An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
PhpExt_Panel::getIconCssClass()
A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
PhpExt_Panel::getKeys()
A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
PhpExt_Panel::getLoadMask()
The id of the DOM Element which servers as loading mask to show loading messages
PhpExt_Panel::getMaskDisabled()
True to mask the panel when it is disabled, false to not mask it (defaults to true).
PhpExt_Panel::getMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)
PhpExt_Panel::getShadow()
True (or a valid PhpExt_Shadow.Mode value) to display a shadow behind the panel, false to display no shadow (defaults to 'PhpExt_MODE_SIDES'). Note that this option only applies when floating = true.
PhpExt_Panel::getShadowOffset()
The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
PhpExt_Panel::getShim()
False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
PhpExt_Panel::getTitle()
The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
PhpExt_Panel::getTitleCollapse()
True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).
PhpExt_Panel::getTools()
A PhpExt_ToolConfigObjectCollection of tool buttons to be added to the header tool area.
PhpExt_Panel::getTopToolbar()
The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.
PhpExt_Panel::setAnimCollapse()
True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.Fx class is available, otherwise false).
PhpExt_Panel::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 panel-specific structural markup. When applyTo is used, constituent parts of the panel can be specified by CSS class name within the main element, and the panel will automatically create those components from that markup. Any required components not specified in the markup will be autogenerated if necessary. The following class names are supported (baseCls will be replaced by BaseCssClass):
PhpExt_Panel::setAutoLoad()
PhpExt_Panel::setAutoScroll()
True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false).
PhpExt_Panel::setBaseCssClass()
The base CSS class to apply to this panel's element (defaults to 'x-panel').
PhpExt_Panel::setBodyBorder()
True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when border == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance.
PhpExt_Panel::setBodyStyle()
Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
PhpExt_Panel::setBorder()
True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
PhpExt_Panel::setBottomToolbar()
The bottom toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants. To access the bottom toolbar after javascript render, use getBottomToolbar.
PhpExt_Panel::setButtonAlign()
The alignment of any buttons added to this panel. Valid values are:
PhpExt_Panel::setCollapsed()
True to render the panel collapsed, false to render it expanded (defaults to false).
PhpExt_Panel::setCollapsedCssClass()
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
PhpExt_Panel::setCollapseFirst()
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true).
PhpExt_Panel::setCollapsible()
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false).
PhpExt_Panel::setContentElement()
The id of an existing HTML node to use as the panel's body content (defaults to '').
PhpExt_Panel::setDraggable()
True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true, although Ext.Panel.DD is an internal, undocumented class.
PhpExt_Panel::setElements()
A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be generated automatically based on the items added to the panel at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this list will allocate the required placeholders in the panel when it is rendered. Valid values are
PhpExt_Panel::setFloating()
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
PhpExt_Panel::setFooter()
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
PhpExt_Panel::setFrame()
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
PhpExt_Panel::setHeader()
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
PhpExt_Panel::setHeaderAsText()
True to display the panel title in the header, false to hide it (defaults to true).
PhpExt_Panel::setHideCollapseTool()
True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
PhpExt_Panel::setHtml()
An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
PhpExt_Panel::setIconCssClass()
A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
PhpExt_Panel::setKeys()
A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
PhpExt_Panel::setLoadMask()
The id of the DOM Element which servers as loading mask to show loading messages
PhpExt_Panel::setMaskDisabled()
True to mask the panel when it is disabled, false to not mask it (defaults to true).
PhpExt_Panel::setMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)
PhpExt_Panel::setShadow()
True (or a valid PhpExt_Shadow.Mode value) to display a shadow behind the panel, false to display no shadow (defaults to 'PhpExt_MODE_SIDES'). Note that this option only applies when floating = true.
PhpExt_Panel::setShadowOffset()
The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
PhpExt_Panel::setShim()
False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
PhpExt_Panel::setTitle()
The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
PhpExt_Panel::setTitleCollapse()
True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).
PhpExt_Panel::setTopToolbar()
The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.

Inherited From PhpExt_Container

PhpExt_Container::__construct()
PhpExt_Container::addItem()
Adds a component to the items collection
PhpExt_Container::getActiveItem()
A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.Accordion, Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.
PhpExt_Container::getAutoDestroy()
If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).
PhpExt_Container::getBufferResize()
When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers with a large amount of sub components that frequent calls to layout are expensive.
PhpExt_Container::getConfigParams()
PhpExt_Container::getDefaults()
PhpExt_Container::getDefaultType()
The default type of container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel').
PhpExt_Container::getHideBorders()
True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
PhpExt_Container::getItems()
A single item, or an array of child Components to be added to this container. Each item can be any type of object based on Ext.Component.
PhpExt_Container::getLayout()
The layout type to be used in this container. If not specified, a default PhpExt_Layout_ContainerLayout will be created and used.
PhpExt_Container::getMonitorResize()
True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.
PhpExt_Container::setActiveItem()
A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.Accordion, Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.
PhpExt_Container::setAutoDestroy()
If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).
PhpExt_Container::setBufferResize()
When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers with a large amount of sub components that frequent calls to layout are expensive.
PhpExt_Container::setDefaults()
A config object that will be applied to all components added to this container either via the items config or via the add or insert methods. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the container. For example, to automatically apply padding to the body of each of a set of contained PhpExt_Panel items, you could pass: new PhpExt_Config_ConfigObject(array('bodyStyle'=>'padding:15px')).
PhpExt_Container::setDefaultType()
The default type of container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel').
PhpExt_Container::setHideBorders()
True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
PhpExt_Container::setLayout()
The layout type to be used in this container. If not specified, a default PhpExt_Layout_ContainerLayout will be created and used.
PhpExt_Container::setMonitorResize()
True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.

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
  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 ]
Constant Summary
LABEL_ALIGN_LEFT  
LABEL_ALIGN_RIGHT  
LABEL_ALIGN_TOP  
METHOD_GET  
METHOD_POST  
MSG_TARGET_QTIP   Display a quick tip when the user hovers over the field
MSG_TARGET_SIDE   Add an error icon to the right of the field with a popup on hover
MSG_TARGET_TITLE   Display a default browser title attribute popup
MSG_TARGET_UNDER   Add a block div beneath the field containing the error text
VTYPE_ALPHAMASK  
VTYPE_ALPHANUM  
VTYPE_EMAIL  
VTYPE_URL  

[ Top ]
Method Summary
PhpExt_Form_FormPanel   __construct()  
array   getBaseParams()   Parameters to pass with all requests. e.g. array('id'=>123, 'foo'=>'bar').
string   getButtonAlign()  
PhpExt_Data_DataReader   getErrorReader()  
boolean   getFileUpload()   Set to true if this form is a file upload.
string   getItemCssClass()   A css class to apply to the x-form-item of fields. This property cascades to child containers.
string   getLabelAlign()  
integer   getLabelWidth()   The width of labels. This property cascades to child containers.
string   getMethod()   The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
integer   getMinButtonWidth()   Minimum width of all buttons in pixels (defaults to 75)
integer   getMonitorPoll()   The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
boolean   getMonitorValid()   If true the form monitors its valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value formBind:true on the button.
PhpExt_JavascriptStm   getOnSubmit()   Override for the onSubmit event. Use PhpExt_Javascript::stm("Ext.emptyFn") to avoid the default handler
PhpExt_Data_DataReader   getReader()   An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON.
boolean   getStandardSubmit()   If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)
integer   getTimeout()   Timeout for form actions in seconds (default is 30 seconds).
boolean   getTrackResetOnLoad()   If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created.
string   getUrl()   The URL to use for form actions if one isn't supplied in the action options.
string   getWaitMsgTarget()   The id of the DOM Element to use as the wait message target
PhpExt_Form_FormPanel   setBaseParams()   Parameters to pass with all requests. e.g. array('id'=>123, 'foo'=>'bar').
PhpExt_Form_FormPanel   setButtonAlign()   The alignment of any buttons added to this panel. Valid values are:
PhpExt_Form_FormPanel   setErrorReader()   An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON.
PhpExt_Form_FormPanel   setFileUpload()   Set to true if this form is a file upload.
PhpExt_Form_FormPanel   setItemCssClass()   A css class to apply to the x-form-item of fields. This property cascades to child containers.
PhpExt_Form_FormPanel   setLabelAlign()   The alignment for the child controls' labels. Valid values are:
PhpExt_Form_FormPanel   setLabelWidth()   The width of labels. This property cascades to child containers.
PhpExt_Form_FormPanel   setMethod()   The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
PhpExt_Form_FormPanel   setMinButtonWidth()   Minimum width of all buttons in pixels (defaults to 75)
PhpExt_Form_FormPanel   setMonitorPoll()   The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
PhpExt_Form_FormPanel   setMonitorValid()   If true the form monitors its valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value formBind:true on the button.
PhpExt_Form_FormPanel   setOnSubmit()   Override for the onSubmit event. Use PhpExt_Javascript::stm("Ext.emptyFn") to avoid the default handler.
PhpExt_Form_FormPanel   setReader()   An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON.
PhpExt_Form_FormPanel   setStandardSubmit()   If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)
PhpExt_Form_FormPanel   setTimeout()   Timeout for form actions in seconds (default is 30 seconds).
PhpExt_Form_FormPanel   setTrackResetOnload()   If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created.
PhpExt_Form_FormPanel   setUrl()   The URL to use for form actions if one isn't supplied in the action options.
PhpExt_Form_FormPanel   setWaitMsgTarget()   The id of the DOM Element to use as the wait message target

[ Top ]
Properties
mixed   $FieldsLazyRender = true [line 428]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 430]

  PhpExt_Form_FormPanel __construct( [ $id = null], [ $url = null]  )

Parameters:
   $id: 
   $url: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Panel::__construct()

[ Top ]
getBaseParams  [line 230]

  array getBaseParams( )

Parameters to pass with all requests. e.g. array('id'=>123, 'foo'=>'bar').

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getButtonAlign  [line 87]

  string getButtonAlign( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Panel::getButtonAlign()

[ Top ]
getErrorReader  [line 249]

  PhpExt_Data_DataReader getErrorReader( )

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getFileUpload  [line 267]

  boolean getFileUpload( )

Set to true if this form is a file upload.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getItemCssClass  [line 105]

  string getItemCssClass( )

A css class to apply to the x-form-item of fields. This property cascades to child containers.


API Tags:
Access:  public


[ Top ]
getLabelAlign  [line 132]

  string getLabelAlign( )


API Tags:
Access:  public


[ Top ]
getLabelWidth  [line 150]

  integer getLabelWidth( )

The width of labels. This property cascades to child containers.


API Tags:
Access:  public


[ Top ]
getMethod  [line 295]

  string getMethod( )

The request method to use (GET or POST) for form actions if one isn't supplied in the action options.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization Posible values are:

  • PhpExt_Form_FormPanel::METHOD_GET
  • PhpExt_Form_FormPanel::METHOD_POST


API Tags:
Access:  public
Uses:  PhpExt_Form_FormPanel::METHOD_POST
Uses:  PhpExt_Form_FormPanel::METHOD_GET


[ Top ]
getMinButtonWidth  [line 168]

  integer getMinButtonWidth( )

Minimum width of all buttons in pixels (defaults to 75)


API Tags:
Access:  public


Redefinition of:
PhpExt_Panel::getMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)

[ Top ]
getMonitorPoll  [line 186]

  integer getMonitorPoll( )

The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)


API Tags:
Access:  public


[ Top ]
getMonitorValid  [line 204]

  boolean getMonitorValid( )

If true the form monitors its valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value formBind:true on the button.


API Tags:
Access:  public


[ Top ]
getOnSubmit  [line 424]

  PhpExt_JavascriptStm getOnSubmit( )

Override for the onSubmit event. Use PhpExt_Javascript::stm("Ext.emptyFn") to avoid the default handler


API Tags:
Access:  public


[ Top ]
getReader  [line 314]

  PhpExt_Data_DataReader getReader( )

An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getStandardSubmit  [line 332]

  boolean getStandardSubmit( )

If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getTimeout  [line 350]

  integer getTimeout( )

Timeout for form actions in seconds (default is 30 seconds).

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getTrackResetOnLoad  [line 368]

  boolean getTrackResetOnLoad( )

If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getUrl  [line 386]

  string getUrl( )

The URL to use for form actions if one isn't supplied in the action options.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
getWaitMsgTarget  [line 404]

  string getWaitMsgTarget( )

The id of the DOM Element to use as the wait message target

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization


API Tags:
Access:  public


[ Top ]
setBaseParams  [line 222]

  PhpExt_Form_FormPanel setBaseParams( array $value  )

Parameters to pass with all requests. e.g. array('id'=>123, 'foo'=>'bar').

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
array   $value: 

API Tags:
Access:  public


[ Top ]
setButtonAlign  [line 80]

  PhpExt_Form_FormPanel setButtonAlign( string $value  )

The alignment of any buttons added to this panel. Valid values are:

  • PhpExt_Ext::EXT_HALIGN_LEFT
  • PhpExt_Ext::EXT_HALIGN_RIGHT
  • PhpExt_Ext::EXT_HALIGN_CENTER
Defaults to PhpExt_Ext::EXT_HALIGN_CENTER

Parameters:
string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Ext::EXT_HALIGN_RIGHT
Uses:  PhpExt_Ext::EXT_HALIGN_LEFT
Uses:  PhpExt_Ext::EXT_HALIGN_CENTER


Redefinition of:
PhpExt_Panel::setButtonAlign()
The alignment of any buttons added to this panel. Valid values are:

[ Top ]
setErrorReader  [line 241]

  PhpExt_Form_FormPanel setErrorReader( PhpExt_Data_DataReader $value  )

An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
PhpExt_Data_DataReader   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Data_DataReader


[ Top ]
setFileUpload  [line 259]

  PhpExt_Form_FormPanel setFileUpload( boolean $value  )

Set to true if this form is a file upload.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setItemCssClass  [line 97]

  PhpExt_Form_FormPanel setItemCssClass( string $value  )

A css class to apply to the x-form-item of fields. This property cascades to child containers.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setLabelAlign  [line 124]

  PhpExt_Form_FormPanel setLabelAlign( string $value  )

The alignment for the child controls' labels. Valid values are:

  • PhpExt_Form_FormPanel::LABEL_ALIGN_LEFT
  • PhpExt_Form_FormPanel::LABEL_ALIGN_TOP
  • PhpExt_Form_FormPanel::LABEL_ALIGN_RIGHT
Defaults to PhpExt_Form_FormPanel::LABEL_ALIGN_LEFT. This property cascades to child containers if not set.

Parameters:
string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Form_FormPanel::LABEL_ALIGN_TOP
Uses:  PhpExt_Form_FormPanel::LABEL_ALIGN_RIGHT
Uses:  PhpExt_Form_FormPanel::LABEL_ALIGN_LEFT


[ Top ]
setLabelWidth  [line 142]

  PhpExt_Form_FormPanel setLabelWidth( integer $value  )

The width of labels. This property cascades to child containers.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMethod  [line 282]

  PhpExt_Form_FormPanel setMethod( string $value  )

The request method to use (GET or POST) for form actions if one isn't supplied in the action options.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization Posible values are:

  • PhpExt_Form_FormPanel::METHOD_GET
  • PhpExt_Form_FormPanel::METHOD_POST

Parameters:
string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Form_FormPanel::METHOD_POST
Uses:  PhpExt_Form_FormPanel::METHOD_GET


[ Top ]
setMinButtonWidth  [line 160]

  PhpExt_Form_FormPanel setMinButtonWidth( integer $value  )

Minimum width of all buttons in pixels (defaults to 75)

Parameters:
integer   $value: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Panel::setMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)

[ Top ]
setMonitorPoll  [line 178]

  PhpExt_Form_FormPanel setMonitorPoll( integer $value  )

The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMonitorValid  [line 196]

  PhpExt_Form_FormPanel setMonitorValid( boolean $value  )

If true the form monitors its valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value formBind:true on the button.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setOnSubmit  [line 416]

  PhpExt_Form_FormPanel setOnSubmit( PhpExt_JavascriptStm $value  )

Override for the onSubmit event. Use PhpExt_Javascript::stm("Ext.emptyFn") to avoid the default handler.

Parameters:
PhpExt_JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
setReader  [line 306]

An PhpExt_Data_DataReader (e.g. PhpExt_Data_XmlReader) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
PhpExt_Data_DataReader   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Data_DataReader


[ Top ]
setStandardSubmit  [line 324]

  PhpExt_Form_FormPanel setStandardSubmit( boolean $value  )

If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setTimeout  [line 342]

  PhpExt_Form_FormPanel setTimeout( integer $value  )

Timeout for form actions in seconds (default is 30 seconds).

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setTrackResetOnload  [line 360]

  PhpExt_Form_FormPanel setTrackResetOnload( boolean $value  )

If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setUrl  [line 378]

  PhpExt_Form_FormPanel setUrl( string $value  )

The URL to use for form actions if one isn't supplied in the action options.

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setWaitMsgTarget  [line 396]

  PhpExt_Form_FormPanel setWaitMsgTarget( string $value  )

The id of the DOM Element to use as the wait message target

Internal BasicForm config properties:

The FormPanel uses a PhpExt_Form_BasicForm to handle actions like load, sumbit or reset. BasicForm options may be included in the FormPanel Configuration for customization

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
Constants
LABEL_ALIGN_LEFT = 'left' [line 52]
API Tags:
Usedby:  PhpExt_Form_FormPanel::setLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::getLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::setLabelAlign()


[ Top ]
LABEL_ALIGN_RIGHT = 'right' [line 54]
API Tags:
Usedby:  PhpExt_Form_FormPanel::setLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::getLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::setLabelAlign()


[ Top ]
LABEL_ALIGN_TOP = 'top' [line 53]
API Tags:
Usedby:  PhpExt_Form_FormPanel::setLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::getLabelAlign()
Usedby:  PhpExt_Layout_FormLayout::setLabelAlign()


[ Top ]
METHOD_GET = 'GET' [line 56]
API Tags:
Usedby:  PhpExt_Form_FormPanel::getMethod()
Usedby:  PhpExt_Form_FormPanel::setMethod()
Usedby:  PhpExt_Form_Action::getMethod()
Usedby:  PhpExt_Form_Action::setMethod()


[ Top ]
METHOD_POST = 'POST' [line 57]
API Tags:
Usedby:  PhpExt_Form_FormPanel::getMethod()
Usedby:  PhpExt_Form_FormPanel::setMethod()
Usedby:  PhpExt_Form_Action::getMethod()
Usedby:  PhpExt_Form_Action::setMethod()


[ Top ]
MSG_TARGET_QTIP = 'qtip' [line 37]

Display a quick tip when the user hovers over the field

API Tags:
Usedby:  PhpExt_Form_Field::getMsgTarget()
Usedby:  PhpExt_Form_Field::setMsgTarget()


[ Top ]
MSG_TARGET_SIDE = 'side' [line 50]

Add an error icon to the right of the field with a popup on hover

API Tags:
Usedby:  PhpExt_Form_Field::getMsgTarget()
Usedby:  PhpExt_Form_Field::setMsgTarget()


[ Top ]
MSG_TARGET_TITLE = 'title' [line 42]

Display a default browser title attribute popup

API Tags:
Usedby:  PhpExt_Form_Field::getMsgTarget()
Usedby:  PhpExt_Form_Field::setMsgTarget()


[ Top ]
MSG_TARGET_UNDER = 'under' [line 46]

Add a block div beneath the field containing the error text

API Tags:
Usedby:  PhpExt_Form_Field::getMsgTarget()
Usedby:  PhpExt_Form_Field::setMsgTarget()


[ Top ]
VTYPE_ALPHAMASK = 'alpha' [line 59]
API Tags:
Usedby:  PhpExt_Form_TextField::createTextField()
Usedby:  PhpExt_Form_TextField::getVType()
Usedby:  PhpExt_Form_TextField::setVType()


[ Top ]
VTYPE_ALPHANUM = 'alphanum' [line 60]
API Tags:
Usedby:  PhpExt_Form_TextField::createTextField()
Usedby:  PhpExt_Form_TextField::getVType()
Usedby:  PhpExt_Form_TextField::setVType()


[ Top ]
VTYPE_EMAIL = 'email' [line 61]
API Tags:
Usedby:  PhpExt_Form_TextField::createTextField()
Usedby:  PhpExt_Form_TextField::getVType()
Usedby:  PhpExt_Form_TextField::setVType()


[ Top ]
VTYPE_URL = 'url' [line 62]
API Tags:
Usedby:  PhpExt_Form_TextField::createTextField()
Usedby:  PhpExt_Form_TextField::getVType()
Usedby:  PhpExt_Form_TextField::setVType()


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:54:17 -0500 by phpDocumentor 1.4.0