Class PropertyMask
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.PropertyMask
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class PropertyMask
extends org.eclipse.birt.report.model.core.Structure
This class provides property masks of system or user defined properties. Name
and Value members in
PropertyMask
are all intrinsic properties.
Choices for the mask value are defined in DesignChoiceConstants
.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
The value of the mask.static final String
Name of the value for the mask.protected String
The name of the property.static final String
Name of the property name member.static final String
Name of this structure within the meta-data dictionary. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
getIntrinsicProperty
(String propName) Returns the value of a structure property represented as a member variable.getMask()
Returns the mask of the property.getName()
Returns the property name.Returns the name of the structure definition.handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.void
Sets the property mask.void
Sets the property name.validate
(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validate whether this structure is valid.Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
NAME_MEMBER
Name of the property name member.- See Also:
-
MASK_MEMBER
Name of the value for the mask.- See Also:
-
STRUCTURE_NAME
Name of this structure within the meta-data dictionary.- See Also:
-
name
The name of the property. -
mask
The value of the mask. The default value is "hide".
-
-
Constructor Details
-
PropertyMask
public PropertyMask()Constructs a PropertyMask.
-
-
Method Details
-
getStructName
Description copied from interface:IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
getName
Returns the property name.- Returns:
- the property name
-
getMask
Returns the mask of the property. The possible values are defined in {org.eclipse.birt.report.model.elements.DesignChoiceConstants}, and they are:- PROPERTY_MASK_TYPE_CHANGE
- PROPERTY_MASK_TYPE_LOCK
- PROPERTY_MASK_TYPE_HIDE
- Returns:
- the mask of the property
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
valueHandle
- the value handle of this structure list property this structure is inindex
- the position of this structure in structure list- Returns:
- the handle of this structure.
-
setMask
Sets the property mask. The allowed values are defined in {org.eclipse.birt.report.model.elements.DesignChoiceConstants}, and they are:- PROPERTY_MASK_TYPE_CHANGE
- PROPERTY_MASK_TYPE_LOCK
- PROPERTY_MASK_TYPE_HIDE
- Parameters:
mask
- the proeprty mask to set
-
setName
Sets the property name.- Parameters:
name
- the property name to set
-
validate
public List<SemanticException> validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Description copied from class:org.eclipse.birt.report.model.core.Structure
Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance ofPropertyValueException
.- Overrides:
validate
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
module
- the moduleelement
- the element contains this structure- Returns:
- the semantic error list
-