Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcTreeVisitorYUIOptions

Tree::ezcTreeVisitorYUIOptions

Class ezcTreeVisitorYUIOptions

Class containing the options for the ezcTreeVisitorYUIOptions class.

Source for this file: /Tree/src/options/visitor_yui.php

ezcBaseOptions
   |
   --ezcTreeVisitorYUIOptions
Version:   //autogentag//

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)
Exceptions:
Type Description
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.
Documentation generated by phpDocumentor 1.4.3