|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.faces.event.ToolItemCollection
public class ToolItemCollection
A collection of ToolItem
objects. Any given map or page control is associated with one ToolItemCollection. An
entry in the collection follows this syntax:
<tool-item> <key>ZoomIn</key> <action-class>com.esri.adf.web.faces.event.ZoomInToolAction</action-class> <client-action>MapDragRectangle</client-action> </tool-item>By default, the tools are loaded from default.xml in the web application's tools directory.
Constructor Summary | |
---|---|
ToolItemCollection()
Constructs an empty ToolItemCollection object. |
Method Summary | |
---|---|
void |
add(ToolItem toolItem)
Adds the tool item to this tool item collection. |
ToolItem |
getActiveTool()
|
String |
getDescription()
Returns a description of the collection. |
static ToolItemCollection |
getMapToolItemCollection(String mapId)
|
String |
getName()
Returns the name of the collection. |
ToolAction |
getToolAction(String toolKey)
Returns the tool action associated with the specified tool key. |
ToolItem |
getToolItem(String toolKey)
Returns the ToolItem object represented by this key. |
Collection<ToolItem> |
getToolItems()
Return the current tool item collection. |
static void |
resetToolItemCollections()
|
void |
setActiveTool(String activeToolKey)
|
void |
setActiveTool(ToolItem activeTool)
|
static void |
setMapToolItemCollection(String mapId,
ToolItemCollection toolItemCollection)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ToolItemCollection()
Method Detail |
---|
public static ToolItemCollection getMapToolItemCollection(String mapId)
public static void setMapToolItemCollection(String mapId, ToolItemCollection toolItemCollection)
public static void resetToolItemCollections()
public void setActiveTool(ToolItem activeTool)
public void setActiveTool(String activeToolKey)
public ToolItem getActiveTool()
public String getName()
WebApplication
must
have a unique name.
String
- the unique collection namepublic String getDescription()
String
- the descriptionpublic ToolItem getToolItem(String toolKey)
ToolItem
object represented by this key.
toolKey
- the key for the ToolItem
in the ToolItemCollection
ToolItem
- object describing the tool itempublic Collection<ToolItem> getToolItems()
Collection
- tool item collection objectpublic ToolAction getToolAction(String toolKey)
toolKey
- the key for the ToolItem
in the ToolItemCollection
ToolAction
- object describing the tool actionpublic void add(ToolItem toolItem)
toolItem
- tool item object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |