org.xwiki.rendering.macro.descriptor

Class DefaultParameterDescriptor

java.lang.Object

org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor

All Implemented Interfaces:

ParameterDescriptor

public class DefaultParameterDescriptor
extends Object
implements ParameterDescriptor

The default implementation of ParameterDescriptor.

Since:

1.7M2

Version:

$Id: 8e46d41abc9c2985a93070515d98978c4ec514d5 $

Field Summary

Fields

Modifier and Type	Field and Description
static Type	DEFAULT_PARAMETER_TYPE Default content type of all content descriptors.

Constructor Summary

Constructors

Constructor and Description
DefaultParameterDescriptor(org.xwiki.properties.PropertyDescriptor propertyDescriptor) Creates a new DefaultParameterDescriptor instance using the given PropertyDescriptor.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue()
String	getDescription()
Type	getDisplayType()
org.xwiki.properties.PropertyGroupDescriptor	getGroupDescriptor()
String	getId()
String	getName()
Type	getParameterType()
Class<?>	getType() Deprecated.
boolean	isAdvanced()
boolean	isDeprecated()
boolean	isDisplayHidden()
boolean	isMandatory()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARAMETER_TYPE

public static final Type DEFAULT_PARAMETER_TYPE

Default content type of all content descriptors.

Since:

11.1RC1

Constructor Detail

DefaultParameterDescriptor

public DefaultParameterDescriptor(org.xwiki.properties.PropertyDescriptor propertyDescriptor)

Creates a new DefaultParameterDescriptor instance using the given PropertyDescriptor.

Parameters:

propertyDescriptor - The PropertyDescriptor instance.

Method Detail

getId

public String getId()

Specified by:

getId in interface ParameterDescriptor

Returns:

the identifier of the parameter.

getName

public String getName()

Specified by:

getName in interface ParameterDescriptor

Returns:

the display name of the parameter.

getDescription

public String getDescription()

Specified by:

getDescription in interface ParameterDescriptor

Returns:

the description of the parameter.

getType

@Deprecated
public Class<?> getType()

Deprecated.

Specified by:

getType in interface ParameterDescriptor

Returns:

the type of the parameter.

getParameterType

public Type getParameterType()

Specified by:

getParameterType in interface ParameterDescriptor

Returns:

the type of the property.

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface ParameterDescriptor

Returns:

the default value of the parameter.

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface ParameterDescriptor

Returns:

indicate if the parameter is mandatory.

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface ParameterDescriptor

Returns:

indicate if the parameter is deprecated.

isAdvanced

public boolean isAdvanced()

Specified by:

isAdvanced in interface ParameterDescriptor

Returns:

indicate if the parameter is advanced.

getGroupDescriptor

public org.xwiki.properties.PropertyGroupDescriptor getGroupDescriptor()

Specified by:

getGroupDescriptor in interface ParameterDescriptor

Returns:

a hierarchy of groups and its associated feature.

getDisplayType

public Type getDisplayType()

Specified by:

getDisplayType in interface ParameterDescriptor

Returns:

the type used to display the property.

isDisplayHidden

public boolean isDisplayHidden()

Specified by:

isDisplayHidden in interface ParameterDescriptor

Returns:

whether the parameter should be displayed in UIs or not. For example the WYSIWYG editor uses it to decide whether to display it or not in the Macro editor UI.