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

Class: Switcher

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

Class Overview

Object
   |
   --Control
      |
      --Button
         |
         --Switcher

Переключатель


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Button

Button::__construct()
Конструктор
Button::getAction()
Возвращает имя действия
Button::getImage()
Возвращает путь к изображению
Button::getTitle()
Возвращает название кнопки
Button::getTooltip()
Возвращает всплывающую подсказку
Button::setTitle()
Устанавливает название кнопки
Button::setTooltip()
Устанавливает всплывающую подсказку

Class: Control

Control::__construct()
Конструктор
Control::attach()
Привязываем элемент управления к панели управления
Control::build()
Построение элемента управления.
Control::disable()
Отключает элемент (делает его недоступным).
Control::enable()
Включает элемент.
Control::getAttribute()
Возвращает значение атрибута.
Control::getID()
Возвращает идентификатор
Control::getIndex()
Возвращает индекс элемента.
Control::getToolbar()
Возвращает панель управления
Control::getType()
Возвращает тип элемента.
Control::loadFromXml()
Загрузка элемента из XML-описания.
Control::setAttribute()
Устанавливает значение атрибута.
Control::setIndex()
Устанавливает индекс элемента.
Control::translate()
Переводит языко-зависимые атрибуты.

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


[ Top ]


Class Variables

$state =  false

[line 28]

Состояние переключателя



Tags:

access:   private

Type:   boolean


[ Top ]



Class Methods


constructor __construct [line 30]

Switcher __construct( $id, [ $action = false], [ $image = false], [ $title = false], [ $tooltip = false])



Tags:

access:   public


Overrides Button::__construct() (Конструктор)

Parameters:

   $id  
   $action  
   $image  
   $title  
   $tooltip  

[ Top ]

method build [line 64]

void build( )



Tags:

access:   public


Overrides Control::build() (Построение элемента управления.)

[ Top ]

method getState [line 41]

boolean getState( )

Возвращает состояние переключателя



Tags:

access:   public


[ Top ]

method setState [line 51]

void setState( boolean $state)

Устанавливает состояние переключателя



Tags:

access:   public


Parameters:

boolean   $state  

[ Top ]

method toggle [line 60]

boolean toggle( )

Переключает состояние



Tags:

access:   public


[ Top ]

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