| //////////////////////////////////////////////////////////////////////////////// |
| // |
| // 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.formats |
| { |
| /** |
| * This interface provides read access to tab stop-related properties. |
| * |
| * @playerversion Flash 10 |
| * @playerversion AIR 1.5 |
| * @langversion 3.0 |
| */ |
| public interface ITabStopFormat |
| { |
| /** |
| * Return the value of the style specified by the <code>styleProp</code> parameter |
| * which specifies the style name. |
| * |
| * @param styleProp The name of the style whose value is to be retrieved. |
| * @return The value of the specified style. The type varies depending on the type of the style being |
| * accessed. Returns <code>undefined</code> if the style is not set. |
| * |
| * @playerversion Flash 10 |
| * @playerversion AIR 1.5 |
| * @langversion 3.0 |
| */ |
| function getStyle(styleName:String):*; |
| /** |
| * The position of the tab stop, in pixels, relative to the start edge of the column. |
| * <p>Legal values are numbers from 0 to 10000 and FormatValue.INHERIT.</p> |
| * <p>Default value is undefined indicating not set.</p> |
| * <p>If undefined during the cascade this property will have a value of 0.</p> |
| * @see FormatValue#INHERIT |
| * |
| * @throws RangeError when set value is not within range for this property |
| * |
| * @playerversion Flash 10 |
| * @playerversion AIR 1.5 |
| * @langversion 3.0 |
| */ |
| function get position():*; |
| |
| /** |
| * The tab alignment for this tab stop. |
| * <p>Legal values are TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL, FormatValue.INHERIT.</p> |
| * <p>Default value is undefined indicating not set.</p> |
| * <p>If undefined during the cascade this property will have a value of TabAlignment.START.</p> |
| * @see FormatValue#INHERIT |
| * |
| * @throws RangeError when set value is not within range for this property |
| * |
| * @playerversion Flash 10 |
| * @playerversion AIR 1.5 |
| * @langversion 3.0 |
| * @see flash.text.engine.TabAlignment |
| */ |
| function get alignment():*; |
| |
| /** |
| * The alignment token to be used if the alignment is DECIMAL. |
| * <p>Default value is undefined indicating not set.</p> |
| * <p>If undefined during the cascade this property will have a value of null.</p> |
| * |
| * @throws RangeError when set value is not within range for this property |
| * |
| * @playerversion Flash 10 |
| * @playerversion AIR 1.5 |
| * @langversion 3.0 |
| */ |
| function get decimalAlignmentToken():*; |
| } |
| } |