com.blackledge.david.tivo.widgets.qk
Class QKCue

java.lang.Object
  com.blackledge.david.tivo.widgets.qk.QKCue

public class QKCue
extends Object

Objects that tell the QuickKeyboard how to give the user hints about what regions of the character layout will get activated by different key presses. E.g. a cue that pressing "1" will activate the first row of keys (KEY_NUM_1, position 0,0; width ?; height 1) - the next set of cues might then indicate that pressing "1" again will activate the first character in that row. (KEY_NUM_1, position 0,0; width 1; height 1)

Version:

1.0

Constructor Summary

QKCue(int column, int row, int keyCode)
shortcut for cues that cover only 1 character width/height.

QKCue(int column, int row, int width, int height, int keyCode)
Create a QuickKeyboard cue identifying a region of the keyboard character layout

Method Summary

int	getColumn()
List	getCues()
int	getHeight()
int	getKeyCode()
int	getRow()
int	getWidth()
void	setBounds(int column, int row, int width, int height)
void	setCues(List cues) Optional list of related cues (or whatever) for custom use by the handler, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QKCue

public QKCue(int column,
             int row,
             int width,
             int height,
             int keyCode)

Create a QuickKeyboard cue identifying a region of the keyboard character layout

Parameters:

column - 0-based column number of the cue - the left of the cue area

row - 0-based row number of the cue - the top of the cue area

width - number of characters that this cue will include horizontally

height - number of characters that this cue will include vertically

keyCode - the HME keyCode that will activate the region represented by these dimensions.

QKCue

public QKCue(int column,
             int row,
             int keyCode)

shortcut for cues that cover only 1 character width/height.

Parameters:

column -

row -

keyCode -

Method Detail

setCues

public void setCues(List cues)

Optional list of related cues (or whatever) for custom use by the handler, e.g. a hierarchical tree of cues: when this cue instance is activated, the handler can pull this list of cues from it to return as the new set of active cues.

Parameters:

cues -

getCues

public List getCues()

Returns:

the list of Cues set with setCues(List) - may be null.

getColumn

public int getColumn()

getRow

public int getRow()

getWidth

public int getWidth()

getHeight

public int getHeight()

getKeyCode

public int getKeyCode()

setBounds

public void setBounds(int column,
                      int row,
                      int width,
                      int height)