Packageorg.osmf.captioning.model
Classpublic class CaptionStyle
InheritanceCaptionStyle Inheritance Object

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

This class represents a caption style.



Public Properties
 PropertyDefined By
  backgroundColor : Object
The background color for the control rendering the captioning text in a hexadecimal format; for example, 0xff0000 is red.
CaptionStyle
  backgroundColorAlpha : Object
The alpha transparency of the background color as a Number between 0 and 1.
CaptionStyle
  fontFamily : String
The font family.
CaptionStyle
  fontSize : int
The font size in pixels.
CaptionStyle
  fontStyle : String
The font style, normal or italic.
CaptionStyle
  fontWeight : String
The font weight, normal or bold.
CaptionStyle
  id : String
[read-only] Get the CaptionStyle ID.
CaptionStyle
  textAlign : String
The text alignment, left, center, or right.
CaptionStyle
  textColor : Object
The text color of the caption in a hexadecimal format; for example, 0xff0000 is red.
CaptionStyle
  textColorAlpha : Object
The alpha transparency of the text color as a Number between 0 and 1.
CaptionStyle
  wrapOption : Boolean
The word wrap option.
CaptionStyle
Public Methods
 MethodDefined By
  
CaptionStyle(id:String)
Creates a Style object.
CaptionStyle
Property Detail
backgroundColorproperty
backgroundColor:Object

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The background color for the control rendering the captioning text in a hexadecimal format; for example, 0xff0000 is red.


Implementation
    public function get backgroundColor():Object
    public function set backgroundColor(value:Object):void
backgroundColorAlphaproperty 
backgroundColorAlpha:Object

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The alpha transparency of the background color as a Number between 0 and 1.


Implementation
    public function get backgroundColorAlpha():Object
    public function set backgroundColorAlpha(value:Object):void
fontFamilyproperty 
fontFamily:String

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The font family.


Implementation
    public function get fontFamily():String
    public function set fontFamily(value:String):void
fontSizeproperty 
fontSize:int

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The font size in pixels.


Implementation
    public function get fontSize():int
    public function set fontSize(value:int):void
fontStyleproperty 
fontStyle:String

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The font style, normal or italic.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
fontWeightproperty 
fontWeight:String

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The font weight, normal or bold.


Implementation
    public function get fontWeight():String
    public function set fontWeight(value:String):void
idproperty 
id:String  [read-only]

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

Get the CaptionStyle ID.


Implementation
    public function get id():String
textAlignproperty 
textAlign:String

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The text alignment, left, center, or right.


Implementation
    public function get textAlign():String
    public function set textAlign(value:String):void
textColorproperty 
textColor:Object

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The text color of the caption in a hexadecimal format; for example, 0xff0000 is red.


Implementation
    public function get textColor():Object
    public function set textColor(value:Object):void
textColorAlphaproperty 
textColorAlpha:Object

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The alpha transparency of the text color as a Number between 0 and 1.


Implementation
    public function get textColorAlpha():Object
    public function set textColorAlpha(value:Object):void
wrapOptionproperty 
wrapOption:Boolean

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

The word wrap option.


Implementation
    public function get wrapOption():Boolean
    public function set wrapOption(value:Boolean):void
Constructor Detail
CaptionStyle()Constructor
public function CaptionStyle(id:String)

Language Version : ActionScript 3.0
Product Version : OSMF 1.0
Runtime Versions : Flash Player 10, AIR 1.0

Creates a Style object.

Parameters
id:String — The ID is usually provided in the captioning document.