Class MQPoint

Object
   |
   +--MQObject
         |
         +--MQPoint

class MQPoint

extends MQObject

Encapsulates X and Y coordinates.
Defined in mqcommon.js

Field Detail

x

int x

Value to represent the x value

y

int y

Value to represent the y value

MQPoint

MQPoint(<int/string> param1, <int> param2)

Constructs a new MQPoint object.

Parameters:
param1 - OPTIONAL: Depending on the absence of param2. If param2 exists then param1 is initial x (int - default is 0) otherwise param1 is xpath (string - default is "Point").
param2 - OPTIONAL: initial y (default is 0).

equals

Boolean equals(<MQPoint> pt)

Determines whether or not two points are equal. Two instances of Point are equal if the values of their x and y member fields, representing their position in the coordinate space, are the same.

Parameters:
pt - an MQPoint object to be compared with this MQPoint

Returns:
True if both the X and Y values are equal.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getX

int getX()

Gets X.

Returns:
The X value

getY

int getY()

Gets Y.

Returns:
The Y value

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.

setX

void setX(<int> x)

Sets X.

Parameters:
x - the value to set X to

setXY

void setXY(<int> x, <int> y)

Sets the horizontal and vertical coordinates to the values passed in.

Parameters:
x - the value to set X to
y - the value to set Y to

setY

void setY(<int> y)

Sets Y.

Parameters:
y - the value to set Y to

toString

string toString()

Returns a string representation of this MQPoint. The format is "x,y".

Returns:
a string representation of this MQPoint.

valid

Boolean valid()

Returns a true if both the X and Y values are set to a value other than the static "INVALID" value.

Returns:
True if both the X and Y values are not equal to the static "INVALID".