| core_html

# Class: Bs_DaFormPageControl Source Location: /core/html/form/domapi/Bs_DaFormPageControl.class.php
### Class Overview
    Bs_Object
       |
       --Bs_FormElement
          |
          --Bs_FormContainer
             |
             --Bs_DaFormPageControl
DomApi PageControl Class #### Author(s): andrej arn <at blueshoes dot org> #### Version: 4.3.$Revision: 1.4 $ $Date: 2003/10/29 17:48:39 $ #### Copyright: blueshoes.org | ### Variables $domApiAlign $domApiDefaultOpen $domApiDoRollover $domApiEnabled $domApiHeight $domApiWidth | ### Methods Bs_DaFormPageControl getElement setTab
### Inherited Variables #### Class: Bs_FormContainer Bs_FormContainer::$caption Bs_FormContainer::$defaultOff Bs_FormContainer::$formElements Bs_FormContainer::$level Bs_FormContainer::$mayToggle Bs_FormContainer::$pseudoContainer Bs_FormContainer::$pseudoIfNada Bs_FormContainer::$templatePath Bs_FormContainer::$templateString Bs_FormContainer::$useCheckboxAsCaption Bs_FormContainer::$useTemplate #### Class: Bs_FormElement Bs_FormElement::$accessRights Bs_FormElement::$container Bs_FormElement::$elementLayout Bs_FormElement::$elementStringFormat Bs_FormElement::$elementType Bs_FormElement::$FormID Bs_FormElement::$hideCaption Bs_FormElement::$name Bs_FormElement::$orderId Bs_FormElement::$persister Bs_FormElement::$persisterID Bs_FormElement::$persisterVarSettings Bs_FormElement::$visibility Bs_FormElement::$_form | ### Inherited Methods #### Class: Bs_FormContainer Bs_FormContainer::Bs_FormContainer() Constructor. Bs_FormContainer::addElement() add an instance of a form element object to this container. Bs_FormContainer::getElement() Return some html code to display the element on a website in a form. Bs_FormContainer::getEndTag() Bs_FormContainer::getLevel() returns the level this container belongs to. Bs_FormContainer::getSaveToDbArray() called by Bs_Form->getSaveToDbArray(), look there for further information. Bs_FormContainer::getStartTag() Bs_FormContainer::hasFileFieldElement() tells if this container holds a file field element. Bs_FormContainer::orderElements() orders the elements based on the orderId var. Bs_FormContainer::persist() persist the element settings. Bs_FormContainer::seedClearingHouse() called by Bs_Form->seedClearingHouse() so look there. #### Class: Bs_FormElement Bs_FormElement::Bs_FormElement() Constructor. Bs_FormElement::getCaption() Return the caption string (for the current language). Bs_FormElement::getCaptionForFormOutput() returns the caption. here in Bs_FormElement it's the same getCaption() but in Bs_FormField which overwrites these methods it makes a difference. Bs_FormElement::getElement() Return some html code to display the element on a website in a form. Bs_FormElement::getElementLayout() returns the layout string for this element. Bs_FormElement::getLanguageDependentValue() returns the value of a [language dependant] [object] var for the current or given language. Bs_FormElement::getLevel() returns the level this element belongs to. Bs_FormElement::getVisibility() returns how this field/element should be visible and editable to the user. Bs_FormElement::hasFormObject() tells if we have a reference to a form object where we can grab some information. Bs_FormElement::setFormObject() set a reference to a form object. #### Class: Bs_Object Bs_Object::Bs_Object() Bs_Object::getErrors() Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack. Bs_Object::getLastError() Basic error handling: Get last error string from the global Bs_Error-error stack. Bs_Object::getLastErrors() Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors(). Bs_Object::persist() Persists this object by serializing it and saving it to a file with unique name. Bs_Object::setError() Basic error handling: Push an error string on the global Bs_Error-error stack. Bs_Object::toHtml() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::toString() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::unpersist() Fetches an object that was persisted with persist()
### Class Details [line 28] DomApi PageControl Class uses javascript/dhtml/domapi. see http://www.domapi.com, it's great. NOTE: IE5 cannot deal with dynamic IFRAMES. To use IFRAMES as pages, you need to include it in your page as HTML then use assignElement(). dependencies: Bs_FormContainer, domapi js stuff, #### Tags:
copyright: | blueshoes.org
pattern: | singleton: (pseudostatic)
access: | public
version: | 4.3.$Revision: 1.4 $ $Date: 2003/10/29 17:48:39 $
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $domApiAlign = 'top' [line 60] Where the tabs show up in the control. Currently, valid entries are "top" (default) and "bottom". this is a domapi specific setting. #### Tags:
see: | the other $domApiSOMETHING vars.
access: | public
Type: | string
[ Top ] #### $domApiDefaultOpen = [line 104] the tab (name) that is selected/open by default. if that name does not exist or something else fails, whatever, then the default tab is the first tab. #### Tags:
todo: | implement this
see: | the other $domApiSOMETHING vars.
access: | public
Type: | string
[ Top ] #### $domApiDoRollover = TRUE [line 38] adds a mouseover effect to the tabs (where you click). this is a domapi specific setting. #### Tags:
var: | (default is TRUE.)
see: | the other $domApiSOMETHING vars.
access: | public
Type: | bool
[ Top ] #### $domApiEnabled = TRUE [line 48] i recommend that you do not use this var. it may not be fully implemented. i don't see a use for it. this is a domapi specific setting. #### Tags:
var: | (default is TRUE.)
see: | the other $domApiSOMETHING vars.
access: | public
Type: | bool
[ Top ] #### $domApiHeight = 300 [line 76] the height of the page control in pixels. #### Tags:
var: | (default is 300)
see: | the other $domApiSOMETHING vars.
access: | public
Type: | int
[ Top ] #### $domApiWidth = 400 [line 68] the width of the page control in pixels. #### Tags:
var: | (default is 400)
see: | the other $domApiSOMETHING vars.
access: | public
Type: | int
[ Top ] ### Class Methods ### constructor Bs_DaFormPageControl [line 111]
`Bs_DaFormPageControl Bs_DaFormPageControl( )`
constructor [ Top ] ### method getElement [line 180]
`string &getElement( )`
Return some html code to display the element on a website in a form. #### Tags:
return: | some html code
access: | public
Overrides Bs_FormContainer::getElement() (Return some html code to display the element on a website in a form.) [ Top ] ### method setTab [line 160]
`void setTab( string $name, mixed $caption, mixed &$content, [string $type = 'DIV'])`
adds (or replaces) a new tab to this page control. params: because the $caption can be different for different languages, we need something to uniquely identify each tab. that's why we need the $name. the $type defines what tag the content should be. the possibilities are: 'DIV' (default). this is used if the content of the tab is a container. 'P' the content is a container too. but we use a paragraph tag instead of a div. domapi offers that feature. dunno what it's good for. 'IFRAME' can be used to have another page displayed in that tabs content. the $content depends on $type. for 'DIV' and 'P' it is a container. for 'IFRAME' it is the url for the page to show. note that the param is taken by reference. so if you're going to pass an url you need to assign the url to a var first. the referency is absolutely needed for containers. examples: setTab('tabA', 'A', $myContainer); setTab('tabB', array('en'=>'Bee', 'de'=>'Bii'), $url='http://www.blueshoes.org/', 'IFRAME'); #### Tags:
see: | var $_domApiTabsReady
access: | public
#### Parameters:
string | $name | (internally used name for this tab.)
mixed | $caption | (string or hash cause it's language dependant.)
mixed | &$content | (object or string, see above.)
string | $type | ('DIV' (default), 'P' or 'IFRAME', see above.)
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:08:37 +0100 by phpDocumentor 1.2.3