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

Class: Control

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

Class Overview

Object
   |
   --Control

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


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Child classes:

Link
Ссылка для панели инструментов
Select
Выпадающий список
Separator
Разделитель элементов управления на панели инструментов
Container
Выпадающее меню
Button
Кнопка панели инструментов

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 21]
Элемент управления панели инструментов



Tags:

author:   dr.Pavka
abstract:  


[ Top ]


Class Variables

$attributes = array()

[line 57]

Дополнительные атрибуты



Tags:

access:   private

Type:   array


[ Top ]

$disabled =  false

[line 49]

Доступность элемента



Tags:

access:   private

Type:   boolean


[ Top ]

$doc =

[line 33]

Документ



Tags:

access:   protected

Type:   DOMDocument


[ Top ]

$index =  false

[line 74]

Индекс элемента.

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




Tags:

access:   private

Type:   int


[ Top ]

$toolbar =

[line 65]

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



Tags:

access:   private

Type:   ToolBar


[ Top ]

$type =  false

[line 41]

Тип элемента



Tags:

access:   protected

Type:   string


[ Top ]



Class Methods


constructor __construct [line 86]

Control __construct( string $id, string $action, string $image, string $title, string $tooltip)

Конструктор



Tags:

access:   public


Overridden in child classes as:

Link::__construct()
Конструктор
Select::__construct()
Separator::__construct()
Конструктор класса
Container::__construct()
Конструктор класса
Button::__construct()
Конструктор
Submit::__construct()
Конструктор
Switcher::__construct()

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

Parameters:

string   $id  
string   $action  
string   $image  
string   $title  
string   $tooltip  

[ Top ]

method attach [line 100]

void attach( Toolbar $toolbar)

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



Tags:

access:   public


Parameters:

Toolbar   $toolbar  

[ Top ]

method build [line 250]

DOMNode build( )

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



Tags:

access:   public


Overridden in child classes as:

Select::build()
Переопределенный вывод елемента
Container::build()
Switcher::build()

[ Top ]

method disable [line 180]

void disable( )

Отключает элемент (делает его недоступным).



Tags:

access:   public


[ Top ]

method enable [line 190]

void enable( )

Включает элемент.



Tags:

access:   public


[ Top ]

method getAttribute [line 227]

mixed getAttribute( string $attrName)

Возвращает значение атрибута.



Tags:

access:   public


Parameters:

string   $attrName  

[ Top ]

method getID [line 240]

string getID( )

Возвращает идентификатор



Tags:

access:   public


[ Top ]

method getIndex [line 134]

int getIndex( )

Возвращает индекс элемента.

Вызывается из панели инструментов (Toolbar).




Tags:

access:   public


[ Top ]

method getToolbar [line 111]

Toolbar getToolbar( )

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



Tags:

access:   protected


[ Top ]

method getType [line 200]

string getType( )

Возвращает тип элемента.



Tags:

access:   public


[ Top ]

method loadFromXml [line 148]

void loadFromXml( $description)

Загрузка элемента из XML-описания.



Tags:

access:   public


Overridden in child classes as:

Select::loadFromXml()
Перегружаем родительский метод для получения возможности загрузить значения опций
Container::loadFromXml()

Parameters:

SimpleXMLElement   $description  

[ Top ]

method setAttribute [line 216]

void setAttribute( string $attrName, mixed $attrValue)

Устанавливает значение атрибута.



Tags:

access:   public


Parameters:

string   $attrName  
mixed   $attrValue  

[ Top ]

method setIndex [line 123]

void setIndex( int $index)

Устанавливает индекс элемента.

Вызывается из панели инструментов (Toolbar).




Tags:

access:   public


Parameters:

int   $index  

[ Top ]

method translate [line 271]

type translate( [array $attrs = array('title', 'tooltip')])

Переводит языко-зависимые атрибуты.



Tags:

access:   public


Parameters:

array   $attrs   перечень атрибутов дялш перевода

[ Top ]


Class Constants

TAG_NAME =  'control'

[line 25]

Имя тега элемента


[ Top ]


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