Class: FileSelect

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

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --ABSTHTMLFormItem
         |
         --HTMLSelect
            |
            --FileSelect

A class to generate select fields to choose a file on the filesystem.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.4

Copyright:

Copyright (C) 2004 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

Inherited Methods

Class: HTMLSelect

HTMLSelect::HTMLSelect(): Constructor
HTMLSelect::addOption(): Adds an option to this this select.
HTMLSelect::addOptionAt(): Adds an option to this this select at a specified position.
HTMLSelect::get(): Returns a generated string based on the attributes of this object.
HTMLSelect::getChangeOrder(): Returns the javascript that should execute if the value this select changes.
HTMLSelect::getCheckOrder(): Returns an if-order of a javascript to check whether this item is NOT filled
HTMLSelect::getClone(): Returns a clone of this object.
HTMLSelect::getJS2getAllValuesFrom(): Returns an javascript-function to get all values from a given select as an array.
HTMLSelect::getJS2getSelectedOption(): Returns an javascript-function to get the selectedoption-object of a given select.
HTMLSelect::getJS2getSelectedValue(): Returns an javascript-function to get the value of a given select.
HTMLSelect::getJS2moveItem(): Returns an javascript-function to move the selected items of a select to another.
HTMLSelect::getJS2selectValue(): Returns an javascript-function to get the value of a given select.
HTMLSelect::getLabelArr(): Returns the array containing the labels of this select.
HTMLSelect::getPHPSource(): Generates the sourcecode to build this object and returns it.
HTMLSelect::getSelectedLabel(): Returns the selected label of this select.
HTMLSelect::getSelectedValue(): Returns the selected value of this select.
HTMLSelect::getStandardLabel(): Returns the standard label of this select.
HTMLSelect::getValueArr(): Returns the array containing the valuess of this select.
HTMLSelect::setAlternativeTextOnHidden(): Set the text that should appear if the select is hidden, cause of zero count of options.
HTMLSelect::setChangeOrder(): Sets the javascript that should execute if the value of the select changes
HTMLSelect::setCharset(): Sets the charset for the optionlabels of this select.
HTMLSelect::setFreeStyles(): Sets the style attributes of the options of this select in order to the given array.
HTMLSelect::setLabels(): Sets the labels of this select in order to the given array.
HTMLSelect::setMultiple(): Sets this select to be able in selecting multiple values.
HTMLSelect::setSingleValueTemplate(): If the single value template is set, then the method get() will only output the parsed template instead of the selectbox. You can use the template variable [#label#] to place the single label in the template string.
HTMLSelect::setSize(): Sets the size-attribute of this select.
HTMLSelect::setStandardLabel(): Sets the label of this select that schould be shown if no value is selected.
HTMLSelect::setStyles(): Sets the style classes of the options of this select in order to the given array.
HTMLSelect::setValues(): Sets the values of this select in order to the given array.
HTMLSelect::showAltoughOnZeroLabelCount(): Sets whether the select schould be shown if no value is presented on it.
HTMLSelect::showStandardLabel(): Sets whether the standardlabel of this select schould be shown if no value is selected to.

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 53]
A class to generate select fields to choose a file on the filesystem.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.4
copyright:	Copyright (C) 2004 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

$dir =

[line 59]

Tags:

access:

private

Type:

string

[ Top ]

$outputKind =

[line 64]

Tags:

access:

private

Type:

integer

[ Top ]

Class Methods

constructor FileSelect [line 88]

FileSelect FileSelect(
string
$name, string
$dir, [string
$selectedFile = ""], [string
$onChangeOrder = ""], [integer
$outputKind = FILEORFOLDER])

Constructor

Tags:

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

Parameters:

string	$name	Name of the select.
string	$dir	The directory to read.
string	$selectedFile	The selected file in the read directory.
string	$onChangeOrder	The javascript order that should execute if the value of the select changes.
integer	$outputKind	The defined integer code to manipulate the behaviour of the select, in the kind that only files will be show, only folder will be show or both, files and folder, will be display. See the uses part for more information.

[ Top ]

method getClone [line 175]

object getClone(
string
$newName, 
$selectedValue)

Returns a clone of this object.

Tags:

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

Overrides HTMLSelect::getClone() (Returns a clone of this object.)

Parameters:

string	$newName
	$selectedValue

[ Top ]

method getDir [line 201]

string getDir(
)

Returns the directory which content should be display by this select.

Tags:

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

[ Top ]

method getOutputKind [line 215]

integer getOutputKind(
)

Returns the value of the kind of output ( FILE, FOLDER, FILEORFOLDER ).

Tags:

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

[ Top ]

method refresh [line 286]

void refresh(
)

This method refreshes the new entries.

Tags:

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

[ Top ]

method setDir [line 229]

string setDir(

$dir)

Sets the directory which content should be display by this select.

Tags:

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

Parameters:

$dir

[ Top ]

method setOutputKind [line 247]

integer setOutputKind(

$int)

Sets the value of the kind of output ( FILE, FOLDER, FILEORFOLDER ).

Tags:

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

Parameters:

$int

[ Top ]

method SOKH [line 267]

void SOKH(
integer
$int)

This method is importantly only for private use of the class, otherwise there it can cause side effects, because the object attributes will not be refresh.

Tags:

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

Parameters:

integer

$int

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:11:29 +0200 by phpDocumentor 1.4.1