edu.byu.deg.osmx
Interface PositionedElement

All Known Implementing Classes:
OSMXAnchorType, OSMXGenSpecType, OSMXObjectSetType, OSMXObjectType, OSMXPositionedText, OSMXRelationshipSetType

public interface PositionedElement

Represents an element that occupies a location on a graphical surface.


Method Summary
 void addPositionListener(PositionListener pl)
          Registers an object to listen for position changes by this element.
 int getOrder()
          Returns the z-coordinate of the element.
 int getX()
          Returns the x-coordinate of the element.
 int getY()
          Returns the y-coordinate of the element.
 boolean isSetPosition()
          Indicates whether this element has explicitly been given an x and y coordinate position.
 void removePositionListener(PositionListener pl)
          Un-registers an object currently listening for position change events.
 void setOrder(int value)
          Changes the value of the order attribute and notifies the position change listeners.
 void setX(int value)
          Changes the x-coordinate position and causes any position listeners to be notified.
 void setY(int value)
          Changes the y-coordinate position and causes any position listeners to be notified.
 void unsetX()
          Clears the current setting for the x attribute.
 void unsetY()
          Clears the current setting for the y attribute.
 

Method Detail

getX

public int getX()
Returns the x-coordinate of the element.

Returns:
The x-coordinate of the element.

getY

public int getY()
Returns the y-coordinate of the element.

Returns:
The y-coordinate of the element.

getOrder

public int getOrder()
Returns the z-coordinate of the element.

Returns:
The z-coordinate of the element.

setX

public void setX(int value)
Changes the x-coordinate position and causes any position listeners to be notified.

Parameters:
value - The new x-coordinate position of this element.

setY

public void setY(int value)
Changes the y-coordinate position and causes any position listeners to be notified.

Parameters:
value - The new y-coordinate position of this element.

setOrder

public void setOrder(int value)
Changes the value of the order attribute and notifies the position change listeners.

Parameters:
value - The new value for the z-order of this element.

addPositionListener

public void addPositionListener(PositionListener pl)
Registers an object to listen for position changes by this element.

Parameters:
pl - The object to register for position change event notification.

removePositionListener

public void removePositionListener(PositionListener pl)
Un-registers an object currently listening for position change events.

Parameters:
pl - The object to remove from the notification list for position changes.

isSetPosition

public boolean isSetPosition()
Indicates whether this element has explicitly been given an x and y coordinate position.

Returns:
true if both the x and y coordinate attributes have been set; false otherwise.

unsetX

public void unsetX()
Clears the current setting for the x attribute.


unsetY

public void unsetY()
Clears the current setting for the y attribute.