Packageorg.osmf.captioning.model
Classpublic class CaptionFormat
InheritanceCaptionFormat Inheritance Object

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

Represents formatting for a caption object.


Public Properties
 PropertyDefined By
  endIndex : int
[read-only] Get the end index supplied to the constructor.
CaptionFormat
  startIndex : int
[read-only] Get the start index supplied to the constructor.
CaptionFormat
  style : CaptionStyle
[read-only] Get the style object supplied to the constructor.
CaptionFormat
Public Methods
 MethodDefined By
  
CaptionFormat(style:CaptionStyle, start:int, end:int)
Creates a CaptionFormat object specifying the Style object and the zero-based start and end indices of the range.
CaptionFormat
Public Constants
 ConstantDefined By
  UNDEFINED_INDEX : int = -1
[static]
CaptionFormat
Property Detail
endIndexproperty
endIndex:int  [read-only]

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

Get the end index supplied to the constructor.


Implementation
    public function get endIndex():int
startIndexproperty 
startIndex:int  [read-only]

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

Get the start index supplied to the constructor.


Implementation
    public function get startIndex():int
styleproperty 
style:CaptionStyle  [read-only]

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

Get the style object supplied to the constructor.


Implementation
    public function get style():CaptionStyle
Constructor Detail
CaptionFormat()Constructor
public function CaptionFormat(style:CaptionStyle, start:int, end:int)

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

Creates a CaptionFormat object specifying the Style object and the zero-based start and end indices of the range.

Parameters
style:CaptionStyle — The instance of CaptionStyle object to apply.
 
start:int (default = NaN) — The optional zero-based index position specifying the first character of the desired range of text.
 
end:int (default = NaN) — The optional zero-based index position specifying the last character of the desired range of text.

Throws
ArgumentError — If the style argument is null.
Constant Detail
UNDEFINED_INDEXConstant
public static const UNDEFINED_INDEX:int = -1




Generated by Flexmojos

Fri May 6 2016, 10:06 AM +05:30