| Package | com.endeca.tools.pagebuilder.events |
| Class | public class EditorEvent |
| Inheritance | EditorEvent  flash.events.Event |
| Property | Defined by | ||
|---|---|---|---|
| message : String
When the type of the event is
EditorEvent.ERROR,
this is a message regarding the error that occurred. | EditorEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
EditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String = null)
| EditorEvent | ||
|
createErrorEvent(message:String):EditorEvent
[static]
Creates a new event with type
EditorEvent.ERROR and
the given message. | EditorEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| ERROR : String = "editorError" [static]
The
EditorEvent.ERROR constant defines the
value of the type property of the event object for an event
that may be dispatched by the editor if it suffers an
unrecoverable error. | EditorEvent | ||
| READY : String = "editorReady" [static]
The
EditorEvent.READY constant defines the
value of the type property of the event object for an event
that is dispatched after all the properties of the
IEditor interface have been set. | EditorEvent | ||
| message | property |
message:String [read-write]
When the type of the event is EditorEvent.ERROR,
this is a message regarding the error that occurred.
The default value is null.
public function get message():String
public function set message(value:String):void
| EditorEvent | () | constructor |
public function EditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String = null)Parameters
type:String |
|
bubbles:Boolean (default = false) |
|
cancelable:Boolean (default = false) |
|
message:String (default = null) |
| createErrorEvent | () | method |
public static function createErrorEvent(message:String):EditorEvent
Creates a new event with type EditorEvent.ERROR and
the given message.
message:String — The error message
|
EditorEvent —
The new event
|
| ERROR | constant |
public static const ERROR:String = "editorError"
The EditorEvent.ERROR constant defines the
value of the type property of the event object for an event
that may be dispatched by the editor if it suffers an
unrecoverable error.
| READY | constant |
public static const READY:String = "editorReady"
The EditorEvent.READY constant defines the
value of the type property of the event object for an event
that is dispatched after all the properties of the
IEditor interface have been set.
See also