Class PropertyMaskHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.PropertyMaskHandle
Represents the handle of property mask structure. The property mask defines
whether this property can be accessed or modified. It includes property name
and mask value.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
Constructor Summary
ConstructorsConstructorDescriptionPropertyMaskHandle
(SimpleValueHandle valueHandle, int index) Constructs the handle of property mask. -
Method Summary
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
PropertyMaskHandle
Constructs the handle of property mask.- Parameters:
valueHandle
- the value handle for property mask list of one propertyindex
- the position of this property mask in the list
-
-
Method Details
-
getMask
Returns the property mask. 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 property mask
-
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 mask to set- Throws:
SemanticException
- if the mask is not in the choice list.
-
getName
Returns the property name.- Returns:
- the property name
-
setName
Sets the property name.- Parameters:
name
- the property name to set- Throws:
SemanticException
- value required exception
-