CS3 JS: DrawState

CS3 ScriptUI

DrawState

 

Describes an input state at the time of the triggering  ScriptUIGraphics.onDraw() event.

Contains properties that report whether the current control has the input focus, and the particular mouse button and keypress state. Passed in as argument to ScriptUIGraphics.onDraw().

Properties

PropertyTypeAccessDescription
altKeyPressedboolreadonlyTrue if the Alt key is being pressed (in Windows only).
capsLockKeyPressedboolreadonlyTrue if the Caps Lock key is being pressed.
cmdKeyPressedboolreadonlyTrue if the Command key is being pressed (in Mac OS only).
ctrlKeyPressedboolreadonlyTrue if the Ctrl key is being pressed.
hasFocusboolreadonlyTrue if the element has the input focus.
leftButtonPressedboolreadonlyTrue if the left mouse button is being pressed.
middleButtonPressedboolreadonlyTrue if the middle mouse button is being pressed.
mouseOverboolreadonlyTrue if the cursor is hovering over this element.
numLockKeyPressedboolreadonlyTrue if the Num Lock key is being pressed.
optKeyPressedboolreadonlyTrue if the Option key is being pressed (in Mac OS only).
rightButtonPressedboolreadonlyTrue if the right mouse button is being pressed.
shiftKeyPressedboolreadonlyTrue if the Shift key is being pressed.

Used in

ScriptUIGraphics.onDraw (drawState:DrawState)

Contents :: Index