Class PropertyMaskHandle


public class PropertyMaskHandle extends StructureHandle
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.
  • Constructor Details

    • PropertyMaskHandle

      public PropertyMaskHandle(SimpleValueHandle valueHandle, int index)
      Constructs the handle of property mask.
      Parameters:
      valueHandle - the value handle for property mask list of one property
      index - the position of this property mask in the list
  • Method Details

    • getMask

      public String 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

      public void setMask(String mask) throws SemanticException
      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

      public String getName()
      Returns the property name.
      Returns:
      the property name
    • setName

      public void setName(String name) throws SemanticException
      Sets the property name.
      Parameters:
      name - the property name to set
      Throws:
      SemanticException - value required exception