VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: PropertyEditor

Source Location: /designide.inc.php

Class Overview

Object
   |
   --PropertyEditor

Base class for property editors


Variables

Methods


Child classes:

ColorPropertyEditor
Editor for Color properties
StringListPropertyEditor
Property Editor for StringLists
ArrayPropertyEditor
Array editor
ItemsPropertyEditor
Items property editor, for menus and treeviews
HTMLPropertyEditor
HTML property editor, for captions and so on
ImagePropertyEditor
Image property editor - not finished

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Constructs an object and initializes its data before the object is first used.
Object::className()
Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs()
Determines whether an object is of a specific type.
Object::classParent()
Returns the type of the immediate ancestor of a class.
Object::inheritsFrom()
Determines the relationship of two object types.
Object::methodExists()
Check if a method exists declared on this object instance.
Object::readProperty()
Reads a property from the streams
Object::__get()
To virtualize properties
Object::__set()
To virtualize properties

Class Details

[line 297]
Base class for property editors

Use this class if you want to wrote Property Editors in pure PHP.




[ Top ]


Class Variables

$value =

[line 299]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


method Execute [line 336]

void Execute( string $current_value)

Executes the property editor

This method is called when executing a property editor from the IDE, and in $current_value, you get the property value in string format.




Overridden in child classes as:

ColorPropertyEditor::Execute()
StringListPropertyEditor::Execute()
ArrayPropertyEditor::Execute()
ItemsPropertyEditor::Execute()
HTMLPropertyEditor::Execute()
ImagePropertyEditor::Execute()

Parameters:

string   $current_value   Current property value

[ Top ]

method getAttributes [line 310]

array getAttributes( )

Return specific attributes for the OI

Override this method and return an array of properties to specify the IDE how to show and handle this property editor.




Tags:



Overridden in child classes as:

ColorPropertyEditor::getAttributes()
StringListPropertyEditor::getAttributes()
ArrayPropertyEditor::getAttributes()
ItemsPropertyEditor::getAttributes()
HTMLPropertyEditor::getAttributes()
ImagePropertyEditor::getAttributes()

[ Top ]

method getOutputPath [line 322]

string getOutputPath( )

If required, returns a path to become the document root for the webserver to call the property editor

If your property editor requires some POST, is better to provide a document root to the IDE so it knows how to work.




Overridden in child classes as:

ColorPropertyEditor::getOutputPath()
StringListPropertyEditor::getOutputPath()
ArrayPropertyEditor::getOutputPath()
ItemsPropertyEditor::getOutputPath()
HTMLPropertyEditor::getOutputPath()
ImagePropertyEditor::getOutputPath()

[ Top ]


Documentation generated on Sat, 13 Jun 2009 10:51:30 -0700 by phpDocumentor 1.4.1