com.ge.research.acuity.ui
Class IndependentDisplayPO

java.lang.Object
  com.ge.research.acuity.ui.PresentationObject
      com.ge.research.acuity.ui.IndependentDisplayPO

Direct Known Subclasses:

DisplayGroupPO, DocumentPO, GraphPO, InteractionObject, TablePO, TextPO

public abstract class IndependentDisplayPO

extends PresentationObject

An abstract class that represents a presentation object that can be rendered independently of any other presentation object or information contained by other presentation objects. All information about position, and idetification display are contained by this class. Only IndependentDisplayPOs can be rendered by client applications. PresentaionObjects that are not of the type IndependentDisplayPO must be contained by an IndependentDisplayPO object in order for their information to be processed and contribute to a presentation object display.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:24 $

Author:

garbiras

Constructor Summary

IndependentDisplayPO()

Method Summary

boolean	canBeRemoved() Retrieves the removeable property of the Presentation Object, which tells whether or not the Presentation Object can be removed from the vantage
boolean	displayBanner() Returns the flag indicating whether to render a window banner for this PresentationObject.
int	getHeight() Returns the height of the PresentationObject
java.lang.String	getIdentifierTitle() Returns the presentation object window title string
int	getWidth() Returns the width of the PresentationObject
int	getXPos() Returns the x-coordinate of the PresentationObject
int	getYPos() Returns the y-coordinate of the PresentationObject
int	getZOrder() Returns the layer index of the PresentationObject.
void	setCanBeRemoved(boolean b) Sets the removeable property of the Presentation Object, allowing or dissallowing it to be removed from the vantage
void	setDisplayBanner(boolean val) Sets the flag indicating whether to render a window banner for this PresentationObject.
void	setHeight(int i) Sets the height of the PresentationObject
void	setIdentifier(java.lang.String string) Sets the identification string for the presentation object.
void	setIdentifierTitle(java.lang.String string) Sets the presentation object window title string.
void	setPos(int x, int y) Sets the position of this presentation object to the supplied x and y coordinates.
void	setPos(int x, int y, int z) Sets the position of this presentation object to the supplied x and y coordinates and zOrder index.
void	setPos(int x, int y, int h, int w) Sets the position of this presentation object to the supplied x and y coordinates.
void	setPos(int x, int y, int z, int h, int w) Sets the position of this presentation object to the supplied x and y coordinates and zOrder index.
void	setWidth(int i) Sets the width of the PresentationObject
void	setXPos(int i) Sets the x-coordinate of the PresentationObject
void	setYPos(int i) Sets the y-coordinate of the PresentationObject
void	setZOrder(int i) Sets the layer index of the PresentationObject.

Methods inherited from class com.ge.research.acuity.ui.PresentationObject

addLookupInfo, getHasPresentationNature, getIdentifier, getLookupInfo, getSubject, hasSubject, isDisplayed, isEditable, setEditability, setHasPresentationNature, setIsDisplayed

Methods inherited from class java.lang.Object

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

Constructor Detail

IndependentDisplayPO

public IndependentDisplayPO()

Method Detail

canBeRemoved

public final boolean canBeRemoved()

Retrieves the removeable property of the Presentation Object, which tells whether or not the Presentation Object can be removed from the vantage

Returns:

true if the Presentation Object can be removed from the vantage; false otherwise.

displayBanner

public final boolean displayBanner()

Returns the flag indicating whether to render a window banner for this PresentationObject.

Returns:

true if the window banner is to be rendered with this object; false if no window banner is to be rendered with this object

getHeight

public final int getHeight()

Returns the height of the PresentationObject

Returns:

The height of the presentation object

getIdentifierTitle

public final java.lang.String getIdentifierTitle()

Returns the presentation object window title string

Returns:

The display string for the presentation object title bar

getWidth

public final int getWidth()

Returns the width of the PresentationObject

Returns:

The width of the presentation object

getXPos

public final int getXPos()

Returns the x-coordinate of the PresentationObject

Returns:

The x-coordinate of the presentation object

getYPos

public final int getYPos()

Returns the y-coordinate of the PresentationObject

Returns:

The y-coordinate of the presentation object

getZOrder

public final int getZOrder()

Returns the layer index of the PresentationObject. Higher orders are displayed ontop of or over lower orders.

Returns:

The layer order of the presentation object

setDisplayBanner

public final void setDisplayBanner(boolean val)

Sets the flag indicating whether to render a window banner for this PresentationObject.

Parameters:

val - true if the window banner is to be rendered with this object; false if no window banner is to be rendered with this object

setHeight

public void setHeight(int i)

Sets the height of the PresentationObject

Parameters:

i - the height of the presentation object

setIdentifier

public final void setIdentifier(java.lang.String string)

Description copied from class: PresentationObject

Sets the identification string for the presentation object. If string is null or empty, than the identifier does not get changed.

Overrides:

setIdentifier in class PresentationObject

Parameters:

string -

See Also:

PresentationObject.setIdentifier(java.lang.String)

setIdentifierTitle

public final void setIdentifierTitle(java.lang.String string)

Sets the presentation object window title string. If the supplied string is null or empty, the identifier string is attempted to be made into the title string, otherwise a default title string is used to alert the client that no good title exists for the presentation object.

Parameters:

string - the display string for the presentation object title bar

See Also:

StringUtils.makeHumanReadableURI(java.lang.String)

setPos

public void setPos(int x,
                   int y)

Sets the position of this presentation object to the supplied x and y coordinates. The zOrder, width, and height are left unchanged.

Parameters:

x - the x-coordinate of the presentation object

y - the y-coordinate of the presentation object

See Also:

setXPos(int), setYPos(int)

setPos

public void setPos(int x,
                   int y,
                   int z)

Sets the position of this presentation object to the supplied x and y coordinates and zOrder index. The width, and height are left unchanged.

Parameters:

x - the x-coordinate of the presentation object

y - the y-coordinate of the presentation object

z - the layer index of the presentation object

See Also:

setPos(int, int), setZOrder(int)

setPos

public void setPos(int x,
                   int y,
                   int h,
                   int w)

Sets the position of this presentation object to the supplied x and y coordinates. Sets the width and height of this presentation object to the supplied dimensions. The zOrder is left unchanged.

Parameters:

x - the x-coordinate of the presentation object

y - the y-coordinate of the presentation object

h - the height of the presentation object

w - the width of the presentation object

See Also:

setPos(int, int), setHeight(int), setWidth(int)

setPos

public void setPos(int x,
                   int y,
                   int z,
                   int h,
                   int w)

Sets the position of this presentation object to the supplied x and y coordinates and zOrder index. Sets the width and height of this presentation object to the supplied dimensions.

Parameters:

x - the x-coordinate of the presentation object

y - the y-coordinate of the presentation object

z - the layer index of the presentation object

h - the height of the presentation object

w - the width of the presentation object

See Also:

setPos(int, int, int, int), setZOrder(int)

setCanBeRemoved

public final void setCanBeRemoved(boolean b)

Sets the removeable property of the Presentation Object, allowing or dissallowing it to be removed from the vantage

Parameters:

b - true if the Presentation Object can be removed from the vantage; false otherwise

setWidth

public void setWidth(int i)

Sets the width of the PresentationObject

Parameters:

i - the width of the presentation object

setXPos

public final void setXPos(int i)

Sets the x-coordinate of the PresentationObject

Parameters:

i - the x-coordinate of the presentation object

setYPos

public final void setYPos(int i)

Sets the y-coordinate of the PresentationObject

Parameters:

i - the y-coordinate of the presentation object

setZOrder

public void setZOrder(int i)

Sets the layer index of the PresentationObject. Higher orders are displayed ontop of or over lower orders.

Parameters:

i - the layer order of the presentation object