|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.lbs.maps.model.AbstractMappable
net.rim.device.api.lbs.maps.model.geospatial.GsFolder
net.rim.device.api.lbs.maps.model.geospatial.GsRoot
public class GsRoot
Represents the top-level container that contains a hierarchy of GsElement items
and the StyleSet that is used to render the contents.
| Constructor Summary | ||
|---|---|---|
GsRoot()
Constructs a new instance of GsRoot. |
||
GsRoot(String name,
String description)
Constructs a GsRoot with the given name and description. |
||
GsRoot(String name,
String description,
GsElement[] elements)
Constructs a GsRoot with the given name, description, and contents. |
||
GsRoot(String name,
String description,
GsElement[] elements,
StyleSet styleSet)
Constructs a GsRoot with the given name, description, contents, and style set. |
||
| Method Summary | ||
|---|---|---|
void |
decomposeAndAddToModel(MapDataModel model)
Adds this root's contents to the given MapDataModel by iterating
over all the elements within this root and its child folders and
adding each discrete element to the model. |
|
void |
decomposeAndAddToModel(MapDataModel model,
String tag)
Add this root's contents to the given MapDataModel, tagging
each element with the given tag. |
|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
|
GsFolder |
getParent()
Retrieves the parent folder of this element. |
|
StyleSet |
getStyleSet()
Retrieves the set of styles that are used to display this collection of geospatial data. |
|
int |
hashCode()
Returns a hash code value for the object. |
|
void |
setParent(GsFolder parent)
Sets the parent folder of this element. |
|
void |
setStyleSet(StyleSet newStyleSet)
Sets the set of styles specific to this root. |
|
| Methods inherited from class net.rim.device.api.lbs.maps.model.geospatial.GsFolder |
|---|
addElement, addElements, elements, equalsHierarchically, equalsNode, getBoundingBox, getDescription, getElementAt, getName, insertElementAt, isClusterable, removeAllElements, removeElement, removeElementAt, setDescription, setElementAt, setName, size |
| Methods inherited from class net.rim.device.api.lbs.maps.model.AbstractMappable |
|---|
getCommandsByType, getStyleId, match, setStyleId |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.rim.device.api.lbs.maps.model.Mappable |
|---|
getStyleId |
| Constructor Detail |
|---|
public GsRoot()
GsRoot.
public GsRoot(String name,
String description)
GsRoot with the given name and description.
name - The name of the container.description - The description of the container.
public GsRoot(String name,
String description,
GsElement[] elements)
GsRoot with the given name, description, and contents.
name - The name of the container.description - The description of the container.elements - The contents of the container.
public GsRoot(String name,
String description,
GsElement[] elements,
StyleSet styleSet)
GsRoot with the given name, description, contents, and style set.
name - The name of the container.description - The description of the container.elements - The contents of the container.styleSet - The style set of the container.| Method Detail |
|---|
public StyleSet getStyleSet()
public void setStyleSet(StyleSet newStyleSet)
newStyleSet - The set of styles to use for this root.public GsFolder getParent()
GsElement
getParent in interface GsElementgetParent in class GsFolderpublic void setParent(GsFolder parent)
GsElement
setParent in interface GsElementsetParent in class GsFolderparent - The parent folder of this element.public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
hashCode in class GsFolderObject.equals(java.lang.Object),
Hashtablepublic boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
x
and y, multiple invocations of x.equals(y)
consistently return true or consistently return
false, provided no information used in
equals comparisons on the object is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any reference values x and y,
this method returns true if and only if x and
y refer to the same object (x==y has the
value true).
equals in class GsFolderobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtablepublic void decomposeAndAddToModel(MapDataModel model)
MapDataModel by iterating
over all the elements within this root and its child folders and
adding each discrete element to the model.
model - The MapDataModel to add the contained elements to.
public void decomposeAndAddToModel(MapDataModel model,
String tag)
MapDataModel, tagging
each element with the given tag.
model - The MapDataModel to which the contained elements will be added.tag - The tag to apply to each element.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal