Class HideRuleHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.HideRuleHandle
Represents the handle of visibility rule. The visibility rule says when a
report item should be hidden. It can be hidden based on the output type, an
expression, or both. For example, the browser control is normally hidden in
all output formats except HTML. A past-due item might be hidden if the
account is not past due.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContextFields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle -
Constructor Summary
ConstructorsConstructorDescriptionHideRuleHandle(SimpleValueHandle valueHandle, int index) Constructs the handle of visibility rule. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value expression of this visibility rule.Returns the output format of this visibility rule.voidsetExpression(String expression) Sets the value expression of this visibility rule.voidSets the output format of this visibility rule.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilentlyMethods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReferenceMethods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
HideRuleHandle
Constructs the handle of visibility rule.- Parameters:
valueHandle- the value handle for visibility rule list of one propertyindex- the position of this visibility rule in the list
-
-
Method Details
-
getFormat
Returns the output format of this visibility rule. The default value isFORMAT_TYPE_ALL. 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 output format of this visibility rule
-
setFormat
Sets the output format of this visibility rule. 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- Throws:
SemanticException- if the property is locked.
-
getExpression
Returns the value expression of this visibility rule.- Returns:
- the value expression of this visibility rule
-
setExpression
Sets the value expression of this visibility rule.- Parameters:
expression- the value expression to set
-