Packageimpression.players
Classpublic class CanvasElementActionTypes
InheritanceCanvasElementActionTypes Inheritance Object

The CanvasElementActionTypes class defines known values for the ActionType persisted property of a CanvasElement.



Public Properties
 PropertyDefined By
  COMMAND : String = command
[static] Interacting with the element should cause the shell to perform a custom action.
CanvasElementActionTypes
  DISPLAY_RANGE : String = displayRange
[static] Interacting with the element should cause the shell to display a range of storyboards.
CanvasElementActionTypes
  HYPERLINK : String = hyperlink
[static] Interacting with the element should cause the shell to perform a custom action.
CanvasElementActionTypes
  JUMP : String = jump
[static] Interacting with the element should cause the shell to display a new storyboard.
CanvasElementActionTypes
  NONE : String
[static] No action is defined for the element.
CanvasElementActionTypes
  PLAY_SOUND : String = playSound
[static] Interacting with the element should cause the shell to play a sound.
CanvasElementActionTypes
  POPUP_GRAPHIC : String = popupGraphic
[static] Interacting with the element should cause the shell to display a graphic.
CanvasElementActionTypes
  POPUP_TEXT : String = popupText
[static] Interacting with the element should cause the shell to display additional text.
CanvasElementActionTypes
Public Methods
 MethodDefined By
  
getActionType(action:String):String
[static] Returns the CanvasElementActionType constant value associated with a string.
CanvasElementActionTypes
Property Detail
COMMANDproperty
public static var COMMAND:String = command

Interacting with the element should cause the shell to perform a custom action.

The Command persisted property will contain information about the command to perform.

DISPLAY_RANGEproperty 
public static var DISPLAY_RANGE:String = displayRange

Interacting with the element should cause the shell to display a range of storyboards.

The Range persisted property will specify the range of storyboards to display.

HYPERLINKproperty 
public static var HYPERLINK:String = hyperlink

Interacting with the element should cause the shell to perform a custom action.

The Command persisted property will contain information about the command to perform.

JUMPproperty 
public static var JUMP:String = jump

Interacting with the element should cause the shell to display a new storyboard.

The Destination persisted property will specify the storyboard to display.

NONEproperty 
public static var NONE:String

No action is defined for the element.

PLAY_SOUNDproperty 
public static var PLAY_SOUND:String = playSound

Interacting with the element should cause the shell to play a sound.

The Sound persisted property will specify the sound to play.

POPUP_GRAPHICproperty 
public static var POPUP_GRAPHIC:String = popupGraphic

Interacting with the element should cause the shell to display a graphic.

The PopupGraphic persisted property will specify the graphic to display.

POPUP_TEXTproperty 
public static var POPUP_TEXT:String = popupText

Interacting with the element should cause the shell to display additional text.

The PopupText persisted property will specify the additional text to display.

Method Detail
getActionType()method
public static function getActionType(action:String):String

Returns the CanvasElementActionType constant value associated with a string.

Parameters

action:String — The value to get the constant value of. If the value is a case-insensitive version of one of the CanvasElementActionType constant values, the constant value is returned; otherwise, action is returned.

Returns
String — A CanvasElementActionType constant value, or action.