fr.ove.palette
Class PaletteInfo

java.lang.Object
  fr.ove.palette.PaletteInfo

All Implemented Interfaces:

java.io.Serializable

public class PaletteInfo

extends java.lang.Object

implements java.io.Serializable

The palette information.
The kind of palette currently used is for different operators requiring particular syntax. The instance of this class contain this particular syntax.
Moreover, when these operators take one or more arguments, the syntax is often made of brackets and eventually separators (according to the arity of the operator). The instance of this class contains also an offset representing where to start entering the argument(s) of the operator.
For example, the button (or other) in the palette associated to the trigonometric function sin, will will provide an instance of this class with the syntax sin() and the offset 4.

Version:

1.0 18/09/1999

Author:

© 1999 DIRAT Laurent

See Also:

Serialized Form

Constructor Summary

PaletteInfo(java.lang.String syntax, byte offset)
the constructor.

Method Summary

byte	getOffset() Returns the offset associated to the syntax.
java.lang.String	getSyntax() Returns the syntax of the associated operator in the palette.
void	setOffset(byte offset) Sets the offset associated to the syntax.
void	setSyntax(java.lang.String syntax) Sets the syntax of the associated operator in the palette.
java.lang.String	toString() For Debugg.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaletteInfo

public PaletteInfo(java.lang.String syntax,
                   byte offset)

the constructor.

Parameters:

syntax - the syntax of the associated operator in the palette.

offset - the offset associated to the syntax.

Method Detail

setSyntax

public void setSyntax(java.lang.String syntax)

Sets the syntax of the associated operator in the palette.

Parameters:

syntax - the syntax of the associated operator in the palette.

getSyntax

public java.lang.String getSyntax()

Returns the syntax of the associated operator in the palette.

setOffset

public void setOffset(byte offset)

Sets the offset associated to the syntax.

Parameters:

offset - the offset associated to the syntax. Its value must be > 0

getOffset

public byte getOffset()

Returns the offset associated to the syntax.

toString

public java.lang.String toString()

For Debugg. Turns the instance into a String