com.objex.panywhere
Interface SymbolModel

All Known Implementing Classes:

Symbol

public interface SymbolModel

Defines the operations and/or properties that are permissible for a SymbolModel object. Symbols objects must implement this interface. In addition, any SymbolModel implementation must generate SymbolChangeEvents when a Symbol object is updated and provide methods for adding and removing event listeners for such events.

Since:

ver1.01

Method Summary

void	cloneSymbol(LegendItem mCon) Copies the symbols encoding details from the supplied Legend Item object and sets this symbol's properties accordingly.
Symbol	cloneSymbol(java.lang.String ownerid) Returns a clone of this Symbol object
java.awt.Color	getCenterCircleColor()
java.awt.Color	getCenterSquareColor()
java.lang.String	getOwnerID() Getter for property ownerID.
java.awt.Color	getQuad1DotColor() Getter for property quad1DotColor.
java.awt.Color	getQuad2DotColor() Getter for property quad2DotColor.
java.awt.Color	getQuad3DotColor() Getter for property quad3DotColor.
java.awt.Color	getQuad4DotColor() Getter for property quad4DotColor.
java.awt.Color	getQuadFourColor()
java.awt.Color	getQuadOneColor()
java.awt.Color	getQuadThreeColor()
java.awt.Color	getQuadTwoColor()
boolean	isHLine()
boolean	isQuad1Dot()
boolean	isQuad2Dot()
boolean	isQuad3Dot()
boolean	isQuad4Dot()
boolean	isQuestionMark()
boolean	isVLine()
boolean	matches(LegendItem mCon) Determines whether or not a Symbol had the specified LegendItem assigned to it.
void	setCenterCircleColor(java.awt.Color qColor) Sets the color value for the centre circle of the symbol.
void	setCenterCircleColor(int qColorRGB) Sets the RGB value for the color for the centre circle of the symbol.
void	setCenterSquareColor(java.awt.Color qColor) Sets the color for the centre square of the symbol.
void	setCenterSquareColor(int qColorRGB) Sets the RGB value for the color for the centre squqre of the symbol.
void	setHLine(boolean rhs) Sets or unsets the vertical line flag for this symbol depending on the value of parameter passed.
void	setOwnerID(java.lang.String ownerID) Setter for property ownerID.
void	setQuad1Dot(boolean bColor) Sets the symbol color for quadrant 1 dot to a default of black or to null depending on value of parameter bColor.
void	setQuad1DotColor(java.awt.Color quad1DotColor) Setter for property quad1DotColor.
void	setQuad2Dot(boolean bColor) Sets the symbol color for quadrant 2 dot to a default of black or to null depending on value of parameter bColor.
void	setQuad2DotColor(java.awt.Color quad2DotColor) Setter for property quad2DotColor.
void	setQuad3Dot(boolean bColor) Sets the symbol color for quadrant 3 dot to a default of black or to null depending on value of parameter bColor.
void	setQuad3DotColor(java.awt.Color quad3DotColor) Setter for property quad3DotColor.Must generate a SymbolChangeEvent with quadrant seven (7) as the source.
void	setQuad4Dot(boolean bColor) Sets the symbol color for quadrant 4 dot to a default of black or to null depending on value of parameter bColor.
void	setQuad4DotColor(java.awt.Color quad4DotColor) Setter for property quad4DotColor.
void	setQuadFourColor(java.awt.Color qColor) Sets the symbol color for quadrant 4.
void	setQuadFourColor(int qColorRGB) Sets the RGB value for the color in Quadrant 4.
void	setQuadOneColor(java.awt.Color qColor) Sets the symbol color for quadrant 1.
void	setQuadOneColor(int qColorRGB) Sets the RGB value for the color in Quadrant 1.
void	setQuadThreeColor(java.awt.Color qColor) Sets the symbol color for quadrant 3.
void	setQuadThreeColor(int qColorRGB) Sets the RGB value for the color in Quadrant 3.
void	setQuadTwoColor(java.awt.Color qColor) Sets the symbol color for quadrant 2.
void	setQuadTwoColor(int qColorRGB) Sets the RGB value for the color in Quadrant 2.
void	setQuestionMark(boolean q) Sets the flag to show question mark symbol to true or false.
void	setVLine(boolean vline)

Method Detail

isQuestionMark

boolean isQuestionMark()

Returns:

True if Question mark symbol is set and false otherwise

setQuestionMark

void setQuestionMark(boolean q)

Sets the flag to show question mark symbol to true or false. Must generate a SymbolChangeEvent with quadrant eleven(11) as the source.

Parameters:

q - The value to set (True or False)

isQuad1Dot

boolean isQuad1Dot()

Returns:

True if quadrant 1 dot must be shown

setQuad1Dot

void setQuad1Dot(boolean bColor)

Sets the symbol color for quadrant 1 dot to a default of black or to null depending on value of parameter bColor. Must generate a SymbolChangeEvent with quadrant five(5) as the source.

Parameters:

bColor - A boolean indicating whether or not to set the quadrant 1 dot to default color.

isQuad2Dot

boolean isQuad2Dot()

Returns:

True if quadrant 2 dot must be shown

setQuad2Dot

void setQuad2Dot(boolean bColor)

Sets the symbol color for quadrant 2 dot to a default of black or to null depending on value of parameter bColor. Must generate a SymbolChangeEvent with quadrant six(6) as the source.

Parameters:

bColor - A boolean indicating whether or not to set the quadrant 2 dot to default color.

isQuad3Dot

boolean isQuad3Dot()

Returns:

True if quadrant 3 dot must be shown

setQuad3Dot

void setQuad3Dot(boolean bColor)

Sets the symbol color for quadrant 3 dot to a default of black or to null depending on value of parameter bColor. Must generate a SymbolChangeEvent with quadrant seven(7) as the source.

Parameters:

bColor - A boolean indicating whether or not to set the quadrant 3 dot to default color.

isQuad4Dot

boolean isQuad4Dot()

Returns:

True if quadrant 4 dot must be shown

setQuad4Dot

void setQuad4Dot(boolean bColor)

Sets the symbol color for quadrant 4 dot to a default of black or to null depending on value of parameter bColor. Must generate a SymbolChangeEvent with quadrant eight(8) as the source.

Parameters:

bColor - A boolean indicating whether or not to set the quadrant 4 dot to default color.

isVLine

boolean isVLine()

Returns:

True if vertical line must be shown

setVLine

void setVLine(boolean vline)

isHLine

boolean isHLine()

Returns:

True if horizontal line must be shown

setHLine

void setHLine(boolean rhs)

Sets or unsets the vertical line flag for this symbol depending on the value of parameter passed.

Parameters:

rhs - Boolean indicating whether to set or unset the h/zontal line flag

getQuadOneColor

java.awt.Color getQuadOneColor()

Returns:

The current value of the Color for quadrant 1, null if no color is set

setQuadOneColor

void setQuadOneColor(java.awt.Color qColor)

Sets the symbol color for quadrant 1. Must generate a SymbolChangeEvent with quadrant one(1) as the source.

Parameters:

qColor - The new color for quadrant 1

setQuadOneColor

void setQuadOneColor(int qColorRGB)

Sets the RGB value for the color in Quadrant 1. Must generate a SymbolChangeEvent with quadrant one(1) as the source.

Parameters:

qColorRGB - The new RGB value

getQuadTwoColor

java.awt.Color getQuadTwoColor()

Returns:

The current value of the Color for quadrant 2, null if no color is set

setQuadTwoColor

void setQuadTwoColor(java.awt.Color qColor)

Sets the symbol color for quadrant 2. Must generate a SymbolChangeEvent with quadrant two(2) as the source.

Parameters:

qColor - The new color for quadrant 2

setQuadTwoColor

void setQuadTwoColor(int qColorRGB)

Sets the RGB value for the color in Quadrant 2. Must generate a SymbolChangeEvent with quadrant two(2) as the source.

Parameters:

qColorRGB - The new RGB value

getQuadThreeColor

java.awt.Color getQuadThreeColor()

Returns:

The current value of the Color for quadrant 3, null if no color is set

setQuadThreeColor

void setQuadThreeColor(java.awt.Color qColor)

Sets the symbol color for quadrant 3. Must generate a SymbolChangeEvent with quadrant three(3) as the source.

Parameters:

qColor - The new color for quadrant 3

setQuadThreeColor

void setQuadThreeColor(int qColorRGB)

Sets the RGB value for the color in Quadrant 3. Must generate a SymbolChangeEvent with quadrant three(3) as the source.

Parameters:

qColorRGB - The new RGB value

getQuadFourColor

java.awt.Color getQuadFourColor()

Returns:

The current value of the Color for quadrant 4, null if no color is set

setQuadFourColor

void setQuadFourColor(java.awt.Color qColor)

Sets the symbol color for quadrant 4. Must generate a SymbolChangeEvent with quadrant four(4) as the source.

Parameters:

qColor - The new color for quadrant 4

setQuadFourColor

void setQuadFourColor(int qColorRGB)

Sets the RGB value for the color in Quadrant 4. Must generate a SymbolChangeEvent with quadrant four(4) as the source.

Parameters:

qColorRGB - The new RGB value

getCenterCircleColor

java.awt.Color getCenterCircleColor()

Returns:

The current center Circle Color - null if no color is set

setCenterCircleColor

void setCenterCircleColor(java.awt.Color qColor)

Sets the color value for the centre circle of the symbol. Must generate a SymbolChangeEvent with quadrant nine (9) as the source.

Parameters:

qColor - The new color value

setCenterCircleColor

void setCenterCircleColor(int qColorRGB)

Sets the RGB value for the color for the centre circle of the symbol. Must generate a SymbolChangeEvent with quadrant nine (9) as the source.

Parameters:

qColorRGB - The new RGB value

getCenterSquareColor

java.awt.Color getCenterSquareColor()

Returns:

The current center square color - null if no color is set

setCenterSquareColor

void setCenterSquareColor(java.awt.Color qColor)

Sets the color for the centre square of the symbol. Must generate a SymbolChangeEvent with quadrant ten(10) as the source.

Parameters:

qColor - The new color value

setCenterSquareColor

void setCenterSquareColor(int qColorRGB)

Sets the RGB value for the color for the centre squqre of the symbol. Must generate a SymbolChangeEvent with quadrant ten(10) as the source.

Parameters:

qColorRGB - The new RGB value

cloneSymbol

void cloneSymbol(LegendItem mCon)

Copies the symbols encoding details from the supplied Legend Item object and sets this symbol's properties accordingly.

Parameters:

mCon - The legend item object to copy from

matches

boolean matches(LegendItem mCon)

Determines whether or not a Symbol had the specified LegendItem assigned to it. A Symbol is said to match a Legend Item object IFF all the set regions or non-NULL regions of a LegendItem are matched in the Symbol object. For instance if a LegendItem object has quadrant one (1) set to red and quadrant three (3) set to blue, then for a Symbol object to match this LegendItem, it must have the corresponding quadrants set to the same colors as in the LegendItem (red and blue in this case).

Parameters:

mCon - The legend item object to compare to

Returns:

True LegendItem was assigned to this Symbol such that the Symbol has the same regions with assigned to the same colors as in the LegendItem and only if the LegendItem regions are non-null.

Since:

Introduced ver1.01

cloneSymbol

Symbol cloneSymbol(java.lang.String ownerid)

Returns a clone of this Symbol object

getOwnerID

java.lang.String getOwnerID()

Getter for property ownerID.

Returns:

Value of property ownerID.

setOwnerID

void setOwnerID(java.lang.String ownerID)

Setter for property ownerID.

Parameters:

ownerID - New value of property ownerID.

getQuad1DotColor

java.awt.Color getQuad1DotColor()

Getter for property quad1DotColor.

Returns:

Value of property quad1DotColor.

setQuad1DotColor

void setQuad1DotColor(java.awt.Color quad1DotColor)

Setter for property quad1DotColor. Must generate a SymbolChangeEvent with quadrant five (5) as the source.

Parameters:

quad1DotColor - New value of property quad1DotColor.

getQuad2DotColor

java.awt.Color getQuad2DotColor()

Getter for property quad2DotColor.

Returns:

Value of property quad2DotColor.

setQuad2DotColor

void setQuad2DotColor(java.awt.Color quad2DotColor)

Setter for property quad2DotColor. Must generate a SymbolChangeEvent with quadrant six (6) as the source.

Parameters:

quad2DotColor - New value of property quad2DotColor.

getQuad3DotColor

java.awt.Color getQuad3DotColor()

Getter for property quad3DotColor.

Returns:

Value of property quad3DotColor.

setQuad3DotColor

void setQuad3DotColor(java.awt.Color quad3DotColor)

Setter for property quad3DotColor.Must generate a SymbolChangeEvent with quadrant seven (7) as the source.

Parameters:

quad3DotColor - New value of property quad3DotColor.

getQuad4DotColor

java.awt.Color getQuad4DotColor()

Getter for property quad4DotColor.

Returns:

Value of property quad4DotColor.

setQuad4DotColor

void setQuad4DotColor(java.awt.Color quad4DotColor)

Setter for property quad4DotColor. Must generate a SymbolChangeEvent with quadrant eight (8) as the source.

Parameters:

quad4DotColor - New value of property quad4DotColor.