Class SearchKey
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.SearchKey
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class SearchKey
extends org.eclipse.birt.report.model.core.Structure
Structure for optional list of search criteria. It is used when we defined
action in some report item, such as label item, image item and so on, and the
action type is drillthrough type. It's provided for drillthrough contents. If
the document supports searching, the link can include search criteria. Each
search key has the following properties:
- Expression
- an expression of the search key for the drillthrough.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Expression
Value of the expression property.static final String
Name of the expression property.static final String
Name of the structure. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns expression value this key.protected Object
getIntrinsicProperty
(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.void
setExpression
(String expression) Sets the expression value of this key.protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.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, validate
-
Field Details
-
SEARCHKEY_STRUCT
Name of the structure.- See Also:
-
EXPRESSION_MEMBER
Name of the expression property.- See Also:
-
expression
Value of the expression property.
-
-
Constructor Details
-
SearchKey
public SearchKey()
-
-
Method Details
-
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
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicProperty
in 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
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
setExpression
Sets the expression value of this key.- Parameters:
expression
- the expression to set
-
getExpression
Returns expression value this key.- Returns:
- the expression value
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in 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.
-