org.xwiki.gwt.wysiwyg.client.plugin.macro

Class ParameterDescriptor

java.lang.Object

org.xwiki.gwt.wysiwyg.client.plugin.macro.ParameterDescriptor

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class ParameterDescriptor
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

Describes a macro parameter.

Version:

$Id: aedb005b11bf4eac689c999ffe4e3319de93aab1 $

Constructor Summary

Constructors

Constructor and Description
ParameterDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getId()
String	getName()
ParameterType	getType()
boolean	isMandatory()
void	setDefaultValue(String defaultValue) Sets the default value of the parameter.
void	setDescription(String description) Sets the description of this parameter.
void	setId(String id) Sets the identifier of this parameter.
void	setMandatory(boolean mandatory) Specify if this parameter is required or not.
void	setName(String name) Sets the display name of this parameter.
void	setType(ParameterType type) Sets the type of this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDescriptor

public ParameterDescriptor()

Method Detail

getId

public String getId()

Returns:

the identifier of this parameter

Since:

2.1M1

setId

public void setId(String id)

Sets the identifier of this parameter.

Parameters:

id - the identifier of the parameter

Since:

2.1M1

getName

public String getName()

Returns:

the display name of this parameter

Since:

2.1M1

setName

public void setName(String name)

Sets the display name of this parameter.

Parameters:

name - the display name of the parameter

Since:

2.1M1

getDescription

public String getDescription()

Returns:

the parameter description

setDescription

public void setDescription(String description)

Sets the description of this parameter.

Parameters:

description - the description of this parameter

getType

public ParameterType getType()

Returns:

the parameter type

setType

public void setType(ParameterType type)

Sets the type of this parameter.

Parameters:

type - the type of this parameter

getDefaultValue

public String getDefaultValue()

Returns:

the default value of the parameter

setDefaultValue

public void setDefaultValue(String defaultValue)

Sets the default value of the parameter.

Parameters:

defaultValue - a String representing the default value of the parameter

isMandatory

public boolean isMandatory()

Returns:

true if this parameter is required, false if not

setMandatory

public void setMandatory(boolean mandatory)

Specify if this parameter is required or not.

Parameters:

mandatory - true to make this parameter required, false otherwise