amber.type.server
Class DrawOperation

java.lang.Object
  |
  +--amber.type.server.DrawOperation

public class DrawOperation

extends java.lang.Object

Field Summary

protected java.lang.Object	data Data object associated with the operation.
protected int[]	drawInfo Drawing information relating to the operation performed.
static int	FlagsIndex
static int	OperationIndex

Constructor Summary

DrawOperation()
Default Constructor.

DrawOperation(int[] drawInfo, java.lang.Object data)
Initialising Constructor.

DrawOperation(int[] drawInfo, java.lang.Object data, long handle)
Initialising Constructor.

Method Summary

boolean	equals(long value) Checks for a match to a handle value.
java.lang.Object	getData() Gets the data in the following variable: Data object associated with the operation.
int[]	getDrawInfo() Gets the data in the following variable: int array containing information specific to the drawing
int	getFlags() Gets the data in the following variable: Any useful flags relating to the specified operation.
long	getHandle() This function returns the unique handle associated with this object.
int	getOperation() Gets the data in the following variable: Type of operation to perform
void	setData(java.lang.Object data) Sets the data in the following variable: Data object associated with the operation.
void	setDrawInfo(int[] data) Sets the data in the following variable: int array containing information specific to the drawing
void	setFlags(int data) Sets the data in the following variable: Any useful flags relating to the specified operation.
void	setOperation(int data) Sets the data in the following variable: Type of operation to perform
java.lang.String	toString() This function returns the String form of the data.

Methods inherited from class java.lang.Object

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

Field Detail

OperationIndex

public static final int OperationIndex

FlagsIndex

public static final int FlagsIndex

data

protected java.lang.Object data

Data object associated with the operation.

drawInfo

protected int[] drawInfo

Drawing information relating to the operation performed.

Constructor Detail

DrawOperation

public DrawOperation()

Default Constructor.

DrawOperation

public DrawOperation(int[] drawInfo,
                     java.lang.Object data)
              throws ComponentHandlerException

Initialising Constructor.

Parameters:

drawInfo - int array containing information specific to the drawing operation. The first int is the operation and the second is flags relating to the operation.

data - Data object associated with the operation.

Throws:

ComponentHandlerException - with errors in the data.

DrawOperation

public DrawOperation(int[] drawInfo,
                     java.lang.Object data,
                     long handle)
              throws ComponentHandlerException

Initialising Constructor. This is used when replicating an old operation.

Parameters:

drawInfo - int array containing information specific to the drawing operation. The first int is the operation and the second is flags relating to the operation.

data - Data object associated with the operation.

handle. - The handle to use for this object.

Throws:

ComponentHandlerException - with errors in the data.

Method Detail

getOperation

public int getOperation()

Gets the data in the following variable: Type of operation to perform

Returns:

int containing the required information.

getFlags

public int getFlags()

Gets the data in the following variable: Any useful flags relating to the specified operation.

Returns:

int containing the required information.

getData

public java.lang.Object getData()

Gets the data in the following variable: Data object associated with the operation.

Returns:

Object containing the required information.

getDrawInfo

public int[] getDrawInfo()

Gets the data in the following variable: int array containing information specific to the drawing

Returns:

int containing the required information.

getHandle

public long getHandle()

This function returns the unique handle associated with this object.

Returns:

long handle for the operation.

setOperation

public void setOperation(int data)

Sets the data in the following variable: Type of operation to perform

Parameters:

data - int containing the data to set the variable to.

setFlags

public void setFlags(int data)

Sets the data in the following variable: Any useful flags relating to the specified operation.

Parameters:

data - int containing the data to set the variable to.

setData

public void setData(java.lang.Object data)

Sets the data in the following variable: Data object associated with the operation.

Parameters:

data - Object containing the data to set the variable to.

setDrawInfo

public void setDrawInfo(int[] data)

Sets the data in the following variable: int array containing information specific to the drawing

Parameters:

data - int containing the data to set the variable to.

toString

public java.lang.String toString()

This function returns the String form of the data.

Overrides:

toString in class java.lang.Object

Returns:

String containing the string version of this class.

equals

public boolean equals(long value)

Checks for a match to a handle value.

Returns:

true if the input long matches the internal handle.