Class: HTMLCheckBox

Source Location: /forms/items/HTMLCheckBox.class.php

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --ABSTHTMLFormItem
         |
         --HTMLCheckBox

A class to generate checkboxes.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.2.61

Copyright:

Copyright (C) 2003 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Variables

Methods

Inherited Variables

Class: ABSTHTMLFormItem

ABSTHTMLFormItem::$enabled
ABSTHTMLFormItem::$label_obj
ABSTHTMLFormItem::$manipulateable
ABSTHTMLFormItem::$parentform

Class: ABSTHTMLTag

ABSTHTMLTag::$blur
ABSTHTMLTag::$click
ABSTHTMLTag::$focus
ABSTHTMLTag::$freestyle
ABSTHTMLTag::$id
ABSTHTMLTag::$mousemove
ABSTHTMLTag::$mouseout
ABSTHTMLTag::$mouseover
ABSTHTMLTag::$mouseup
ABSTHTMLTag::$name
ABSTHTMLTag::$no_format
ABSTHTMLTag::$other_attributes
ABSTHTMLTag::$style_class

Inherited Methods

Class: ABSTHTMLFormItem

ABSTHTMLFormItem::addValue(): Concats the given string to the value of this item's "value"-attribute.
ABSTHTMLFormItem::disable(): Disables this item. This method is an alias for the method setDisabled().
ABSTHTMLFormItem::enable(): Enables this item. This method is an alias for the method setDisabled().
ABSTHTMLFormItem::getCheckOrder(): Blind method cause other objects will invoke it.
ABSTHTMLFormItem::getLabel(): Returns the label to the extended extended underlying form component as string.
ABSTHTMLFormItem::getValidationOrder(): Blind method cause other objects will invoke it.
ABSTHTMLFormItem::getValue(): Returns the value of this item's "value"-attribute.
ABSTHTMLFormItem::HTMLFormItem(): Constructor
ABSTHTMLFormItem::setDisabled(): Disables this item.
ABSTHTMLFormItem::setEnabled(): Enables this item.
ABSTHTMLFormItem::setLabel(): Stores the given label object to the extended underlying form component.
ABSTHTMLFormItem::setManipulateable(): Makes sure that this item is manipulateable by the user.
ABSTHTMLFormItem::setNotManipulateable(): Makes sure that this item is not manipulateable by the user, but carrys the value trough the form.
ABSTHTMLFormItem::setParentForm(): Stores a reference to the form-object that contains this item-object.
ABSTHTMLFormItem::setValue(): Stores the value of this item's "value"-attribute.

Class: ABSTHTMLTag

ABSTHTMLTag::getId(): Returns the value of this tag's "id"-attribute.
ABSTHTMLTag::getName(): Returns the value of this tag's "name"-attribute.
ABSTHTMLTag::HTMLTag(): The Constructor let the script die, cause this is an abstract class!
ABSTHTMLTag::idExists(): Stores all used ids and makes sure that every id in the document is unique. It should called in every get method of classes in the packages forms and html.
ABSTHTMLTag::setAttributes(): This method allows to set the attributes of the tag that are not handled by other methods.
ABSTHTMLTag::setFreeStyle(): Set the value of style definitions that are not handled by implemented methods.
ABSTHTMLTag::setId(): Stores the value of this item's "id"-attribute.
ABSTHTMLTag::setName(): Stores the value of this tag's "name"-attribute.
ABSTHTMLTag::setNoFormat(): Stores that the HTML-elements should not format by "\r\n" in the source.
ABSTHTMLTag::setOnBlur(): Sets the value of the blur-attribute of this html-tag.
ABSTHTMLTag::setOnClick(): Sets the value of the click-attribute of this html-tag.
ABSTHTMLTag::setOnFocus(): Sets the value of the focus-attribute of this html-tag.
ABSTHTMLTag::setOnMouseMove(): Sets the value of the mousemove-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOut(): Sets the value of the mouseout-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOver(): Sets the value of the mouseover-attribute of this html-tag.
ABSTHTMLTag::setOnMouseUp(): Sets the value of the mouseup-attribute of this html-tag.
ABSTHTMLTag::setStyle(): Set the value of the class-attribute of this tag.

Class: ABSTObject

ABSTObject::printComplexData(): Prints out the more complex data by the given array.
ABSTObject::printPrimitiveData(): Prints out the primitive data by the given arrays.
ABSTObject::printStructure(): Prints out the Structure of this Object.
ABSTObject::same(): Checks whether the passed object reference points to this object.
ABSTObject::sameReferences(): Compares two references whether they points to the same object

Class Details

[line 59]
A class to generate checkboxes.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.2.61
copyright:	Copyright (C) 2003 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$checked = false

[line 70]

Tags:

access:

public

Type:

boolean

[ Top ]

$label_position_right = true

[line 75]

Tags:

access:

public

Type:

boolean

[ Top ]

$value = 1

[line 65]

Tags:

access:

public

Type:	integer
Overrides:	Array

[ Top ]

Class Methods

static method getJSCheckAllInForm [line 269]

static string getJSCheckAllInForm(
)

Returns a javascript to check all checkboxes in a given form. You have to give the name of the form and the element which should not checked in the javascript function.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.9
access:	public

[ Top ]

static method getJSCheckAllWithAncestor [line 175]

static string getJSCheckAllWithAncestor(
)

Returns a javascript to check all checkboxes in a given form. You have to give the name of the form and the element which should not checked in the javascript function.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.2.0
access:	public

[ Top ]

static method getJSManageAllCheckboxesByOne [line 328]

static string getJSManageAllCheckboxesByOne(
)

Returns a javascript to check and uncheck all checkboxes in a given form by one checkbox.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.9
access:	public

[ Top ]

static method getJSManageAllCheckboxesWithAnchestorByOne [line 238]

static string getJSManageAllCheckboxesWithAnchestorByOne(
)

Returns a javascript to check and uncheck all checkboxes in a given form by one checkbox.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.9
access:	public

[ Top ]

static method getJSUncheckAllInForm [line 299]

static string getJSUncheckAllInForm(
)

Returns a javascript to check all checkboxes in a given form. You have to give the name of the form and the element which should not unchecked in the javascript function.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.9
access:	public

[ Top ]

static method getJSUncheckAllWithAncestor [line 207]

static string getJSUncheckAllWithAncestor(
)

Returns a javascript to uncheck all checkboxes in a given form. You have to give the name of the form and the element which should not checked in the javascript function.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.2.0
access:	public

[ Top ]

constructor HTMLCheckBox [line 91]

HTMLCheckBox HTMLCheckBox(
string
$name, [string
$checked = false], [string
$label = ""])

Constructor

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.41
since:	0.1.0
access:	public

Parameters:

string	$name
string	$checked
string	$label

[ Top ]

method get [line 471]

string get(
[
$forminput = ""])

Returns a generated string based on the attributes of this object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.52
since:	0.1.0
access:	public

Parameters:

$forminput

[ Top ]

method getChangeOrder [line 138]

string getChangeOrder(
)

Returns an if-order of a javascript to check whether this item is NOT filled

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.5
access:	public

[ Top ]

method getChecked [line 123]

boolean getChecked(
)

Returns if the checkbox is declared is checked.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.2
access:	public

[ Top ]

method getCheckOrder [line 153]

string getCheckOrder(
)

Returns an if-order of a javascript to check whether this item is NOT filled

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.5
access:	public

Overrides ABSTHTMLFormItem::getCheckOrder() (Blind method cause other objects will invoke it.)

[ Top ]

method getPHPSource [line 439]

string getPHPSource(
)

Generates the sourcecode to build this object and returns it.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.0
access:	public

[ Top ]

method setChangeOrder [line 425]

string setChangeOrder(

$string, string
$formname)

Sets the onChange-Attribute of the checkbox.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.5
access:	public

Parameters:

string	$formname
	$string

[ Top ]

method setChecked [line 355]

string setChecked(
[boolean
$boolean = true])

Sets this checkbox checked.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.22
since:	0.1.5
access:	public

Parameters:

boolean

$boolean

[ Top ]

method setLabel [line 370]

string setLabel(

&$mixed, mixed
$mixed)

Sets the label of this checkbox.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.21
since:	0.1.5
access:	public

Overrides ABSTHTMLFormItem::setLabel() (Stores the given label object to the extended underlying form component.)

Parameters:

mixed	$mixed
	&$mixed

[ Top ]

method setLabelPositionLeft [line 410]

void setLabelPositionLeft(
)

Sets the position of the label to the left side.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.2.6
access:	public

[ Top ]

method setLabelPositionRight [line 396]

void setLabelPositionRight(
)

Sets the position of the label to the right side.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.2.6
access:	public

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:12:01 +0200 by phpDocumentor 1.4.1