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

java.lang.Object
  extended byorg.eclipse.birt.report.model.core.Structure
      extended byorg.eclipse.birt.report.model.api.elements.structures.PropertyMask
All Implemented Interfaces:
java.lang.Cloneable, org.eclipse.birt.report.model.core.IPropertySet, IStructure

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)
          Returns the value of a structure property represented as a member variable.
 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)
          Creates the specific handle of this structure.
protected  void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
          Sets the value of of a structure property represented as a member variable.
 void setMask(java.lang.String mask)
          Sets the property mask.
 void setName(java.lang.String name)
          Sets the property name.
 java.util.List 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
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getLocalProperty, getLocalProperty, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, setProperty, 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)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.

Parameters:
propName - name of the property
Returns:
the value of the property, or null if the property is not set

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.

Parameters:
propName - the name of the property to set
value - the property value

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:

Returns:
the mask of the property

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.

Parameters:
valueHandle - the value handle of this structure list property this structure is in
index - the position of this structure in structure list
Returns:
the handle of this 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:

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 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 of PropertyValueException.

Parameters:
module - the module
element - the element contains this structure
Returns:
the semantic error list


Copyright © 2005 Actuate Corp. All rights reserved.