Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.elements.structures
Class PropertyMask

    java.lang.Object
      org.eclipse.birt.report.model.core.Structure
          org.eclipse.birt.report.model.api.elements.structures.PropertyMask

All Implemented Interfaces:
  java.lang.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:
  `DesignChoiceConstants`

Field Summary
`protected java.lang.String` | `mask` The value of the mask.
`static java.lang.String` | `MASK_MEMBER` Name of the value for the mask.
`protected java.lang.String` | `name` The name of the property.
`static java.lang.String` | `NAME_MEMBER` Name of the property name member.
`static java.lang.String` | `STRUCTURE_NAME` Name of this structure within the meta-data dictionary.

Constructor Summary
`PropertyMask()` Constructs a PropertyMask.

Method Summary
`protected java.lang.Object` | `getIntrinsicProperty(java.lang.String propName)`
`java.lang.String` | `getMask()` Returns the mask of the property.
`java.lang.String` | `getName()` Returns the property name.
`java.lang.String` | `getStructName()` Returns the name of the structure definition.
`StructureHandle` | `handle(SimpleValueHandle valueHandle, int index)`
`protected void` | `setIntrinsicProperty(java.lang.String propName, java.lang.Object value)`
`void` | `setMask(java.lang.String mask)` Sets the property mask.
`void` | `setName(java.lang.String name)` Sets the property name.
`java.util.List<SemanticException>` | `validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)`

Methods inherited from class org.eclipse.birt.report.model.core.Structure
`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`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### NAME_MEMBER

    public static final java.lang.String NAME_MEMBER

  Name of the property name member.

  See Also:
    Constant Field Values

### MASK_MEMBER

    public static final java.lang.String MASK_MEMBER

  Name of the value for the mask.

  See Also:
    Constant Field Values

### STRUCTURE_NAME

    public static final java.lang.String STRUCTURE_NAME

  Name of this structure within the meta-data dictionary.

  See Also:
    Constant Field Values

### name

    protected java.lang.String name

  The name of the property.

### mask

    protected java.lang.String mask

  The value of the mask. The default value is "hide".

Constructor Detail

### PropertyMask

    public PropertyMask()

  Constructs a PropertyMask.

Method Detail

### getStructName

    public java.lang.String 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

    protected java.lang.Object getIntrinsicProperty(java.lang.String propName)

  Specified by:
    `getIntrinsicProperty` in class `org.eclipse.birt.report.model.core.Structure`

### setIntrinsicProperty

    protected void setIntrinsicProperty(java.lang.String propName,
                                        java.lang.Object value)

  Specified by:
    `setIntrinsicProperty` in class `org.eclipse.birt.report.model.core.Structure`

### getName

    public java.lang.String getName()

  Returns the property name.

  Returns:
    the property name

### getMask

    public java.lang.String 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

    public StructureHandle handle(SimpleValueHandle valueHandle,
                                  int index)

  Specified by:
    `handle` in class `org.eclipse.birt.report.model.core.Structure`

### setMask

    public void setMask(java.lang.String mask)

  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

    public void setName(java.lang.String name)

  Sets the property name.

  Parameters:
    `name` - the property name to set

### validate

    public java.util.List<SemanticException> validate(org.eclipse.birt.report.model.core.Module module,
                                                      org.eclipse.birt.report.model.core.DesignElement element)

  Overrides:
    `validate` in class `org.eclipse.birt.report.model.core.Structure`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.