amber.type.server
Class XYConstraints

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

public class XYConstraints

extends java.lang.Object

This class contains the constraints which define the location and initial construction information for a component in a panel.

Version:

1.0.0

Author:

Dr. David J. Knowles

See Also:

BasePanel

Field Summary

protected int	height The height of the component.
protected java.lang.String	parameters Parameters to use when constructing the object.
protected java.lang.String	remoteClassName The class name of the corresponding remote component to create and attach to this server ComponentHandler.
protected int	width The width of the component.
protected int	x The x value of the top left point of the component.
protected int	y The y value of the top left point of the component.

Constructor Summary

XYConstraints()
Default Constructor.

XYConstraints(int x, int y, int width, int height)
Initialising Constructor.

XYConstraints(int x, int y, int width, int height, java.lang.String parameters)
Initialising Constructor.

XYConstraints(int x, int y, int width, int height, java.lang.String remoteClassName, java.lang.String parameters)
Initialising Constructor.

Method Summary

int	getHeight() Gets the data in the following variable: The height of the component.
java.lang.String	getParameters() Gets the data in the following variable: Parameters to use when constructing the object.
java.lang.String	getRemoteClassName() Gets the data in the following variable: The class name of the corresponding remote component to create and attach to this server ComponentHandler.
int	getWidth() Gets the data in the following variable: The width of the component.
int	getX() Gets the data in the following variable: The x value of the top left point of the component.
int	getY() Gets the data in the following variable: The y value of the top left point of the component.
void	setHeight(int data) Sets the data in the following variable: The height of the component.
void	setParameters(java.lang.String data) Sets the data in the following variable: Parameters to use when constructing the object.
void	setRemoteClassName(java.lang.String data) Sets the data in the following variable: The class name of the corresponding remote component to create and attach to this server ComponentHandler.
void	setWidth(int data) Sets the data in the following variable: The width of the component.
void	setX(int data) Sets the data in the following variable: The x value of the top left point of the component.
void	setY(int data) Sets the data in the following variable: The y value of the top left point of the component.
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

x

protected int x

The x value of the top left point of the component.

y

protected int y

The y value of the top left point of the component.

width

protected int width

The width of the component. If -1 will fill to the edge of the container.

height

protected int height

The height of the component. If -1 will fill to the edge of the container.

remoteClassName

protected java.lang.String remoteClassName

The class name of the corresponding remote component to create and attach to this server ComponentHandler. May be null in which case the default is used.

parameters

protected java.lang.String parameters

Parameters to use when constructing the object. This value is dependent on the remote component. May be null.

Constructor Detail

XYConstraints

public XYConstraints()

Default Constructor.

XYConstraints

public XYConstraints(int x,
                     int y,
                     int width,
                     int height)

Initialising Constructor.

Parameters:

x - The x value of the top left point of the component.

y - The y value of the top left point of the component.

width - The width of the component. If -1 will fill to the edge of the container.

height - The height of the component. If -1 will fill to the edge of the container.

XYConstraints

public XYConstraints(int x,
                     int y,
                     int width,
                     int height,
                     java.lang.String parameters)

Initialising Constructor.

Parameters:

x - The x value of the top left point of the component.

y - The y value of the top left point of the component.

width - The width of the component. If -1 will fill to the edge of the container.

height - The height of the component. If -1 will fill to the edge of the container.

parameters - Parameters to use when constructing the object. This value is dependent on the remote component. May be null.

XYConstraints

public XYConstraints(int x,
                     int y,
                     int width,
                     int height,
                     java.lang.String remoteClassName,
                     java.lang.String parameters)

Initialising Constructor.

Parameters:

x - The x value of the top left point of the component.

y - The y value of the top left point of the component.

width - The width of the component. If -1 will fill to the edge of the container.

height - The height of the component. If -1 will fill to the edge of the container.

remoteClassName - The class name of the corresponding remote component to create and attach to this server ComponentHandler. May be null in which case the default is used.

parameters - Parameters to use when constructing the object. This value is dependent on the remote component. May be null.

Method Detail

getX

public int getX()

Gets the data in the following variable: The x value of the top left point of the component.

Returns:

int containing the required information.

getY

public int getY()

Gets the data in the following variable: The y value of the top left point of the component.

Returns:

int containing the required information.

getWidth

public int getWidth()

Gets the data in the following variable: The width of the component. If -1 will fill to the edge of the container.

Returns:

int containing the required information.

getHeight

public int getHeight()

Gets the data in the following variable: The height of the component. If -1 will fill to the edge of the container.

Returns:

int containing the required information.

getRemoteClassName

public java.lang.String getRemoteClassName()

Gets the data in the following variable: The class name of the corresponding remote component to create and attach to this server ComponentHandler. May be null in which case the default is used.

Returns:

String containing the required information.

getParameters

public java.lang.String getParameters()

Gets the data in the following variable: Parameters to use when constructing the object. This value is dependent on the remote component. May be null.

Returns:

String containing the required information.

setX

public void setX(int data)

Sets the data in the following variable: The x value of the top left point of the component.

Parameters:

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

setY

public void setY(int data)

Sets the data in the following variable: The y value of the top left point of the component.

Parameters:

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

setWidth

public void setWidth(int data)

Sets the data in the following variable: The width of the component. If -1 will fill to the edge of the container.

Parameters:

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

setHeight

public void setHeight(int data)

Sets the data in the following variable: The height of the component. If -1 will fill to the edge of the container.

Parameters:

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

setRemoteClassName

public void setRemoteClassName(java.lang.String data)

Sets the data in the following variable: The class name of the corresponding remote component to create and attach to this server ComponentHandler. May be null in which case the default is used.

Parameters:

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

setParameters

public void setParameters(java.lang.String data)

Sets the data in the following variable: Parameters to use when constructing the object. This value is dependent on the remote component. May be null.

Parameters:

data - String 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.