org.geomajas.configuration.client

Class ClientToolInfo

java.lang.Object

org.geomajas.configuration.client.ClientToolInfo

All Implemented Interfaces:

Serializable, IsInfo

@Api(allMethods=true)
public class ClientToolInfo
extends Object
implements IsInfo

Representation of a tool.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientToolInfo()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Get the description of the tool.
String	getIcon() Get the url of the icon.
String	getId() Get the unique id of this tool.
List<Parameter>	getParameters() Get the list of parameters for this tool.
String	getTitle() Get the title of the tool.
String	getToolId() Get the toolId used for fetching the org.geomajas.gwt.client.action.ToolbarBaseAction from org.geomajas.gwt.client.action.toolbar.ToolbarRegistry.
List<ClientToolInfo>	getTools() Get the list of tools this tool should list (in a drop-down panel for instance).
void	setDescription(String description) Set the description of the tool.
void	setIcon(String icon) Set the url of the icon.
void	setId(String value) Set the unique id for the tool.
void	setParameters(List<Parameter> value) Set the list of parameters for this tool.
void	setTitle(String title) Set the title of the tool.
void	setToolId(String toolId) Set the toolId used for fetching the org.geomajas.gwt.client.action.ToolbarBaseAction from org.geomajas.gwt.client.action.toolbar.ToolbarRegistry.
void	setTools(List<ClientToolInfo> tools) Set the list of tools this tool should list (in a drop-down panel for instance).

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientToolInfo

public ClientToolInfo()

Method Detail

getTools

public List<ClientToolInfo> getTools()

Get the list of tools this tool should list (in a drop-down panel for instance).

Returns:

list of ClientToolInfo

Since:

1.10.0

setTools

public void setTools(List<ClientToolInfo> tools)

Set the list of tools this tool should list (in a drop-down panel for instance).

Parameters:

tools - list of ClientToolInfo

Since:

1.10.0

getParameters

public List<Parameter> getParameters()

Get the list of parameters for this tool.

Returns:

list of Parameter

setParameters

public void setParameters(List<Parameter> value)

Set the list of parameters for this tool.

Parameters:

value - list of Parameter

getId

public String getId()

Get the unique id of this tool.

Returns:

tool id

setId

public void setId(String value)

Set the unique id for the tool.

Parameters:

value - unique tool id

setToolId

public void setToolId(String toolId)

Set the toolId used for fetching the org.geomajas.gwt.client.action.ToolbarBaseAction from org.geomajas.gwt.client.action.toolbar.ToolbarRegistry.

Parameters:

toolId - tool id

Since:

1.10.0

getToolId

public String getToolId()

Get the toolId used for fetching the org.geomajas.gwt.client.action.ToolbarBaseAction from org.geomajas.gwt.client.action.toolbar.ToolbarRegistry.

If toolId == null, the id is returned.

Returns:

tool id

Since:

1.10.0

getDescription

public String getDescription()

Get the description of the tool.

Returns:

the description

Since:

1.10.0

setDescription

public void setDescription(String description)

Set the description of the tool.

Parameters:

description - the description to set

Since:

1.10.0

getTitle

public String getTitle()

Get the title of the tool.

Returns:

the title

Since:

1.10.0

setTitle

public void setTitle(String title)

Set the title of the tool.

Parameters:

title - the title to set

Since:

1.10.0

getIcon

public String getIcon()

Get the url of the icon.

Returns:

the icon

Since:

1.10.0

setIcon

public void setIcon(String icon)

Set the url of the icon.

Parameters:

icon - the icon to set

Since:

1.10.0