com.tomtom.pnd.maplib

Class Renderable

java.lang.Object

com.tomtom.pnd.maplib.Renderable

Direct Known Subclasses:

Primitive, RenderableLayer

public abstract class Renderable
extends java.lang.Object

A Renderable is a object which can be rendered by CustomOverlayRenderer.

Since:

5 (15.5 Moretti)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Renderable(boolean isVisible, boolean isSelectable, int zIndex)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Object	getTag()
int	getZIndex() Gets the zIndex of this Renderable.
int	hashCode()
boolean	isSelectable() Returns the flag indicating whether this Renderable is selectable.
boolean	isVisible() Returns the visibility of this Renderable.
void	selectable(boolean isSelectable) Sets the selectability of this Renderable.
void	setTag(java.lang.Object tag) Sets the tag associated with this Renderable.
void	setVisibility(boolean isVisible) Sets the visibility of this Renderable.
void	setZIndex(int zIndex) Sets the zIndex of this Renderable.

Methods inherited from class java.lang.Object

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

Constructor Detail

Renderable

protected Renderable(boolean isVisible,
          boolean isSelectable,
          int zIndex)

Method Detail

setVisibility

public void setVisibility(boolean isVisible)

Sets the visibility of this Renderable.

Parameters:

isVisible - If true, then the primitive is visible; if false, it is not.

selectable

public void selectable(boolean isSelectable)

Sets the selectability of this Renderable.

Parameters:

isSelectable - If true, then the primitive is selectable; if false, it is not.

isVisible

public boolean isVisible()

Returns the visibility of this Renderable.

Returns:

true if the primitive is to be visible; false if it is not.

isSelectable

public boolean isSelectable()

Returns the flag indicating whether this Renderable is selectable.

Returns:

true if the primitive is to be selectable; false if it is not.

setZIndex

public void setZIndex(int zIndex)

Sets the zIndex of this Renderable. Renderable with higher zIndices are drawn above those with lower indices.

Parameters:

zIndex - the zIndex of this Renderable.

getZIndex

public int getZIndex()

Gets the zIndex of this Renderable.

Returns:

the zIndex of the Renderable.

setTag

public void setTag(java.lang.Object tag)

Sets the tag associated with this Renderable. Tags can be used to store data within a Renderable without resorting to another data structure.

Parameters:

tag - An Object to tag this Renderable with. May be null.

getTag

public java.lang.Object getTag()

Returns:

The Object stored in this Renderable as a tag, or null if not set.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object