|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--sub_arctic.new_lib.generic_audio_xlation
This interface provides audio navigation information (implements the audio_navigation_aware interface) for non audio-aware interactors. If this is applied to an audio aware interactor, it simply forwards its methods there. For other interactors it does some detective work to determine properties that can be used for audio rendition (such as whether the object accepts input or produces output such as text that we know how to render in audio)
Field Summary | |
protected boolean |
_accepts_input
Does this object accept input? |
protected audio_renderer |
_audio_rendition
The audio rendition for this object. |
protected static audio_renderer |
_default_audio_rendition
Default audio rendition for something we can't otherwise figure out. |
protected boolean |
_display_this
Do we attempt an audio display of our subject? |
protected boolean |
_forward_all
Indication of whether we forward to the subject or work it out on our own. |
protected static java.util.Hashtable |
_known_translations
Table of known interactor to audio icon translations. |
protected boolean |
_stop_here
Do we stop navigation at this object or pass on through? |
protected interactor |
_subject
Interactor object we are translating to audio |
protected java.lang.String |
_text_contents
The current text contents from this object. |
protected java.lang.String |
_type_text
The text string with the type name of this object. |
static java.lang.String |
default_audio_name
Name portion of the default audio rendition URL -- this will be taken from the document base (for now). |
static java.lang.String |
default_spoken
Text string to be spoken for default audio rendition. |
Constructor Summary | |
generic_audio_xlation(interactor subj)
Constructor based on a subject interactor. |
Method Summary | |
static void |
add_known_translation(java.lang.String class_name,
java.lang.String audio_name)
Add an entry to the known translations table. |
audio_renderer |
audio_rendition()
Audio rendition for the object -- this portrays the type of the object as well as possibly its content. |
protected audio_renderer |
build_audio_icon(interactor subj)
Build an audio icon for the given interactor. |
protected java.lang.String |
build_type_name(interactor subj)
Create a string to speak for the type of the given object. |
static audio_renderer |
default_audio_rendition()
Default audio rendition for something we can't otherwise figure out. |
boolean |
display_this()
Ask the object whether an audio navigation should attempt to display this object, or should consider it a purely visual element and ignore it. |
void |
enter_action()
Perform any special action that needs to be done when navigation arrives at this object. |
void |
exit_action()
Perform any special action that needs to be done when navigation departs from this object. |
protected boolean |
extract_display_material(interactor subj)
Have a look at the given object and see if we can extract anything that we know how to display via audio. |
protected java.lang.String |
extract_text(interactor subj)
Extract any available text from the given object. |
protected static void |
init_known_translations()
Initialize the table of known interactor to audio icon translations if it hasn't been initialized already. |
protected static audio_renderer |
lookup_icon(java.lang.Class subj_class)
Try to look up an audio icon for a given interactor class. |
int |
num_actions()
Indicate how many actions this object supports. |
audio_renderer |
perform_action(int act_num,
event evt_cause,
java.lang.Object user_info)
Perform an action associated with this object. |
void |
set_subject(interactor subj)
Set the interactor object we are translating to audio |
audio_renderer |
start_feedback_for(int act_num)
Return an object describing audio feedback for the start of a particular action. |
boolean |
stop_here()
Ask the object whether an audio navigation should pause here to wait for the user, or continue to the next navigation position. |
interactor |
subject()
Interactor object we are translating to audio |
java.lang.String |
toString()
Convert to human readable display string for debugging |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected interactor _subject
protected boolean _forward_all
protected boolean _display_this
protected boolean _stop_here
protected boolean _accepts_input
protected audio_renderer _audio_rendition
protected java.lang.String _text_contents
protected java.lang.String _type_text
protected static java.util.Hashtable _known_translations
public static final java.lang.String default_audio_name
public static final java.lang.String default_spoken
protected static audio_renderer _default_audio_rendition
Constructor Detail |
public generic_audio_xlation(interactor subj)
interactor
- subjMethod Detail |
public interactor subject()
public void set_subject(interactor subj)
interactor
- subj our new subject interactorpublic java.lang.String toString()
protected java.lang.String extract_text(interactor subj)
interactor
- subj the object we extract text.protected java.lang.String build_type_name(interactor subj)
Currently we use the class name with underscores turned into spaces Later we should also provide a mechanism for doing special cases via a lookup table and/or aware interactors (and we might insert a space in places where a lower case letter is concatenated with an upper case letter).
interactor
- subj the object we are namingprotected static void init_known_translations()
public static void add_known_translation(java.lang.String class_name, java.lang.String audio_name)
String
- class_name string with the name of the class we are
entering a translation for. If there is no class
by that name an error is thrown.String
- audio_name name of the audio file (found relative to the
document base) to fetch the audio clip from.protected static audio_renderer lookup_icon(java.lang.Class subj_class)
protected audio_renderer build_audio_icon(interactor subj)
interactor
- subj the interactor we are building an icon forprotected boolean extract_display_material(interactor subj)
public boolean display_this()
public boolean stop_here()
public static audio_renderer default_audio_rendition()
public audio_renderer audio_rendition()
public void enter_action()
public void exit_action()
public int num_actions()
public audio_renderer start_feedback_for(int act_num)
int
- act_num number of the action in question.public audio_renderer perform_action(int act_num, event evt_cause, java.lang.Object user_info)
int
- act_num the index of the action to be performedevent
- evt_cause the event causing the action to be carried out.Object
- user_info the uninterpreted user_info that came with this
input
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |