|
|
|
File: C:/usr/local/lib/php/blueshoes-4.2/core/html/form/domapi/Bs_DaFormPageControl.class.php
BlueShoes Application Framework - Form
Bs_DaFormPageControl
Bs_Object
|
+-- Bs_FormElement
|
+-- Bs_DaFormPageControl
Form Element Class
|
private class Bs_DaFormPageControl extends Bs_FormElement
Form Element Class
basic implementation of an html form element. is never instanced alone,only extended by one of the following classes:- FormField - FormText- FormContainer - FormHtml- FormImage - FormPhp- FormLinedependencies: Bs_ObjPersisterForMySql
| Authors | andrej arn <andrej@arn.li> |
| Version | 4.0.$id$ |
| Copyright | blueshoes.org |
|
| |
|
|
|
Methods inherited from Bs_Object |
| isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean |
|
|
|
Fields inherited from Bs_FormElement |
| $persister, $persisterid, $_form, $name, $elementtype, $formid, $container, $orderid, $elementstringformat, $persistervarsettings, $this |
|
Public Field Summary |
| string |
$domApiDoRolloveradds a mouseover effect to the tabs (where you click). |
| string |
$domApiEnabledi recommend that you do not use this var. it may not be fully implemented. |
| string |
$domApiAlignWhere the tabs show up in the control. |
| integer |
$domApiWidththe width of the page control in pixels. |
| integer |
$domApiHeightthe height of the page control in pixels. |
| string |
$domApiDefaultOpenthe tab (name) that is selected/open by default. |
|
|
|
|
|
Public Method Details |
Bs_DaFormPageControl |
|
public void Bs_DaFormPageControl( )
|
| |
constructor
|
| Returns |
void |
|
setTab |
|
public void setTab( string $name, mixed $caption, mixed &$content, [ string $type ] )
|
| |
adds (or replaces) a new tab to this page control.
params:because the $caption can be different for different languages, we needsomething 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 insteadof 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 passan url you need to assign the url to a var first. the referency isabsolutely needed for containers.examples:setTab('tabA', 'A', $myContainer);setTab('tabB', array('en'=>'Bee', 'de'=>'Bii'), $url='http://www.blueshoes.org/', 'IFRAME');
|
| Parameter |
|
| 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'<< |
|
('DIV' (default), 'P' or 'IFRAME', see above.) |
|
| Returns |
void |
| See Also |
$_domApiTabsReady |
|
&getElement |
|
public string &getElement( )
|
| |
Return some html code to display the element on a website in a form.
|
| Returns |
string some html code |
|
|
Public Field Details |
$domApiDoRollover |
|
public string $domApiDoRollover
>>TRUE<<
adds a mouseover effect to the tabs (where you click).
this is a domapi specific setting.
|
|
$domApiEnabled |
|
public string $domApiEnabled
>>TRUE<<
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.
|
|
$domApiAlign |
|
public string $domApiAlign
>>'top'<<
Where the tabs show up in the control.
Currently, valid entries are "top" (default) and "bottom".this is a domapi specific setting.
|
|
$domApiWidth |
|
public integer $domApiWidth
>>400<<
the width of the page control in pixels.
|
|
$domApiHeight |
|
public integer $domApiHeight
>>300<<
the height of the page control in pixels.
|
|
$domApiDefaultOpen |
|
public string $domApiDefaultOpen
>>
the tab (name) that is selected/open by default.
if that name does not exist or something else fails, whatever, thenthe default tab is the first tab.
|
|
|
Private Field Details |
$_domApiTabsReady |
|
private array $_domApiTabsReady
>>
the tabs to use for that page control.
data structure: hash where the key is the tab name. the value is ahash with these keys:'caption' => string or array, language dependant'type' => 'DIV', 'P' or 'IFRAME''content' => (object) reference to a container, or (string) url
|
| See Also |
setTab() |
|
|
|
|
|
|
|
| PHPDoc 1.0beta |
