Path

ez components / documentation / api reference / 2009.2.1 / tree


eZ Components 2009.2.1

Tree: ezcTreeVisitorYUIOptions

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcTreeVisitorYUIOptions

Class containing the options for the ezcTreeVisitorYUIOptions class. [source]

Parents

ezcBaseOptions
   |
   --ezcTreeVisitorYUIOptions

Properties

string read/write  $basePath
Which string to prefix the href-targets with.
bool read/write  $displayRootNode
Whether the root node should be displayed. The root node will still be disabled from the links that the visitor create when $selectedNodeLink is set to true.
array(string) read/write  $highlightNodeIds
Which IDs should have the 'highlight' CSS class added.
bool read/write  $selectedNodeLink
If enabled, only the requested node is shown in links, and not the full path.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcTreeVisitorYUIOptions __construct( [$options = array()] )
Constructs an object with the specified values.

Inherited Methods

From ezcBaseOptions :
public ezcBaseOptions ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.

Methods

__construct

ezcTreeVisitorYUIOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed)  

Throws

ClassDescription
ezcBaseValueException if $options contains a property with a value not allowed
ezcBasePropertyNotFoundException if $options contains a property not defined

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

Last updated: Tue, 23 Mar 2010