Главная / Action Script 3
Пакетflash.display
Классpublic class SimpleButton
НаследованиеSimpleButton Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Класс SimpleButton позволяет управлять всеми экземплярами символов-кнопок в SWF-файле. Создав экземпляр кнопки в инструменте разработки, можно использовать методы и свойства класса SimpleButton для манипуляции с кнопками с помощью ActionScript.

В ActionScript 3.0 для создания экземпляра SimpleButton используется конструктор new SimpleButton().

Класс SimpleButton наследует методы и свойства класса InteractiveObject.

Посмотреть примеры

См. также

Класс InteractiveObject
Основные классы показа


Общедоступные свойства
 СвойствоОпределено
 InheritedaccessibilityProperties : AccessibilityProperties
Текущие параметры специальных возможностей для данного экранного объекта.
DisplayObject
 Inheritedalpha : Number
Указывает значение альфа-прозрачности заданного объекта.
DisplayObject
 InheritedblendMode : String
Значение класса BlendMode, задающее режим наложения.
DisplayObject
 InheritedblendShader : Shader
[только для записи] Задает затенение, используемое при наложении переднего плана на фон.
DisplayObject
 InheritedcacheAsBitmap : Boolean
При значении true проигрыватель Flash Player кэширует внутреннее растровое представление экранного объекта.
DisplayObject
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcontextMenu : ContextMenu
Определяет контекстное меню, связанное с данным объектом.
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
Определяет, получает ли объект события doubleClick.
InteractiveObject
  downState : DisplayObject
Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии Down (в котором находится кнопка, когда пользователь щелкает объект hitTestState).
SimpleButton
  enabled : Boolean
Логическое значение, которое определяет, включена ли кнопка.
SimpleButton
 Inheritedfilters : Array
Индексированный массив, который содержит все объекты filter, связанные в настоящий момент с экранным объектом.
DisplayObject
 InheritedfocusRect : Object
Задает отображение прямоугольной рамки индикатора фокуса для данного объекта.
InteractiveObject
 Inheritedheight : Number
Указывает высоту экранного объекта в пикселах.
DisplayObject
  hitTestState : DisplayObject
Задает экранный объект, который служит кнопке в качестве объекта для тестирования нажатия.
SimpleButton
 InheritedloaderInfo : LoaderInfo
[только для чтения] Возвращает объект LoaderInfo, содержащий сведения о загрузке файла, к которому принадлежит этот экранный объект.
DisplayObject
 Inheritedmask : DisplayObject
Вызывающий экранный объект маскируется заданным объектом mask.
DisplayObject
 InheritedmouseEnabled : Boolean
Определяет, получает ли этот объект сообщения мыши.
InteractiveObject
 InheritedmouseX : Number
[только для чтения] Указывает координату x положения курсора мыши (в пикселах).
DisplayObject
 InheritedmouseY : Number
[только для чтения] Указывает координату y положения курсора мыши (в пикселах).
DisplayObject
 Inheritedname : String
Указывает имя экземпляра DisplayObject.
DisplayObject
 InheritedopaqueBackground : Object
Определяет, является ли экранный объект непрозрачным с определенным цветом фона.
DisplayObject
  overState : DisplayObject
Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии Over (в котором находится кнопка, когда указатель мыши располагается над ней).
SimpleButton
 Inheritedparent : DisplayObjectContainer
[только для чтения] Указывает объект DisplayObjectContainer, содержащий данный экранный объект.
DisplayObject
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
 Inheritedroot : DisplayObject
[только для чтения] В случае с экранным объектом в загруженном SWF-файле свойством root является самый верхний экранный объект в части структуры дерева списка отображения, представленной этим SWF-файлом.
DisplayObject
 Inheritedrotation : Number
Указывает поворот экземпляра DisplayObject относительно его исходной ориентации (в градусах).
DisplayObject
 InheritedrotationX : Number
Обозначает поворот в градусах по оси x экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 InheritedrotationY : Number
Обозначает поворот в градусах по оси у экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 InheritedrotationZ : Number
Обозначает поворот в градусах по оси z экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 Inheritedscale9Grid : Rectangle
Текущая активная сетка масштабирования.
DisplayObject
 InheritedscaleX : Number
Указывает горизонтальное масштабирование объекта от точки регистрации (в процентах).
DisplayObject
 InheritedscaleY : Number
Указывает вертикальное масштабирование объекта от точки регистрации (в процентах).
DisplayObject
 InheritedscaleZ : Number
Указывает масштабирование глубины объекта (в процентах) относительно точки регистрации этого объекта.
DisplayObject
 InheritedscrollRect : Rectangle
Прямоугольная область прокрутки экранного объекта.
DisplayObject
  soundTransform : SoundTransform
Объект SoundTransform, связанный с этой кнопкой.
SimpleButton
 Inheritedstage : Stage
[только для чтения] Класс Stage экранного объекта.
DisplayObject
 InheritedtabEnabled : Boolean
Определяет, включен ли этот объект в последовательность перехода с помощью клавиши Tab.
InteractiveObject
 InheritedtabIndex : int
Задает последовательность перехода между объектами в SWF-файле.
InteractiveObject
  trackAsMenu : Boolean
Определяет, могут ли другие экранные объекты, являющиеся объектами SimpleButton или MovieClip, получать события отпускания кнопки мыши.
SimpleButton
 Inheritedtransform : Transform
Объект со свойствами, относящимися к матрице, преобразованию цвета и пиксельным границам экранного объекта.
DisplayObject
  upState : DisplayObject
Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии вверх (в котором находится кнопка, когда указатель мыши не расположен над ней).
SimpleButton
  useHandCursor : Boolean
Логическое значение. При значении true определяет, отображает ли проигрыватель Flash Player указатель "рука" при наведении указателя мыши на кнопку.
SimpleButton
 Inheritedvisible : Boolean
Определяет видимость экранного объекта.
DisplayObject
 Inheritedwidth : Number
Указывает ширину экранного объекта в пикселах.
DisplayObject
 Inheritedx : Number
Указывает координату x экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer.
DisplayObject
 Inheritedy : Number
Указывает координату y экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer.
DisplayObject
 Inheritedz : Number
Указывает положение по оси z экземпляра DisplayObject относительно трехмерного родительского контейнера.
DisplayObject
Общедоступные методы
 МетодОпределено
  
SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
Создает новый экземпляр SimpleButton.
SimpleButton
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события в объекте EventDispatcher, в результате чего прослушиватель будет получать уведомления о событиях.
EventDispatcher
 Inherited
Передает событие в поток событий.
EventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Возвращает прямоугольник, определяющий область экранного объекта, которая относится к системе координат объекта targetCoordinateSpace.
DisplayObject
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Возвращает прямоугольник, определяющий границу экранного объекта по системе координат, заданной параметром targetCoordinateSpace, за исключением линий фигур.
DisplayObject
 Inherited
Преобразует объект Point из координат рабочей области (глобальных) в координаты экранного объекта (локальные).
DisplayObject
 Inherited
Преобразует двумерный объект Point из координат рабочей области (глобальных) в координаты экранного трехмерного объекта (локальные).
DisplayObject
 Inherited
Проверяет наличие у объекта EventDispatcher прослушивателей событий, которые зарегистрированы для получения уведомлений о событиях определенного типа.
EventDispatcher
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Оценивает экранный объект, чтобы определить, перекрывает ли он экранный объект obj или пересекается с ним.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Вычисляет экранный объект, чтобы определить, перекрывает ли он точку, заданную координатами x и y, или пересекает ее.
DisplayObject
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Преобразует трехмерный объект point из координат трехмерного экранного объекта (локальных) в двухмерный объект point с координатами рабочей области (глобальными).
DisplayObject
 Inherited
Преобразует объект point из координат экранного объекта (локальных) в координаты рабочей области (глобальные).
DisplayObject
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель из объекта EventDispatcher.
EventDispatcher
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
 Inherited
Проверяет, зарегистрирован ли прослушиватель событий в объекте EventDispatcher или в любом из его предков для получения уведомлений о событиях определенного типа.
EventDispatcher
События
 Событие Сводка Определено
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player перемещается в фокус операционной системы и становится активным.EventDispatcher
 InheritedОтправляется, когда экранный объект добавляется в список отображения.DisplayObject
 InheritedОтправляется, когда экранный объект добавляется к списку отображения в рабочей области, либо непосредственно, либо путем добавления поддерева, содержащего экранный объект.DisplayObject
 InheritedОтправляется, когда пользователь выбирает команду "Удалить" в контекстном меню текста.InteractiveObject
 InheritedОтправляется, когда пользователь нажимает и отпускает главную кнопку на указывающем устройстве над одним и тем же объектом InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Копировать", или выбирает команду "Копировать" из контекстного меню.InteractiveObject
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Вырезать", или выбирает команду "Вырезать" из контекстного меню.InteractiveObject
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player покидает фокус операционной системы и становится неактивным.EventDispatcher
 InheritedОтправляется, когда пользователь дважды нажимает и отпускает главную кнопку на указывающем устройстве над одним и тем же объектом InteractiveObject, а флаг doubleClickEnabled для этого объекта имеет значение true.InteractiveObject
 Inherited[многоадресное событие] Отправляется, когда точка воспроизведения переходит в новый кадр.DisplayObject
 Inherited[многоадресное событие] Отправляется, когда точка воспроизведения покидает текущий кадр.DisplayObject
 InheritedОтправляется, когда экранный объект перемещается в фокус.InteractiveObject
 InheritedОтправляется, когда экранный объект покидает фокус.InteractiveObject
 Inherited[многоадресное событие] Отправляется после завершения работы конструкторов экранных объектов кадра до выполнения сценариев кадра.DisplayObject
 InheritedОтправляется, когда пользователь нажимает клавишу.InteractiveObject
 InheritedОтправляется, когда пользователь пытается изменить фокус с помощью клавиатуры.InteractiveObject
 InheritedОтправляется, когда пользователь отпускает клавишу.InteractiveObject
 InheritedОтправляется, когда пользователь нажимает кнопку на указывающем устройстве над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь пытается изменить фокус с помощью указывающего устройства.InteractiveObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство в момент, когда курсор находится над объектом InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство от экземпляра InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь наводит указывающее устройству на экземпляр InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь отпускает кнопку на указывающем устройстве над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь вращает колесико мыши над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Вставить", или выбирает команду "Вставить" из контекстного меню.InteractiveObject
 InheritedОтправляется перед удалением экранного объекта из списка отображения.DisplayObject
 InheritedОтправляется перед удалением экранного объекта из списка отображения, либо непосредственно, либо путем удаления поддерева, содержащего экранный объект.DisplayObject
 Inherited[многоадресное событие] Отправляется перед обновлением и визуализацией списка отображения.DisplayObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство от экземпляра InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь наводит указывающее устройство на экземпляр InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Выделить все", или выбирает команду "Выделить все" из контекстного меню.InteractiveObject
 InheritedОтправляется, когда изменяется значение свойства tabChildren объекта.InteractiveObject
 InheritedОтправляется при изменении флага tabEnabled объекта.InteractiveObject
 InheritedОтправляется, когда изменяется значение свойства tabIndex объекта.InteractiveObject
Сведения о свойстве
downStateсвойство
downState:DisplayObject  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии Down — кнопка находится в этом состоянии при щелчке объекта hitTestState.



Реализация
    public function get downState():DisplayObject
    public function set downState(value:DisplayObject):void

См. также

enabledсвойство 
enabled:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Логическое значение, которое определяет, включена ли кнопка. Когда кнопка отключена (свойство enabled имеет значение false), кнопка видима, но не реагирует на щелчок. Значение по умолчанию — true. Это свойство удобно использовать, когда требуется отключить часть элементов навигации. Например, может потребоваться отключить кнопку на отображаемой в данный момент странице, чтобы на нее нельзя было нажать и чтобы предотвратить перезагрузку страницы.

Примечание. Для предотвращения событий mouseClicks для кнопки установите оба свойства — enabled и mouseEnabled — на значение false.



Реализация
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
hitTestStateсвойство 
hitTestState:DisplayObject  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает экранный объект, который служит кнопке в качестве объекта для тестирования нажатия. Для базовой кнопки нужно задать свойству hitTestState тот же экранный объект, что и свойствуoverState. Если не задать свойство hitTestState, объект SimpleButton будет неактивным: он не будет отвечать на события мыши и клавиатуры.



Реализация
    public function get hitTestState():DisplayObject
    public function set hitTestState(value:DisplayObject):void

См. также

overStateсвойство 
overState:DisplayObject  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии Over (в котором находится кнопка, когда указатель мыши располагается над ней).



Реализация
    public function get overState():DisplayObject
    public function set overState(value:DisplayObject):void

См. также

soundTransformсвойство 
soundTransform:SoundTransform  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Объект SoundTransform, связанный с этой кнопкой. Объект SoundTransform включает свойства для настройки громкости, панорамы, назначения левого и правого динамиков. Данный объект SoundTransform применяется ко всем состояниям кнопки. Данный объект SoundTransform воздействует только на встроенные звуки.



Реализация
    public function get soundTransform():SoundTransform
    public function set soundTransform(value:SoundTransform):void

См. также

trackAsMenuсвойство 
trackAsMenu:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, могут ли другие экранные объекты, являющиеся объектами SimpleButton или MovieClip, получать события отпускания кнопки мыши. Свойство trackAsMenu позволяет создавать меню. Свойство trackAsMenu можно задать для любого объекта SimpleButton или MovieClip. Если свойство trackAsMenu не существует, по умолчанию используется значение false.

Свойство trackAsMenu можно изменить в любой момент; обновленный фрагмент ролика немедленно начинает использовать новое поведение курсора.



Реализация
    public function get trackAsMenu():Boolean
    public function set trackAsMenu(value:Boolean):void
upStateсвойство 
upState:DisplayObject  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает экранный объект, применяемый в качестве визуального объекта для отображения кнопки в состоянии вверх (в котором находится кнопка, когда указатель мыши не расположен над ней).



Реализация
    public function get upState():DisplayObject
    public function set upState(value:DisplayObject):void

См. также

useHandCursorсвойство 
useHandCursor:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Логическое значение. При значении true определяет, отображает ли проигрыватель Flash Player указатель "рука" при наведении указателя мыши на кнопку. Если этому свойству задано значение false, используется курсор "стрелка". Значение по умолчанию — true.

Свойство useHandCursor можно изменить в любой момент; обновленный фрагмент ролика немедленно начинает использовать новое поведение курсора.



Реализация
    public function get useHandCursor():Boolean
    public function set useHandCursor(value:Boolean):void
Сведения о конструкторе
SimpleButton()Конструктор
public function SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает новый экземпляр SimpleButton. Все и каждый из экранных объектов, представляющих разные состояния кнопки, можно задать в качестве параметров в конструкторе.

Параметры
upState:DisplayObject (default = null) — Начальное значение для ненажатого состояния SimpleButton.
 
overState:DisplayObject (default = null) — Начальное значение для состояния over SimpleButton.
 
downState:DisplayObject (default = null) — Начальное значение для состояния down SimpleButton.
 
hitTestState:DisplayObject (default = null) — Начальное значение для состояния hitTest SimpleButton.
Примеры Как пользоваться примерами
SimpleButtonExample.as

В следующем примере используется класс SimpleButtonExample, который в свою очередь использует класс CustomSimpleButton, и затем он создает экземпляры четырех объектов ButtonDisplayState. В результате создается квадратная кнопка, цвет фона которой изменяется в зависимости от состояния мыши путем переопределения свойств экземпляра класса SimpleButton. Это можно сделать, выполнив следующие действия.
  1. В конструкторе SimpleButtonExample() создается новый объект CustomSimpleButton типа SimpleButton с именем button при помощи конструктора CustomSimpleButton. Объект button добавляется в список отображения. Цвет и размер кнопки определяются в следующих шагах.
  2. В классе CustomSimpleButton class объявляются свойства экземпляра, которые в дальнейшем будут использоваться для управления размером и фоновым цветом объекта button в зависимости от его состояния (оранжевый в обычном состоянии, темно-желтый при наведении мыши и голубой при нажатии мыши). Во всех состояниях объекта button размер квадрата равен 80 пикселам, что определено свойством size.
  3. Функция конструктора класса CustomSimpleButton задает свойства downState, overState, upState, hitTestState и useHandCursor для всех четырех экземпляров класса ButtonDisplayState.
  4. В классе ButtonDisplayState конструктор задает значение размера и фонового цвета квадрата и вызывает метод draw().
  5. Метод draw() перерисовывает квадрат, используя размер и цвет фона, заданный в конструкторе, в зависимости от состояния кнопки.
package {
    import flash.display.Sprite;

    public class SimpleButtonExample extends Sprite {
        public function SimpleButtonExample() {
            var button:CustomSimpleButton = new CustomSimpleButton();
            addChild(button);
        }
    }
}

import flash.display.DisplayObject;
import flash.display.Shape;
import flash.display.SimpleButton;

class CustomSimpleButton extends SimpleButton {
    private var upColor:uint   = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;
    private var size:uint      = 80;

    public function CustomSimpleButton() {
        downState      = new ButtonDisplayState(downColor, size);
        overState      = new ButtonDisplayState(overColor, size);
        upState        = new ButtonDisplayState(upColor, size);
        hitTestState   = new ButtonDisplayState(upColor, size * 2);
        hitTestState.x = -(size / 4);
        hitTestState.y = hitTestState.x;
        useHandCursor  = true;
    }
}

class ButtonDisplayState extends Shape {
    private var bgColor:uint;
    private var size:uint;

    public function ButtonDisplayState(bgColor:uint, size:uint) {
        this.bgColor = bgColor;
        this.size    = size;
        draw();
    }

    private function draw():void {
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, size, size);
        graphics.endFill();
    }
}