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

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

public class HideRule
extends org.eclipse.birt.report.model.core.Structure

Implements hide rules of a ReportItem.

Member properties in Hide are all intrinsic properties. That is, values of "format" and "valueExpr" properties can be unset. Choices for the "format" member are defined in DesignChoiceConstants.

See Also:
DesignChoiceConstants

Field Summary
protected  java.lang.String expression
          The expression for the visibility rule.
protected  java.lang.String format
          The comparison operator.
static java.lang.String FORMAT_MEMBER
          Name of the format member.
static java.lang.String STRUCTURE_NAME
          Name of this structure within the meta-data dictionary.
static java.lang.String VALUE_EXPR_MEMBER
          Name of the property that gives the expression for the format member.
 
Constructor Summary
HideRule()
          The default Constructor.
HideRule(java.lang.String format, java.lang.String expression)
          Constructs the hide structure with the format choice and expression.
 
Method Summary
 java.lang.String getExpression()
          Returns the expression of the rule.
 java.lang.String getFormat()
          Returns the format as an internal choice name.
protected  java.lang.Object getIntrinsicProperty(java.lang.String propName)
           
 java.lang.String getStructName()
          Returns the name of the structure definition.
 StructureHandle handle(SimpleValueHandle valueHandle, int index)
           
 void setExpression(java.lang.String expression)
          Sets the expression for this visibility rule.
 void setFormat(java.lang.String format)
          Sets the output format.
protected  void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
           
 
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, validate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FORMAT_MEMBER

public static final java.lang.String FORMAT_MEMBER
Name of the format member.

See Also:
Constant Field Values

VALUE_EXPR_MEMBER

public static final java.lang.String VALUE_EXPR_MEMBER
Name of the property that gives the expression for the format member.

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

format

protected java.lang.String format
The comparison operator. The default value is FORMAT_TYPE_ALL. The allowed choices are:


expression

protected java.lang.String expression
The expression for the visibility rule.

Constructor Detail

HideRule

public HideRule()
The default Constructor.


HideRule

public HideRule(java.lang.String format,
                java.lang.String expression)
Constructs the hide structure with the format choice and expression.

Parameters:
format - the choice name for the format
expression - the expression for the visibility rule
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.

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Specified by:
setIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure

getIntrinsicProperty

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
Specified by:
getIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure

getFormat

public java.lang.String getFormat()
Returns the format as an internal choice name. The possible choices are defined in DesignChoiceConstants and they are: Or can be user defined format.

Returns:
the choice code for the format

setFormat

public void setFormat(java.lang.String format)
Sets the output format. The allowed choices are defined in DesignChoiceConstantsand they are: Or can be user defined format.

Parameters:
format - the output format to set

getExpression

public java.lang.String getExpression()
Returns the expression of the rule.

Returns:
the value expression

setExpression

public void setExpression(java.lang.String expression)
Sets the expression for this visibility rule.

Parameters:
expression - the value expression to set

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Specified by:
handle in class org.eclipse.birt.report.model.core.Structure


Copyright © 2008 Actuate Corp. All rights reserved.