//////////////////////////////////////////////////////////////////////////////// // // 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.elements { import flashx.textLayout.edit.SelectionFormat; import flashx.textLayout.formats.ITextLayoutFormat; /** Read-only interface to a configuration object. Used by TextFlow to guarantee it has an unchangeable * configuration once its constructed. * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ public interface IConfiguration { /** * Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and * turns it into a tabbed panel event. * *
Default value is false
.
Default value is true
.
Default value is OverflowPolicy.FIT_DESCENDERS, which fits the line in the composition area if the area * from the top to the baseline fits.
* * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 * * @see OverflowPolicy */ function get overflowPolicy():String; /** * Specifies whether accessibility support is turned on or not. Iftrue
, screen readers can read the TextFlow contents.
*
* Default value is false
.
Default is null
.
Default is null
.
Default is null
.
focusedSelectionFormat
to draw the selection when the window is active and one of
* the containers in the TextFlow has focus. You can override this format using
* SelectionManager.focusedSelectionFormat
, if desired.
*
* The SelectionFormat class specifies the default values, which invert the color of the text and its background.
* * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 * * @see flashx.textLayout.edit.SelectionFormat SelectionFormat * @see flashx.textLayout.edit.SelectionManager#focusedSelectionFormat SelectionManager.focusedSelectionFormat * @see TextFlow */ function get focusedSelectionFormat():SelectionFormat /** * The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers * in the TextFlow have focus. You can override this format usingSelectionManager.unfocusedSelectionFormat
, if desired.
*
* If you do not override unfocusedSelectionFormat
the SelectionFormat values used are:
color = 0xffffff
(white)alpha = 0
blendMode = flash.display.BlendMode.DIFFERENCE
The result is no selection is displayed.
* * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 * * @see flashx.textLayout.edit.SelectionFormat SelectionFormat * @see flashx.textLayout.edit.SelectionManager#unfocusedSelectionFormat SelectionManager.unfocusedSelectionFormat * @see TextFlow */ function get unfocusedSelectionFormat():SelectionFormat /** * The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. Text Layout Framework uses *inactiveSelectionFormat
for drawing the selection when the window is inactive. You can override
* this format using SelectionManager.inactiveSelectionFormat
, if desired.
*
* If you do not override unfocusedSelectionFormat
the SelectionFormat values used are:
color = 0xffffff
(white)alpha = 0
blendMode = flash.display.BlendMode.DIFFERENCE
The result is no selection is displayed.
* * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 * * @see flashx.textLayout.edit.SelectionFormat SelectionFormat * @see flashx.textLayout.edit.SelectionManager#inactiveSelectionFormat SelectionManager.inactiveSelectionFormat * @see TextFlow */ function get inactiveSelectionFormat():SelectionFormat /** * Specifies a timed delay between one scroll and the next to prevent scrolling from going * too fast. This value specifies what the delay is in milliseconds. The default value is 35. * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get scrollDragDelay():Number /** Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging * the selection. Default value is 20. * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get scrollDragPixels():Number /** * Specifies the default percentage of the text flow to scroll for page scrolls. Default value is * 7.0 / 8.0, or .875. * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get scrollPagePercentage(): Number /** Specifies the default number of pixels to scroll for Mouse wheel events. Default value is 20. * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get scrollMouseWheelMultiplier(): Number /** Specifies the type of flow composer to attach to a new TextFlow object by default. Default value is StandardFlowComposer. * * @see flashx.textLayout.compose.StandardFlowComposer StandardFlowComposer * @see flashx.textLayout.elements.TextFlow TextFlow * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get flowComposerClass():Class /** Requests that the process of composing text release line creation data after composing each paragraph. * This request saves memory but slows down the composing process. * *Default value is false
.
flashx.textLayout.elements.InlineGraphicElement
object and returns
* the value to be used as the element's flashx.textLayout.elements.InlineGraphicElement#source
.
*
* This callback provides the mechanism to delay providing an inline graphic element's source until just before it is composed.
* Note: this callback will be invoked only if a * placeholder source of String type is already set. Moreover, it may be invoked * multiple times.
* * @see flashx.textLayout.elements.InlineGraphicElement InlineGraphicElement * * @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ function get inlineGraphicResolverFunction():Function; } }