org.thdl.tib.input
Class JskadKeyboard

java.lang.Object
  |
  +--org.thdl.tib.input.JskadKeyboard

public class JskadKeyboard
extends Object

A JskadKeyboard is the high-level view of a Tibetan-input keyboard that Jskad has. Each keyboard is associated with a .ini file (except for the built-in, extended Wylie keyboard), an RTF document for end users, and a short identifying string.

Author:
David Chandler

Field Summary
private  String keybdId
          a short identifying string
private  String keybdIniFile
          the name of the .ini file for this keyboard
private  String keybdQuickRefFile
          an optional RTF document
private  org.thdl.util.RTFPane keybdRTFPane
          Cached RTFPane displaying the contents of the .rtf "quick reference" file associated with this keyboard.
private  URL tibKeybdURL
          the associated .ini file, which is read in only when needed and only once
 
Constructor Summary
JskadKeyboard(String identifyingString, String dotIniResourceName, String RTFResourceName)
          Creates a new JskadKeyboard.
 
Method Summary
 void activate(org.thdl.tib.input.DuffPane dp)
          Activates this keyboard for the given DuffPane.
 String getIdentifyingString()
          Returns the short identifying string associated with this keyboard.
 org.thdl.util.RTFPane getQuickRefPane()
          Returns an RTFPane displaying the contents of the "Quick Reference" .rtf file associated with this keyboard, or null if no such file is associated with this keyboard.
 boolean hasQuickRefFile()
          Returns true iff there is a "Quick Reference" document associated with this keyboard.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

keybdRTFPane

private org.thdl.util.RTFPane keybdRTFPane
Cached RTFPane displaying the contents of the .rtf "quick reference" file associated with this keyboard.


keybdQuickRefFile

private String keybdQuickRefFile
an optional RTF document


keybdId

private String keybdId
a short identifying string


keybdIniFile

private String keybdIniFile
the name of the .ini file for this keyboard


tibKeybdURL

private URL tibKeybdURL
the associated .ini file, which is read in only when needed and only once

Constructor Detail

JskadKeyboard

public JskadKeyboard(String identifyingString,
                     String dotIniResourceName,
                     String RTFResourceName)
Creates a new JskadKeyboard.

Parameters:
identifyingString - a short string used in the GUI to identify this keyboard
dotIniResourceName - the name of the .ini file used to initialize this keyboard, or null for the built-in extended Wylie keyboard
RTFResourceName - the optional name of the .rtf file that gives users a quick reference to this keyboard (null if no such file is available)
Method Detail

getQuickRefPane

public org.thdl.util.RTFPane getQuickRefPane()
Returns an RTFPane displaying the contents of the "Quick Reference" .rtf file associated with this keyboard, or null if no such file is associated with this keyboard.


hasQuickRefFile

public boolean hasQuickRefFile()
Returns true iff there is a "Quick Reference" document associated with this keyboard.


getIdentifyingString

public String getIdentifyingString()
Returns the short identifying string associated with this keyboard.


activate

public void activate(org.thdl.tib.input.DuffPane dp)
Activates this keyboard for the given DuffPane.

Parameters:
dp - the DuffPane for which this keyboard will be made the active keyboard


These API docs were created 02/02/2003 08:20 PM.
Copyright © 2001-2002 Tibetan and Himalayan Digital Library. All Rights Reserved.
Hosted by SourceForge_Logo