org.a11y.brlapi

Class Parameter

java.lang.Object

org.a11y.brlapi.Component

org.a11y.brlapi.ParameterComponent

org.a11y.brlapi.Parameter

Direct Known Subclasses:

GlobalParameter, LocalParameter

public abstract class Parameter
extends ParameterComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Parameter.BooleanSettable
static interface	Parameter.ByteSettable
static interface	Parameter.IntSettable
static interface	Parameter.LongSettable
static interface	Parameter.Settable
static interface	Parameter.ShortSettable
static interface	Parameter.StringSettable
static class	Parameter.WatcherHandle

Field Summary

Fields inherited from class org.a11y.brlapi.ParameterComponent

DEFAULT_SUBPARAM

Fields inherited from class org.a11y.brlapi.Component

BYTE_MASK, UNICODE_BRAILLE_ROW

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Parameter(ConnectionBase connection)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get()
java.lang.Object	get(long subparam)
java.lang.String	getLabel()
java.lang.String	getName()
abstract int	getParameter()
protected java.lang.String	getParseDescription()
protected java.lang.Object	getValue()
protected java.lang.Object	getValue(long subparam)
boolean	hasSubparam()
abstract boolean	isGlobal()
boolean	isHidable()
boolean	isSettable()
void	set(long subparam, java.lang.String value)
void	set(java.lang.String value)
protected void	setValue(long subparam, java.lang.Object value)
java.lang.String	toString()
java.lang.String	toString(long subparam)
Parameter.WatcherHandle	watch(long subparam, ParameterWatcher watcher)
Parameter.WatcherHandle	watch(ParameterWatcher watcher)

Methods inherited from class org.a11y.brlapi.ParameterComponent

asBitMask, asBoolean, asBooleanArray, asByte, asByteArray, asDisplaySize, asDots, asDots, asInt, asIntArray, asLong, asLongArray, asRowCells, asShort, asShortArray, asString, toString

Methods inherited from class org.a11y.brlapi.Component

getObjectName, getObjectName, printf, toOperandName, toUnicodeBraille, toUnicodeBraille

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

protected Parameter(ConnectionBase connection)

Method Detail

getLabel

public java.lang.String getLabel()

getName

public java.lang.String getName()

getParameter

public abstract int getParameter()

isGlobal

public abstract boolean isGlobal()

hasSubparam

public boolean hasSubparam()

isHidable

public boolean isHidable()

getValue

protected final java.lang.Object getValue(long subparam)

getValue

protected final java.lang.Object getValue()

setValue

protected final void setValue(long subparam,
                              java.lang.Object value)

get

public java.lang.Object get(long subparam)

toString

public java.lang.String toString(long subparam)

get

public java.lang.Object get()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSettable

public final boolean isSettable()

getParseDescription

protected final java.lang.String getParseDescription()

set

public void set(long subparam,
                java.lang.String value)
         throws OperandException

Throws:

OperandException

set

public void set(java.lang.String value)
         throws OperandException

Throws:

OperandException

watch

public final Parameter.WatcherHandle watch(long subparam,
                                           ParameterWatcher watcher)

watch

public final Parameter.WatcherHandle watch(ParameterWatcher watcher)