Packagecom.brightcove.api.events
Classpublic class MenuEvent
InheritanceMenuEvent Inheritance flash.events.Event

Events specifically for the player menus.



Public Properties
 PropertyDefined By
  page : String
[read-only] Returns the name of the menu page sent with the event.
MenuEvent
  video : VideoDTO
[read-only] Returns the VideoDTO sent with the event.
MenuEvent
Public Methods
 MethodDefined By
  
MenuEvent(type:String, page:String = null, video:VideoDTO = null)
Constructor.
MenuEvent
  
clone():Event
[override] Returns a copy of the event instance.
MenuEvent
Public Constants
 ConstantDefined By
  BLOG_POST_CLICK : String = blogPostClick
[static] The MenuEvent.BLOG_POST_CLICK constant defines the value of the type property of the event object for a blogPostClick event.
MenuEvent
  COPY_CODE : String = copyCode
[static] The MenuEvent.COPY_CODE constant defines the value of the type property of the event object for a copyCode event.
MenuEvent
  COPY_LINK : String = copyLink
[static] The MenuEvent.COPY_LINK constant defines the value of the type property of the event object for a copyLink event.
MenuEvent
  MENU_PAGE_CLOSE : String = menuPageClose
[static] The MenuEvent.MENU_PAGE_CLOSE constant defines the value of the type property of the event object for a menuPageClose event.
MenuEvent
  MENU_PAGE_OPEN : String = menuPageOpen
[static] The MenuEvent.MENU_PAGE_OPEN constant defines the value of the type property of the event object for a menuPageOpen event.
MenuEvent
  OVERLAY_MENU_CLOSE : String = overlayMenuClose
[static] The MenuEvent.OVERLAY_MENU_CLOSE constant defines the value of the type property of the event object for a overlayMenuClose event.
MenuEvent
  OVERLAY_MENU_OPEN : String = overlayMenuOpen
[static] The MenuEvent.OVERLAY_MENU_OPEN constant defines the value of the type property of the event object for a overlayMenuOpen event.
MenuEvent
  OVERLAY_MENU_PLAY_CLICK : String = overlayMenuPlayClick
[static] The MenuEvent.OVERLAY_MENU_PLAY_CLICK constant defines the value of the type property of the event object for a overlayMenuPlayClick event.
MenuEvent
  SEND_EMAIL_CLICK : String = sendEmailClick
[static] The MenuEvent.SEND_EMAIL_CLICK constant defines the value of the type property of the event object for a sendEmailClick event.
MenuEvent
  VIDEO_REQUEST : String = videoRequest
[static] The MenuEvent.VIDEO_REQUEST constant defines the value of the type property of the event object for a videoRequest event.
MenuEvent
Property Detail
pageproperty
page:String  [read-only]

Returns the name of the menu page sent with the event.


Implementation
    public function get page():String
videoproperty 
video:VideoDTO  [read-only]

Returns the VideoDTO sent with the event.


Implementation
    public function get video():VideoDTO
Constructor Detail
MenuEvent()Constructor
public function MenuEvent(type:String, page:String = null, video:VideoDTO = null)

Constructor.

Parameters
type:String — name if the event.
 
page:String (default = null) — page that is currently loaded in the menu.
 
video:VideoDTO (default = null) — video that is currently displayed in the menu.
Method Detail
clone()method
override public function clone():Event

Returns a copy of the event instance.

Returns
Event — A copy of the event.
Constant Detail
BLOG_POST_CLICKConstant
public static const BLOG_POST_CLICK:String = blogPostClick

The MenuEvent.BLOG_POST_CLICK constant defines the value of the type property of the event object for a blogPostClick event.

COPY_CODEConstant 
public static const COPY_CODE:String = copyCode

The MenuEvent.COPY_CODE constant defines the value of the type property of the event object for a copyCode event.

COPY_LINKConstant 
public static const COPY_LINK:String = copyLink

The MenuEvent.COPY_LINK constant defines the value of the type property of the event object for a copyLink event.

MENU_PAGE_CLOSEConstant 
public static const MENU_PAGE_CLOSE:String = menuPageClose

The MenuEvent.MENU_PAGE_CLOSE constant defines the value of the type property of the event object for a menuPageClose event.

MENU_PAGE_OPENConstant 
public static const MENU_PAGE_OPEN:String = menuPageOpen

The MenuEvent.MENU_PAGE_OPEN constant defines the value of the type property of the event object for a menuPageOpen event.

OVERLAY_MENU_CLOSEConstant 
public static const OVERLAY_MENU_CLOSE:String = overlayMenuClose

The MenuEvent.OVERLAY_MENU_CLOSE constant defines the value of the type property of the event object for a overlayMenuClose event.

OVERLAY_MENU_OPENConstant 
public static const OVERLAY_MENU_OPEN:String = overlayMenuOpen

The MenuEvent.OVERLAY_MENU_OPEN constant defines the value of the type property of the event object for a overlayMenuOpen event.

OVERLAY_MENU_PLAY_CLICKConstant 
public static const OVERLAY_MENU_PLAY_CLICK:String = overlayMenuPlayClick

The MenuEvent.OVERLAY_MENU_PLAY_CLICK constant defines the value of the type property of the event object for a overlayMenuPlayClick event.

SEND_EMAIL_CLICKConstant 
public static const SEND_EMAIL_CLICK:String = sendEmailClick

The MenuEvent.SEND_EMAIL_CLICK constant defines the value of the type property of the event object for a sendEmailClick event.

VIDEO_REQUESTConstant 
public static const VIDEO_REQUEST:String = videoRequest

The MenuEvent.VIDEO_REQUEST constant defines the value of the type property of the event object for a videoRequest event.