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

Class MacroDescriptor

java.lang.Object

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

All Implemented Interfaces:

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

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

Describes a macro and its parameters.

NOTE: This class is a serializable, GWT-supported clone of the MacroDescriptor from the rendering module.

Version:

$Id: ec381f211f1ffd43463c88cc6cfba726576d2848 $

Constructor Summary

Constructors

Constructor and Description
MacroDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategory()
ParameterDescriptor	getContentDescriptor()
String	getDescription()
String	getId()
String	getName()
Map<String,ParameterDescriptor>	getParameterDescriptorMap()
boolean	isSupportingInlineMode()
void	setCategory(String category) Sets the macro category.
void	setContentDescriptor(ParameterDescriptor contentDescriptor) Sets the content descriptor.
void	setDescription(String description) Sets the macro description.
void	setId(String id) Sets the identifier of the macro.
void	setName(String name) Sets the human-readable name of the macro (e.g.
void	setParameterDescriptorMap(Map<String,ParameterDescriptor> parameterDescriptorMap) Sets the Map of parameter descriptors.
void	setSupportingInlineMode(boolean supportingInlineMode) Sets the flag which indicates if this macro supports in-line mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroDescriptor

public MacroDescriptor()

Method Detail

getId

public String getId()

Returns:

the macro identifier

setId

public void setId(String id)

Sets the identifier of the macro.

Parameters:

id - a macro identifier

getName

public String getName()

Returns:

the human-readable name of the macro (e.g. Table of Contents for ToC macro)

setName

public void setName(String name)

Sets the human-readable name of the macro (e.g. Table of Contents for ToC macro).

Parameters:

name - the macro name

getDescription

public String getDescription()

Returns:

the description of the macro

setDescription

public void setDescription(String description)

Sets the macro description.

Parameters:

description - a String representing the macro description

getCategory

public String getCategory()

Returns:

the category of the macro

setCategory

public void setCategory(String category)

Sets the macro category.

Parameters:

category - the macro category

getParameterDescriptorMap

public Map<String,ParameterDescriptor> getParameterDescriptorMap()

Returns:

a Map with parameter descriptors

setParameterDescriptorMap

public void setParameterDescriptorMap(Map<String,ParameterDescriptor> parameterDescriptorMap)

Sets the Map of parameter descriptors.

Parameters:

parameterDescriptorMap - a Map of parameter descriptors

getContentDescriptor

public ParameterDescriptor getContentDescriptor()

Returns:

the content descriptor

setContentDescriptor

public void setContentDescriptor(ParameterDescriptor contentDescriptor)

Sets the content descriptor.

Parameters:

contentDescriptor - the object describing the content of the macro

isSupportingInlineMode

public boolean isSupportingInlineMode()

Returns:

true if this macro supports in-line mode, false otherwise

setSupportingInlineMode

public void setSupportingInlineMode(boolean supportingInlineMode)

Sets the flag which indicates if this macro supports in-line mode.

Parameters:

supportingInlineMode - true if this macro is allowed in-line, false otherwise