| Package | flashx.textLayout.events |
| Class | public class TextLayoutEvent |
| Inheritance | TextLayoutEvent Event Object |
| Subclasses | ScrollEvent |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
TextLayoutEvent.SCROLL event, that does not require
custom properties.
A scroll event is represented by a TextLayoutEvent instance with its
type property set to TextLayoutEvent.SCROLL.
A class specifically for scroll events is not necessary because there are
no custom properties for a scroll event, as there are for the other
events that have specific event classes.
If a new text layout event is needed, and the event does not require
custom properties, the new event will also be represented by a
TextLayoutEvent object, but with its type property
set to a new static constant.
| Method | Defined By | ||
|---|---|---|---|
The TextLayoutEvent class represents the event object passed to
the event listener for many Text Layout events. | TextLayoutEvent | ||
![]() |
Duplicates an instance of an Event subclass. | Event | |
![]() |
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Checks whether the preventDefault() method has been called on the event. | Event | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Cancels an event's default behavior if that behavior can be canceled. | Event | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
![]() |
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns a string containing all the properties of the Event object. | Event | |
![]() |
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
![]() | ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
![]() | CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
![]() | CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
![]() | CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
![]() | CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
![]() | CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
![]() | COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
![]() | CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
![]() | CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
![]() | COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
![]() | CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
![]() | DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
![]() | DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
![]() | EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
![]() | EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
![]() | FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
![]() | FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
![]() | HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
![]() | HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
![]() | HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
![]() | ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
![]() | INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
![]() | LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
![]() | NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
![]() | OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
![]() | PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
![]() | PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
![]() | REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
![]() | RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
![]() | RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The TextLayoutEvent.SCROLL constant defines the value of the
type property of the event object for a scroll event. | TextLayoutEvent | ||
![]() | SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
![]() | SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
![]() | STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
![]() | STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
![]() | STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
![]() | TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
![]() | UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
![]() | USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
![]() | USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
TextLayoutEvent | () | Constructor |
public function TextLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The TextLayoutEvent class represents the event object passed to the event listener for many Text Layout events.
Parameterstype:String | |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) |
SCROLL | Constant |
public static const SCROLL:String = "scroll"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The TextLayoutEvent.SCROLL constant defines the value of the
type property of the event object for a scroll event.
addEventListener()
method on the text flow and to create an event handler function.
Call the addEventListener() method on the TextFlow instance.
You can use the simple string "text",
but it is safer to use the static constant
TextLayoutEvent.SCROLL
The event handler function in this example is named scrollEventHandler().
The event handler executes a trace() statement whenever a
scroll event is detected. This example does not include a scroll bar, but the
text scrolls when a user highlights text and drags the cursor down past the
bottom of the container.
package flashx.textLayout.events.examples {
import flash.display.Sprite;
import flash.events.Event;
import flashx.textLayout.compose.StandardFlowComposer;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.conversion.TextConverter;
import flashx.textLayout.edit.EditManager;
import flashx.textLayout.elements.TextFlow;
import flashx.textLayout.events.TextLayoutEvent;
import flashx.undo.UndoManager;
public class TextLayoutEvent_example extends Sprite
{
private const textMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='14' " +
"textIndent='10' paragraphSpaceBefore='6' paddingTop='8' paddingLeft='8' paddingRight='8'>" +
"<flow:p paragraphSpaceBefore='inherit'>" +
"<flow:span>There are many </flow:span>" +
"<flow:span fontStyle='italic'>such</flow:span>" +
"<flow:span> lime-kilns in that tract of country, for the purpose of burning the white" +
" marble which composes a large part of the substance of the hills. Some of them, built " +
"years ago, and long deserted, with weeds growing in the vacant round of the interior, " +
"which is open to the sky, and grass and wild-flowers rooting themselves into the chinks" +
"of the stones, look already like relics of antiquity, and may yet be overspread with the" +
" lichens of centuries to come. Others, where the lime-burner still feeds his daily and " +
"nightlong fire, afford points of interest to the wanderer among the hills, who seats " +
"himself on a log of wood or a fragment of marble, to hold a chat with the solitary man. " +
"It is a lonesome, and, when the character is inclined to thought, may be an intensely " +
"thoughtful occupation; as it proved in the case of Ethan Brand, who had mused to such " +
"strange purpose, in days gone by, while the fire in this very kiln was burning.</flow:span>" +
"</flow:p>" +
"</flow:TextFlow>";
public function TextLayoutEvent_example()
{
// create the TextFlow, container, and container controller
var textFlow:TextFlow;
var container:Sprite = new Sprite();
var _controller:ContainerController = new ContainerController(container, 200, 100);
// import the text flow from markup using TextFilter and assign a StandardFlowComposer
textFlow = TextConverter.importToFlow(textMarkup, TextConverter.TEXT_LAYOUT_FORMAT);
textFlow.flowComposer = new StandardFlowComposer();
// create undo, edit and interaction managers
var _undoManager:UndoManager = new UndoManager();
var _editManager:EditManager = new EditManager(_undoManager);
textFlow.interactionManager = _editManager;
// Add container to display list
addChild(container);
container.x = 25;
container.y = 100;
// Add an event listener for the TextLayoutEvent.SCROLL event
textFlow.addEventListener(TextLayoutEvent.SCROLL, scrollEventHandler);
// add the controller to the text flow and update it to display the text
textFlow.flowComposer.addController(_controller);
textFlow.flowComposer.updateAllControllers();
}
private function scrollEventHandler(evt:Event):void {
trace ("scroll event occurred");
}
}
}
Mon Nov 28 2011, 06:48 AM -08:00
Hide Inherited Public Properties
Show Inherited Public Properties