public abstract class DescribedFunctionProvider extends FunctionProvider implements Descriptor
Function objects, and also contains functionality to add
gui information to the provider itself.| Modifier and Type | Field and Description |
|---|---|
protected LocalizedString |
description
Descriptions per locale
|
protected LocalizedString |
guiName
(GUI) names per locale
|
protected String |
name
Name or key of the provider.
|
functions, getFunctions| Modifier | Constructor and Description |
|---|---|
protected |
DescribedFunctionProvider() |
protected |
DescribedFunctionProvider(String name)
Create a described function provider
|
| Modifier and Type | Method and Description |
|---|---|
protected Locale |
getDefaultLocale()
The locale which must be used if no locale is specified.
|
String |
getDescription()
Returns the description of this object for the default locale.
|
String |
getDescription(Locale locale)
Returns the description of this object.
|
String |
getGUIName()
Retrieve the GUI name of the field.
|
String |
getGUIName(Locale locale)
Retrieve the GUI name of the field depending on specified langauge.
|
LocalizedString |
getLocalizedDescription()
Returns the set of (localized) descriptions of this object.
|
LocalizedString |
getLocalizedGUIName()
Returns the set of (localized) gui names of this object.
|
String |
getName()
Returns the name or 'key' of this descriptor.
|
void |
setDescription(String desc)
Sets the description of this object for the default locale.
|
void |
setDescription(String desc,
Locale locale)
Sets the description of this object.
|
void |
setGUIName(String g)
Sets the GUI name of this object for the default locale.
|
void |
setGUIName(String g,
Locale locale)
Sets the GUI name of this object.
|
protected void |
setLocalizedDescription(LocalizedString description) |
protected void |
setLocalizedGUIName(LocalizedString value) |
void |
setName(String n)
Deprecated.
|
addFunction, createParameters, getFunction, getFunctions, getFunctionValue, newFunctionInstanceprotected String name
protected LocalizedString description
protected LocalizedString guiName
protected DescribedFunctionProvider()
protected DescribedFunctionProvider(String name)
name - the name of the function providerpublic String getName()
getName in interface Descriptorpublic final void setName(String n)
protected Locale getDefaultLocale()
null.
This method can be overriden if another more logical default is
available. E.g. in BasicField the locale of the current cloud is returned.public String getDescription(Locale locale)
DescriptorgetDescription in interface Descriptorlocale - The locale for which this must be returned, or null for a default locale.
If no fitting description for the given locale is available, getName() can be returned.public String getDescription()
DescriptorgetDescription in interface Descriptorpublic LocalizedString getLocalizedDescription()
DescriptorgetLocalizedDescription in interface Descriptorprotected void setLocalizedDescription(LocalizedString description)
public void setDescription(String desc, Locale locale)
DescriptorsetDescription in interface Descriptordesc - the description as a Stringlocale - The locale for which this is valid, or null for a default locale.public void setDescription(String desc)
DescriptorsetDescription in interface Descriptordesc - the description as a Stringpublic String getGUIName(Locale locale)
getGUIName in interface Descriptorlocale - the locale that determines the language for the GUI namepublic String getGUIName()
getGUIName in interface Descriptorpublic void setGUIName(String g, Locale locale)
DescriptorsetGUIName in interface Descriptorg - the description as a Stringlocale - The locale for which this is valid, or null for the default locale.public void setGUIName(String g)
DescriptorsetGUIName in interface Descriptorg - the description as a Stringpublic LocalizedString getLocalizedGUIName()
DescriptorgetLocalizedGUIName in interface Descriptorprotected void setLocalizedGUIName(LocalizedString value)
MMBase 1.9-SNAPSHOT - ${javadoctimestamp}