////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package flashx.textLayout.events
{
import flash.events.Event;
/**
* A TextLayoutEvent instance represents an event, such as the
* 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.
*
TextLayoutEvent.SCROLL
constant defines the value of the
* type
property of the event object for a scroll
event.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public static const SCROLL:String = "scroll";
/**
* The TextLayoutEvent class represents the event object passed to
* the event listener for many Text Layout events.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public function TextLayoutEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false)
{
super(type, bubbles, cancelable);
}
/** @private */
override public function clone():Event
{
return new TextLayoutEvent(type, bubbles, cancelable);
}
}
}