////////////////////////////////////////////////////////////////////////////////
//
// 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.
//
////////////////////////////////////////////////////////////////////////////////
/**
* Color of text in the component, including the component label.
*
* The default value for the Halo theme is 0x0B333C
.
* The default value for the Spark theme is 0x000000
.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="color", type="uint", format="Color", inherit="yes")]
/**
* The directionality of the text displayed by the component.
*
*
The allowed values are "ltr"
for left-to-right text,
* as in Latin-style scripts,
* and "rtl"
for right-to-left text,
* as in Arabic and Hebrew.
FTE and TLF use this value in their bidirectional text layout algorithm, * which maps Unicode character order to glyph order.
* *Note: This style only applies when an MX component
* specifies UIFTETextField as its textFieldClass
.
The direction
also affects the alignment
* of the text within the bounds of the TLFTextField.
* It does not, however, affect the the placement
* of the TLFTextField within the component.
antiAliasType
property of internal TextFields. The possible values are
* "normal"
(flash.text.AntiAliasType.NORMAL
)
* and "advanced"
(flash.text.AntiAliasType.ADVANCED
).
*
* The default value is "advanced"
, which enables advanced anti-aliasing for the font.
* Set to "normal"
to disable the advanced anti-aliasing.
This style has no effect for system fonts.
* *This style applies to all the text in a TextField subcontrol; * you cannot apply it to some characters and not others.
* @default "advanced" * * @see flash.text.TextField * @see flash.text.AntiAliasType * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="fontAntiAliasType", type="String", enumeration="normal,advanced", inherit="yes")] /** * Name of the font to use. * Unlike in a full CSS implementation, * comma-separated lists are not supported. * You can use any font family name. * If you specify a generic font name, * it is converted to an appropriate device font. * * The default font for the Halo theme is"Verdana"
.
* The default font for the Spark theme is "Arial"
.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="fontFamily", type="String", inherit="yes")]
/**
* Sets the gridFitType
property of internal TextFields that represent text in Flex controls.
* The possible values are "none"
(flash.text.GridFitType.NONE
),
* "pixel"
(flash.text.GridFitType.PIXEL
),
* and "subpixel"
(flash.text.GridFitType.SUBPIXEL
).
*
* This property only applies when you are using an embedded font
* and the fontAntiAliasType
property
* is set to "advanced"
.
This style has no effect for system fonts.
* *This style applies to all the text in a TextField subcontrol; * you can't apply it to some characters and not others.
* * @default "pixel" * * @see flash.text.TextField * @see flash.text.GridFitType * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="fontGridFitType", type="String", enumeration="none,pixel,subpixel", inherit="yes")] /** * Sets thesharpness
property of internal TextFields that represent text in Flex controls.
* This property specifies the sharpness of the glyph edges. The possible values are Numbers
* from -400 through 400.
*
* This property only applies when you are using an embedded font
* and the fontAntiAliasType
property
* is set to "advanced"
.
This style has no effect for system fonts.
* *This style applies to all the text in a TextField subcontrol; * you can't apply it to some characters and not others.
* * @default 0 * * @see flash.text.TextField * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="fontSharpness", type="Number", inherit="yes")] /** * Height of the text, in pixels. * * In the Halo theme, the default value is 10 for all controls except * the ColorPicker control. For the Halo themed ColorPicker control, * the default value is 11. In the Spark theme, the default value is * 12 for all controls except the ColorPicker control. For the Spark * themed ColorPicker control, the default value is 11. * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="fontSize", type="Number", format="Length", inherit="yes")] /** * Determines whether the text is italic font. * Recognized values are"normal"
and "italic"
.
*
* @default "normal"
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="fontStyle", type="String", enumeration="normal,italic", inherit="yes")]
/**
* Sets the thickness
property of internal TextFields that represent text in Flex controls.
* This property specifies the thickness of the glyph edges.
* The possible values are Numbers from -200 to 200.
*
* This property only applies when you are using an embedded font
* and the fontAntiAliasType
property
* is set to "advanced"
.
This style has no effect on system fonts.
* *This style applies to all the text in a TextField subcontrol; * you can't apply it to some characters and not others.
* * @default 0 * * @see flash.text.TextField * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="fontThickness", type="Number", inherit="yes")] /** * Determines whether the text is boldface. * Recognized values arenormal
and bold
.
* The default value for Button controls is bold
.
* The default value for all other controls is normal
.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="fontWeight", type="String", enumeration="normal,bold", inherit="yes")]
/**
* A Boolean value that indicates whether kerning
* is enabled (true
) or disabled (false
).
* Kerning adjusts the gap between certain character pairs
* to improve readability, and should be used only when necessary,
* such as with headings in large fonts.
* Kerning is supported for embedded fonts only.
* Certain fonts, such as Verdana, and monospaced fonts,
* such as Courier New, do not support kerning.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="kerning", type="Boolean", inherit="yes")]
/**
* The number of additional pixels to appear between each character.
* A positive value increases the character spacing beyond the normal spacing,
* while a negative value decreases it.
*
* @default 0
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="letterSpacing", type="Number", inherit="yes")]
/**
* The locale of the text displayed by this component.
*
* FTE and TLF use this locale to map Unicode characters * to font glyphs and to find fallback fonts.
* *Note: This style only applies when an MX component
* specifies UIFTETextField as its textFieldClass
.
"left"
, "right"
,
* or "center"
.
*
* The default value for most components is "left"
.
* For the FormItem component,
* the default value is "right"
.
* For the Button, LinkButton, and AccordionHeader components,
* the default value is "center"
, and
* this property is only recognized when the
* labelPlacement
property is set to "left"
or
* "right"
.
* If labelPlacement
is set to "top"
or
* "bottom"
, the text and any icon are centered.
"none"
and "underline"
.
*
* @default "none"
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="textDecoration", type="String", enumeration="none,underline", inherit="yes")]
/**
* The class implementing IUITextField that is used by this component
* to render text.
*
* It can be set to either the mx.core.UITextField class * (to use the classic TextField class built into Flash Player) * or the mx.core.UIFTETextField class * (to use the Text Layout Framework to get improved text rendering, * including bidirectional layout).
* * @default mx.core.UITextField * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 1.5 * @productversion Flex 4 */ [Style(name="textFieldClass", type="Class", inherit="no")] /** * Offset of first line of text from the left side of the container, in pixels. * * @default 0 * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Style(name="textIndent", type="Number", format="Length", inherit="yes")]