Class HideRule
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.HideRule
- All Implemented Interfaces:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ExpressionThe expression for the visibility rule.protected StringThe comparison operator.static final StringName of the format member.static final StringName of this structure within the meta-data dictionary.static final StringName of the property that gives the expression for the format member. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the expression of the rule.Returns the format as an internal choice name.protected ObjectgetIntrinsicProperty(String propName) Returns the value of a structure property represented as a member variable.Returns the name of the structure definition.handle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.voidsetExpression(String expression) Sets the expression for this visibility rule.voidSets the output format.protected voidsetIntrinsicProperty(String propName, Object value) Sets the value of of a structure property represented as a member variable.validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validates this structure.Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, 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
-
Field Details
-
FORMAT_MEMBER
Name of the format member.- See Also:
-
VALUE_EXPR_MEMBER
Name of the property that gives the expression for the format member.- See Also:
-
STRUCTURE_NAME
Name of this structure within the meta-data dictionary.- See Also:
-
format
The comparison operator. The default value isFORMAT_TYPE_ALL. The allowed choices are:FORMAT_TYPE_ALLFORMAT_TYPE_VIEWERFORMAT_TYPE_EMAILFORMAT_TYPE_PRINTFORMAT_TYPE_PDFFORMAT_TYPE_RTFFORMAT_TYPE_REPORTLETFORMAT_TYPE_EXCELFORMAT_TYPE_WORDFORMAT_TYPE_POWERPOINT
-
expression
The expression for the visibility rule.
-
-
Constructor Details
-
HideRule
public HideRule()The default Constructor. -
HideRule
Constructs the hide structure with the format choice and expression.- Parameters:
format- the choice name for the formatexpression- the expression for the visibility rule
-
-
Method Details
-
getStructName
Description copied from interface:IStructureReturns 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
Description copied from class:org.eclipse.birt.report.model.core.StructureSets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
propName- the name of the property to setvalue- the property value
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
propName- name of the property- Returns:
- the value of the property, or null if the property is not set
-
getFormat
Returns the format as an internal choice name. The possible choices are defined inDesignChoiceConstantsand they are:FORMAT_TYPE_ALLFORMAT_TYPE_VIEWERFORMAT_TYPE_EMAILFORMAT_TYPE_PRINTFORMAT_TYPE_PDFFORMAT_TYPE_RTFFORMAT_TYPE_REPORTLETFORMAT_TYPE_EXCELFORMAT_TYPE_WORDFORMAT_TYPE_POWERPOINT
- Returns:
- the choice code for the format
-
setFormat
Sets the output format. The allowed choices are defined inDesignChoiceConstantsand they are:FORMAT_TYPE_ALLFORMAT_TYPE_VIEWERFORMAT_TYPE_EMAILFORMAT_TYPE_PRINTFORMAT_TYPE_PDFFORMAT_TYPE_RTFFORMAT_TYPE_REPORTLETFORMAT_TYPE_EXCELFORMAT_TYPE_WORDFORMAT_TYPE_POWERPOINT
- Parameters:
format- the output format to set
-
getExpression
Returns the expression of the rule.- Returns:
- the value expression
-
setExpression
Sets the expression for this visibility rule.- Parameters:
expression- the value expression to set
-
handle
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Specified by:
handlein classorg.eclipse.birt.report.model.core.Structure- Parameters:
valueHandle- the value handle of this structure list property this structure is inindex- the position of this structure in structure list- Returns:
- the handle of this structure.
-
validate
public List<SemanticException> validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validates this structure. The following are the rules:- The column name is required.
- Overrides:
validatein classorg.eclipse.birt.report.model.core.Structure- Parameters:
module- the moduleelement- the element contains this structure- Returns:
- the semantic error list
- See Also:
-
Structure.validate(Module, org.eclipse.birt.report.model.core.DesignElement)
-