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

Class: Toolbar

Source Location: /modules/share/components/Toolbar.class.php

Class Overview

Object
   |
   --Toolbar

Панель инструментов


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 18]
Панель инструментов



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

$component =

[line 70]

Присоединяет панель управления к компоненту



Tags:

access:   private

Type:   Component


[ Top ]

$controls = array()

[line 38]

Набор элементов управления



Tags:

access:   private

Type:   array


[ Top ]

$doc =

[line 30]

Документ



Tags:

access:   private

Type:   DOMDocument


[ Top ]

$imageDir =

[line 54]

Путь к директории содержащей рисунки



Tags:

access:   private

Type:   string


[ Top ]

$name =

[line 46]

Имя панели инструментов



Tags:

access:   private

Type:   string


[ Top ]

$properties = array()

[line 62]

Дополнительные свойства панели инструментов



Tags:

access:   private

Type:   array


[ Top ]



Class Methods


constructor __construct [line 80]

Toolbar __construct( string $name, [string $imageDir = false], string $module)

Конструктор



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

Parameters:

string   $name   имя тулбара
string   $imageDir   путь к директории содержащей рисунки
string   $module  

[ Top ]

method attachControl [line 128]

void attachControl( Control $control, [Control $position = null])

Присоединение элемента управления к панели



Tags:

access:   public


Parameters:

Control   $control  
Control   $position   если не указан, добавляем контрол в конец тулбара, если указан, то он добавляется в указанное место

[ Top ]

method attachToComponent [line 105]

void attachToComponent( Component $component)

Привязывает панель управления к компоненту



Tags:

access:   public


Parameters:

Component   $component  

[ Top ]

method build [line 233]

DOMNode build( )

Построение панели инструментов



Tags:

access:   public


[ Top ]

method detachControl [line 140]

void detachControl( Control $control)

Отсоединение элемента управления от панели



Tags:

access:   public


Parameters:

Control   $control  

[ Top ]

method getComponent [line 116]

Component getComponent( )

Возвращает компонент к которому привязана панель управления



Tags:

access:   public


[ Top ]

method getControlByID [line 154]

Control getControlByID( int $id)

Получение элемента управления по его идентификатору



Tags:

access:   public


Parameters:

int   $id  

[ Top ]

method getControls [line 201]

array getControls( )

Возвращает набор элементов управления



Tags:

access:   public


[ Top ]

method getName [line 93]

string getName( )

Return toolbar name



Tags:

final:  
access:   public


[ Top ]

method getProperty [line 221]

mixed getProperty( string $name)

Enter description here...



Tags:

access:   public


Parameters:

string   $name  

[ Top ]

method loadXML [line 172]

boolean loadXML( $toolbarDescription)

Построение панели инструментов по XML-описанию



Tags:

access:   public


Parameters:

SimpleXMLElement   $toolbarDescription  

[ Top ]

method setProperty [line 211]

void setProperty( string $name, mixed $value)

Enter description here...



Tags:

access:   public


Parameters:

string   $name  
mixed   $value  

[ Top ]

method translate [line 265]

void translate( )

Переводит все элементы управления



Tags:

access:   public


[ Top ]


Class Constants

TAG_NAME =  'toolbar'

[line 22]

Имя тeга


[ Top ]


В создании документации нам помог: phpDocumentor