|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ocap.media.ClosedCaptioningAttribute
public class ClosedCaptioningAttribute
This class represents a system wide preference of closed-captioning representation. The OCAP implementation shall display closed-captioning according to preference values that is specified by this class. Application developers should be aware that the FCC has defined strict rules regarding display of CC and EAS (see http://ftp.fcc.gov/cgb/dro/caption.html for FCC closed captioning rules).
Field Summary | |
---|---|
static int |
CC_ATTRIBUTE_FONT_ITALICIZED
Indicates a font face attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_FONT_STYLE
Indicates a font style attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_FONT_UNDERLINE
Indicates a font face attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_PEN_BG_COLOR
Indicates a pen back ground color attribute to draw closed-captioning text. |
static int |
CC_ATTRIBUTE_PEN_BG_OPACITY
Indicates a pen back ground opacity attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_PEN_FG_COLOR
Indicates a pen color attribute to draw closed-captioning text. |
static int |
CC_ATTRIBUTE_PEN_FG_OPACITY
Indicates a pen opacity attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_PEN_SIZE
Indicates a font size attribute of a closed-captioning text. |
static int |
CC_ATTRIBUTE_WINDOW_BORDER_COLOR
Indicates a border color attribute of a closed-captioning window. |
static int |
CC_ATTRIBUTE_WINDOW_BORDER_TYPE
Indicates a border type attribute of a closed-captioning window. |
static int |
CC_ATTRIBUTE_WINDOW_FILL_COLOR
Indicates a window fill color attribute of a closed-captioning window. |
static int |
CC_ATTRIBUTE_WINDOW_FILL_OPACITY
Indicates a border type attribute of a closed-captioning window. |
static int |
CC_BORDER_DEPRESSED
Indicates a border type of DEPRESSED. |
static int |
CC_BORDER_NONE
Indicates a border type of NONE. |
static int |
CC_BORDER_RAISED
Indicates a border type of RAISED. |
static int |
CC_BORDER_SHADOW_LEFT
Indicates a border type of SHADOW_LEFT. |
static int |
CC_BORDER_SHADOW_RIGHT
Indicates a border type of SHADOW_RIGHT. |
static int |
CC_BORDER_UNIFORM
Indicates a border type of UNIFORM. |
static int |
CC_OPACITY_FLASH
Indicates a opacity value for a flash. |
static int |
CC_OPACITY_SOLID
Indicates a opacity value for a solid. |
static int |
CC_OPACITY_TRANSLUCENT
Indicates a opacity value for a translucent. |
static int |
CC_OPACITY_TRANSPARENT
Indicates a opacity value for a transparent. |
static int |
CC_PEN_SIZE_LARGE
Indicates a large pen size. |
static int |
CC_PEN_SIZE_SMALL
Indicates a small pen size. |
static int |
CC_PEN_SIZE_STANDARD
Indicates a standard pen size. |
static int |
CC_TYPE_ANALOG
Indicates an analog type closed-captioning. |
static int |
CC_TYPE_DIGITAL
Indicates an digital type closed-captioning. |
Constructor Summary | |
---|---|
protected |
ClosedCaptioningAttribute()
A constructor of this class. |
Method Summary | |
---|---|
java.lang.Object |
getCCAttribute(int attribute,
int ccType)
This method returns a current attribute values applied to a closed-captioning text on a screen. |
java.lang.Object[] |
getCCCapability(int attribute,
int ccType)
This method returns a possible attribute values applied to an closed-captioning text on a screen. |
static ClosedCaptioningAttribute |
getInstance()
This method returns an instance of this class. |
void |
setCCAttribute(int[] attribute,
java.lang.Object[] value,
int ccType)
This method sets a preferred attribute values applied to a closed-captioning text on a screen. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int CC_ATTRIBUTE_PEN_FG_COLOR
public static final int CC_ATTRIBUTE_PEN_BG_COLOR
public static final int CC_ATTRIBUTE_PEN_FG_OPACITY
public static final int CC_ATTRIBUTE_PEN_BG_OPACITY
public static final int CC_ATTRIBUTE_FONT_STYLE
public static final int CC_ATTRIBUTE_PEN_SIZE
public static final int CC_ATTRIBUTE_FONT_ITALICIZED
public static final int CC_ATTRIBUTE_FONT_UNDERLINE
public static final int CC_ATTRIBUTE_WINDOW_FILL_COLOR
public static final int CC_ATTRIBUTE_WINDOW_FILL_OPACITY
public static final int CC_ATTRIBUTE_WINDOW_BORDER_TYPE
public static final int CC_ATTRIBUTE_WINDOW_BORDER_COLOR
public static final int CC_PEN_SIZE_SMALL
public static final int CC_PEN_SIZE_STANDARD
public static final int CC_PEN_SIZE_LARGE
public static final int CC_OPACITY_SOLID
public static final int CC_OPACITY_FLASH
public static final int CC_OPACITY_TRANSLUCENT
public static final int CC_OPACITY_TRANSPARENT
public static final int CC_BORDER_NONE
public static final int CC_BORDER_RAISED
public static final int CC_BORDER_DEPRESSED
public static final int CC_BORDER_UNIFORM
public static final int CC_BORDER_SHADOW_LEFT
public static final int CC_BORDER_SHADOW_RIGHT
public static final int CC_TYPE_ANALOG
public static final int CC_TYPE_DIGITAL
Constructor Detail |
---|
protected ClosedCaptioningAttribute()
Method Detail |
---|
public static ClosedCaptioningAttribute getInstance()
java.lang.SecurityException
- if the caller doesn't have
MonitorAppPermission("handler.closedCaptioning").public java.lang.Object[] getCCCapability(int attribute, int ccType)
This method returns a possible attribute values applied to an closed-captioning text on a screen. Note that the possible font attribute may be different from the possible font for Java application since the closed-captioning module may be implemented by native language.
attribute
- specify an attribute to get possible values.
One of constants that has a CC_ATTRIBUTE_ prefix shall be
specified.ccType
- either CC_ANALOG or CC_DIGITAL to specify a type of
closed-captioning.
java.lang.IllegalArgumentException
- if a specified attribute or
ccType parameter is out of range.public void setCCAttribute(int[] attribute, java.lang.Object[] value, int ccType)
This method sets a preferred attribute values applied to a
closed-captioning text on a screen. Some attribute values can be
specified by one call of this method.
If one of the specified attribute value is invalid, i.e., the value
is not included in the return value of the getCCCapability(int, int)
method, this method changes none of current attribute values and
throw an exception.
attribute
- an array of attributes to be set a preferred value.
One of constants that has a CC_ATTRIBUTE_ prefix shall be
specified.value
- an array of preferred values to be used to draw a
closed-captioning text.
The value shall be one of the return value from the
getCCCapability(int, int)
method for
the specified attribute, or null to set a host’s default
value.
The i-th item of the value array corresponds to the i-th
item of the attribute array.ccType
- either CC_ANALOG or CC_DIGITAL to specify a type of
closed-captioning.
java.lang.IllegalArgumentException
- if a specified attribute, value, or
ccType parameter is out of range or not a capable value, or if
a length of a specified attribute array doesn’t matches with
a length of a specified value array.public java.lang.Object getCCAttribute(int attribute, int ccType)
This method returns a current attribute values applied to a closed-captioning text on a screen.
attribute
- specify an attribute to get a preferred values.
One of constants that has a CC_ATTRIBUTE_ prefix shall be
specified. See the getCCCapability(int, int)
method also.ccType
- either CC_ANALOG or CC_DIGITAL to specify a type of
closed-captioning.
getCCCapability(int, int)
method for an applicable value.
java.lang.IllegalArgumentException
- if a specified attribute or
ccType parameter is out of range.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |