com.uc4.api.objects

Class CodeTable

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.CodeTable

public class CodeTable
extends UC4Object

This class represents a Automic CodeTable object.

Constructor Summary

Constructors

Constructor and Description
CodeTable()

Method Summary

Modifier and Type	Method and Description
char	getAlternativeCharacter() Returns the alternative character of this code table.
char	getCharacter(int row, int column) Gets the character at the given position in the code table.
boolean	hasAlternativeCharacter() Whether or not the code table has an alternative character.
Header	header() Returns the header data of this object.
boolean	isAlternativeCharacter(int row, int column) Whether or not the character at the given position is marked as alternative character.
boolean	isExecutable() Returns true if this Object can be executed.
boolean	isTextCharacter(int row, int column) Whether or not the character at the given position is marked as text character.
void	setAttributes(int row, int column, boolean textCharacter, boolean alternativeCharacter) Sets an attribute for a character at the given position in the code table.
void	setCharacter(int row, int column, char value) Sets a character (value) for the given position in the code table.

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeTable

public CodeTable()

Method Detail

header

public Header header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

setCharacter

public void setCharacter(int row,
                         int column,
                         char value)

Sets a character (value) for the given position in the code table. The row and column must be in range [0,15].

Parameters:

row - Row must be in range [0,15].

column - Column must be in range [0,15].

value - The character.

getCharacter

public char getCharacter(int row,
                         int column)

Gets the character at the given position in the code table. The row and column must be in range [0,15].

Parameters:

row - Row must be in range [0,15].

column - Column must be in range [0,15].

Returns:

The character at the given position in the code table or Unicode 0 if no character was set for this position.

setAttributes

public void setAttributes(int row,
                          int column,
                          boolean textCharacter,
                          boolean alternativeCharacter)

Sets an attribute for a character at the given position in the code table. At the moment there are two attributes which can be set. Attribute text character and alternative character. If an alternative character was set already further will be ignored as long as the current one is reseted.

Parameters:

row - Row must be in range [0,15].

column - Column must be in range [0,15].

textCharacter - Activate the option text character if this character should be considered for the conversion.

alternativeCharacter - The alternative character is used if the requested character is not found. Only one character can be defined as alternative character.

isTextCharacter

public boolean isTextCharacter(int row,
                               int column)

Whether or not the character at the given position is marked as text character.

Parameters:

row - Row must be in range [0,15].

column - Column must be in range [0,15].

Returns:

True if marked as text character otherwise false.

isAlternativeCharacter

public boolean isAlternativeCharacter(int row,
                                      int column)

Whether or not the character at the given position is marked as alternative character.

Parameters:

row - Row must be in range [0,15].

column - Column must be in range [0,15].

Returns:

True if marked as alternative character otherwise false.

hasAlternativeCharacter

public boolean hasAlternativeCharacter()

Whether or not the code table has an alternative character.

Returns:

True is returned if there is one otherwise false.

getAlternativeCharacter

public char getAlternativeCharacter()

Returns the alternative character of this code table. Might not be set. Call hasAlternativeCharacter first to check whether the code table has an alternative character. If there is no such alternative character this method will return Unicode 0.

Returns:

The alternative character or Unicode 0.

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.