Package net.sf.jasperreports.properties
Class StandardPropertyMetadata
java.lang.Object
net.sf.jasperreports.properties.StandardPropertyMetadata
- All Implemented Interfaces:
PropertyMetadata
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddScope(net.sf.jasperreports.annotations.properties.PropertyScope scope) voidaddScopeQualification(String scopeQualification) The name of the class where the property constant is declared.The name of the property constant declaration (static) field.The default value of the property.Short description of the property.getLabel()Short label for the property.getName()The property name.The list of conditions under which the property is used (for instance using a specific query executer).List<net.sf.jasperreports.annotations.properties.PropertyScope> The list of scopes at which the property can be set.The version in which the property was introduced.The type (as class name) of values that the property expects.booleanvoidsetCategory(String category) voidsetConstantDeclarationClass(String constantDeclarationClass) voidsetConstantFieldName(String constantFieldName) voidsetDefaultValue(String defaultValue) voidsetDeprecated(boolean deprecated) voidsetDescription(String description) voidvoidvoidsetScopeQualifications(List<String> scopeQualifications) voidvoidsetSinceVersion(String sinceVersion) voidsetValueType(String valueType)
-
Constructor Details
-
StandardPropertyMetadata
public StandardPropertyMetadata()
-
-
Method Details
-
getLabel
Description copied from interface:PropertyMetadataShort label for the property.- Specified by:
getLabelin interfacePropertyMetadata- Returns:
- short property label
-
setLabel
-
getDescription
Description copied from interface:PropertyMetadataShort description of the property.- Specified by:
getDescriptionin interfacePropertyMetadata- Returns:
- short property description
-
setDescription
-
getDefaultValue
Description copied from interface:PropertyMetadataThe default value of the property.- Specified by:
getDefaultValuein interfacePropertyMetadata- Returns:
- the default property value
-
setDefaultValue
-
getScopes
Description copied from interface:PropertyMetadataThe list of scopes at which the property can be set.- Specified by:
getScopesin interfacePropertyMetadata- Returns:
- the list of scopes at which the property can be set
-
setScopes
-
addScope
public void addScope(net.sf.jasperreports.annotations.properties.PropertyScope scope) -
getSinceVersion
Description copied from interface:PropertyMetadataThe version in which the property was introduced.- Specified by:
getSinceVersionin interfacePropertyMetadata- Returns:
- the version in which the property was introduced
-
setSinceVersion
-
getValueType
Description copied from interface:PropertyMetadataThe type (as class name) of values that the property expects.- Specified by:
getValueTypein interfacePropertyMetadata- Returns:
- the type of values that the property expects
-
setValueType
-
getName
Description copied from interface:PropertyMetadataThe property name.- Specified by:
getNamein interfacePropertyMetadata- Returns:
- the property name
-
setName
-
getConstantDeclarationClass
Description copied from interface:PropertyMetadataThe name of the class where the property constant is declared.- Specified by:
getConstantDeclarationClassin interfacePropertyMetadata- Returns:
- the class name that contains the property constant declaration
-
setConstantDeclarationClass
-
getConstantFieldName
Description copied from interface:PropertyMetadataThe name of the property constant declaration (static) field.- Specified by:
getConstantFieldNamein interfacePropertyMetadata- Returns:
- the name of the property constant declaration field
- See Also:
-
setConstantFieldName
-
getScopeQualifications
Description copied from interface:PropertyMetadataThe list of conditions under which the property is used (for instance using a specific query executer).- Specified by:
getScopeQualificationsin interfacePropertyMetadata- Returns:
- the list of conditions under which the property is used
-
setScopeQualifications
-
addScopeQualification
-
getCategory
- Specified by:
getCategoryin interfacePropertyMetadata
-
setCategory
-
isDeprecated
public boolean isDeprecated()- Specified by:
isDeprecatedin interfacePropertyMetadata
-
setDeprecated
public void setDeprecated(boolean deprecated)
-