org.axsl.fo.fo.prop
Interface CommonAuralPa

All Known Subinterfaces:

BasicLink, BidiOverride, Block, ChangeBarBegin, ChangeBarEnd, CharacterSequence, ExternalGraphic, InitialPropertySet, Inline, InstreamForeignObject, Leader, ListBlock, ListItem, PageNumber, PageNumberCitation, PageNumberCitationLast, ScalingValueCitation, Table, TableAndCaption, TableBody, TableCaption, TableCell, TableFooter, TableHeader, TableRow, Title

public interface CommonAuralPa

The XSL-FO Common Aural properties.

See Also:

"XSL-FO, 1.1, Section 7.7."

Method Summary

Voice	getVoice(FoContext context) Provides a resolved voice for this object.
float	traitAzimuth(FoContext context) Returns the "azimuth" trait for this FO.
java.lang.String	traitCueAfter(FoContext context) Returns the "cue-after" trait for this FO.
java.lang.String	traitCueBefore(FoContext context) Returns the "cue-before" trait for this FO.
float	traitElevation(FoContext context) Returns the "elevation" trait for this FO.
double	traitPauseAfter(FoContext context) Returns the "pause-after" trait for this FO.
double	traitPauseBefore(FoContext context) Returns the "pause-before" trait for this FO.
double	traitPitch(FoContext context) Returns the frequency for the audio for the current voice.
double	traitPitchRange(FoContext context) Returns the "pitch-range" trait for this FO.
java.lang.String	traitPlayDuring(FoContext context) Returns the "URL" component of the "play-during" trait for this FO.
boolean	traitPlayDuringMix(FoContext context) Returns the "mix" component of the "play-during" trait for this FO.
boolean	traitPlayDuringRepeat(FoContext context) Returns the "repeat" component of the "play-during" trait for this FO.
double	traitRichness(FoContext context) Returns the "richness" trait for this FO.
Speak	traitSpeak(FoContext context) Returns the "speak" trait for this FO.
SpeakHeader	traitSpeakHeader(FoContext context) Returns the "speak-header" trait for this FO.
SpeakNumeral	traitSpeakNumeral(FoContext context) Returns the "speak-numeral" trait for this FO.
SpeakPunctuation	traitSpeakPunctuation(FoContext context) Returns the "speak-punctuation" trait for this FO.
double	traitSpeechRate(FoContext context) Returns the desired speech-rate, in words-per-minute.
double	traitStress(FoContext context) Returns the "stress" trait for this FO.
java.lang.String[]	traitVoiceFamily(FoContext context) Returns the "voice-family" trait for this FO.
double	traitVolume(FoContext context) Returns the computed value for the "volume" property.

Method Detail

traitAzimuth

float traitAzimuth(FoContext context)

Returns the "azimuth" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "azimuth" trait, in degrees.

See Also:

"XSL-FO 1.0, Section 7.6.1", "XSL-FO 1.0, Section 7.7.1"

traitCueAfter

java.lang.String traitCueAfter(FoContext context)

Returns the "cue-after" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "cue-after" trait.

See Also:

"XSL-FO 1.0, Section 7.6.2", "XSL-FO 1.0, Section 7.7.2"

traitCueBefore

java.lang.String traitCueBefore(FoContext context)

Returns the "cue-before" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "cue-before" trait.

See Also:

"XSL-FO 1.0, Section 7.6.3", "XSL-FO 1.0, Section 7.7.3"

traitElevation

float traitElevation(FoContext context)

Returns the "elevation" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "elevation" trait, in degrees.

See Also:

"XSL-FO 1.0, Section 7.6.4", "XSL-FO 1.0, Section 7.7.4"

traitPauseAfter

double traitPauseAfter(FoContext context)

Returns the "pause-after" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The pause-after trait value, in milliseconds.

See Also:

"XSL-FO 1.0, Section 7.6.5", "XSL-FO 1.0, Section 7.7.5"

traitPauseBefore

double traitPauseBefore(FoContext context)

Returns the "pause-before" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The pause-before trait value, in milliseconds.

See Also:

"XSL-FO 1.0, Section 7.6.6", "XSL-FO 1.0, Section 7.7.6"

traitPitch

double traitPitch(FoContext context)

Returns the frequency for the audio for the current voice.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The frequency to be used by the voice for reading.

See Also:

CSS definition of "pitch", "XSL-FO 1.0, Section 7.6.7", "XSL-FO 1.1, Section 7.7.7"

traitPitchRange

double traitPitchRange(FoContext context)

Returns the "pitch-range" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The pitch-range trait value, in milliseconds.

See Also:

"XSL-FO 1.0, Section 7.6.8", "XSL-FO 1.0, Section 7.7.8"

traitPlayDuring

java.lang.String traitPlayDuring(FoContext context)

Returns the "URL" component of the "play-during" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The URL for the "play-during" trait. The special return value of "" (a valid String object with no characters) indicates a value of "auto", that is, that the sound (if any) of the parent element should continue to play. The special return value of null indicates a value of "none", that is, that no sound should be played at all.

See Also:

"XSL-FO 1.0, Section 7.6.9", "XSL-FO 1.0, Section 7.7.9", traitPlayDuringMix(FoContext), traitPlayDuringRepeat(FoContext)

traitPlayDuringMix

boolean traitPlayDuringMix(FoContext context)

Returns the "mix" component of the "play-during" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True if the "play-during" should be mixed.

See Also:

"XSL-FO 1.0, Section 7.6.9", "XSL-FO 1.0, Section 7.7.9", traitPlayDuring(FoContext), traitPlayDuringRepeat(FoContext)

traitPlayDuringRepeat

boolean traitPlayDuringRepeat(FoContext context)

Returns the "repeat" component of the "play-during" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True if the "play-during" should repeat.

See Also:

"XSL-FO 1.0, Section 7.6.9", "XSL-FO 1.0, Section 7.7.9", traitPlayDuring(FoContext), traitPlayDuringMix(FoContext)

traitRichness

double traitRichness(FoContext context)

Returns the "richness" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "richness" trait.

See Also:

"XSL-FO 1.0, Section 7.6.10", "XSL-FO 1.0, Section 7.7.10"

traitSpeak

Speak traitSpeak(FoContext context)

Returns the "speak" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "speak" trait.

See Also:

"XSL-FO 1.0, Section 7.6.11", "XSL-FO 1.0, Section 7.7.11"

traitSpeakHeader

SpeakHeader traitSpeakHeader(FoContext context)

Returns the "speak-header" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "speak-header" trait.

See Also:

"XSL-FO 1.0, Section 7.6.12", "XSL-FO 1.0, Section 7.7.12"

traitSpeakNumeral

SpeakNumeral traitSpeakNumeral(FoContext context)

Returns the "speak-numeral" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "speak-numeral" trait.

See Also:

"XSL-FO 1.0, Section 7.6.13", "XSL-FO 1.0, Section 7.7.13"

traitSpeakPunctuation

SpeakPunctuation traitSpeakPunctuation(FoContext context)

Returns the "speak-punctuation" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "speak-punctuation" trait.

See Also:

"XSL-FO 1.0, Section 7.6.14", "XSL-FO 1.0, Section 7.7.14"

traitSpeechRate

double traitSpeechRate(FoContext context)

Returns the desired speech-rate, in words-per-minute.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The desired speech-rate, in words-per-minute.

See Also:

"XSL-FO 1.0, Section 7.6.15", "XSL-FO 1.0, Section 7.7.15"

traitStress

double traitStress(FoContext context)

Returns the "stress" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "stress" trait.

See Also:

"XSL-FO 1.0, Section 7.6.16", "XSL-FO 1.0, Section 7.7.16"

traitVoiceFamily

java.lang.String[] traitVoiceFamily(FoContext context)

Returns the "voice-family" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "voice-family" trait.

See Also:

"XSL-FO 1.0, Section 7.6.17", "XSL-FO 1.0, Section 7.7.17"

traitVolume

double traitVolume(FoContext context)

Returns the computed value for the "volume" property.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

A value in the range from 0 to 100, or a -1 for "silent".

See Also:

"XSL-FO 1.0, Section 7.6.18", "XSL-FO 1.0, Section 7.7.18"

getVoice

Voice getVoice(FoContext context)

Provides a resolved voice for this object.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The resolved Voice instance for this object.