org.hippoecm.hst.configuration.components
Annotation Type Parameter

Deprecated. Since HST version 2.23.02 replaced by Parameter

@Retention(value=RUNTIME)
@Target(value=METHOD)
@Deprecated
public @interface Parameter

Annotation indicating that a getter method returns the value of an HST component parameter.

See Also:

ParametersInfo}

Required Element Summary

String

name Deprecated.

Optional Element Summary

boolean	allowCreation Deprecated. see DocumentLink
Class<? extends PropertyEditor>	customEditor Deprecated. This is still experimental.
String	defaultValue Deprecated.
String	description Deprecated.
String	displayName Deprecated.
String	docLocation Deprecated. see DocumentLink
String	docType Deprecated. see DocumentLink
boolean	required Deprecated.
String	typeHint Deprecated. use the method return type for the storage type, add additional annotations like DocumentLink or Color for more detailed information

Element Detail

name

public abstract String name

Deprecated.

Returns:

the name of the parameter used, also see HstComponentConfiguration.getParameter(String) . This element is mandatory.

required

public abstract boolean required

Deprecated.

Returns:

true if this is a required parameter for the HstComponent to work

Default:

false

defaultValue

public abstract String defaultValue

Deprecated.

Returns:

the default value of this parameter when it is not present in the backing HstComponentConfiguration.getParameters(). If there is no defaultValue defined, it is an empty String ""

Default:

""

displayName

public abstract String displayName

Deprecated.

Returns:

the displayName of this parameter. This can be the 'pretty' name for name(). If missing, implementations can do a fallback to name()

Default:

""

description

public abstract String description

Deprecated.

Returns:

the description for this Parameter

Default:

""

customEditor

public abstract Class<? extends PropertyEditor> customEditor

Deprecated.

This is still experimental.

Returns:

a PropertyEditor

Default:

org.hippoecm.hst.configuration.components.EmptyPropertyEditor.class

typeHint

public abstract String typeHint

Deprecated. use the method return type for the storage type, add additional annotations like DocumentLink or Color for more detailed information

a String used to provide optional YUI tools with a hint about the type the parameter value should be of. For example 'COLOR', 'DATE', 'DOCUMENT'. Note that this is a typeHint for for example the template composer. Thus it does influence the actual return type of the getter method that is used for the Parameter annotation.

Default:

""

docType

public abstract String docType

Deprecated. see DocumentLink

Specifies the node type of the document to be searched for.

Returns:

the document type String

Default:

""

allowCreation

public abstract boolean allowCreation

Deprecated. see DocumentLink

Returns:

specifies whether to show a link to create a new document of the type as specified by the docType

Default:

false

docLocation

public abstract String docLocation

Deprecated. see DocumentLink

Returns:

the relative path of the folder where the document is created

Default:

""