Interface IStructure
-
- All Superinterfaces:
java.lang.Cloneable,org.eclipse.birt.report.model.core.IPropertySet
- All Known Implementing Classes:
Action,AggregationArgument,CachedMetaData,CalculationArgument,ColumnHint,ComputedColumn,ConfigVariable,CustomColor,DataSetParameter,DateFormatValue,DateTimeFormatValue,DimensionCondition,DimensionJoinCondition,EmbeddedImage,ExtendedProperty,FilterCondition,FormatValue,HideRule,HighlightRule,IncludedCssStyleSheet,IncludedLibrary,IncludeScript,JoinCondition,LevelAttribute,MapRule,NumberFormatValue,OdaDataSetParameter,OdaDesignerState,OdaLevelAttribute,OdaResultSetColumn,ParamBinding,ParameterFormatValue,PropertyBinding,PropertyMask,org.eclipse.birt.report.model.core.PropertyStructure,org.eclipse.birt.report.model.core.ReferencableStructure,ResultSetColumn,Rule,ScriptLib,SearchKey,SelectionChoice,SortHint,SortKey,StringFormatValue,org.eclipse.birt.report.model.core.Structure,StyleRule,TimeFormatValue,TimeInterval,TOC,UserPropertyDefn
public interface IStructure extends org.eclipse.birt.report.model.core.IPropertySetInterface for objects that appear in a property list. Provides methods for generically accessing or updating object members, and provides a meta-data definition for the object. This interface allows an object to participate in the generic property type, command and related mechanisms.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description IStructurecopy()Creates a deep copy of this structure.IStructureDefngetDefn()Returns the structure definition from the meta-data dictionary.java.lang.ObjectgetLocalProperty(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.metadata.PropertyDefn propDefn)Deprecated.java.lang.ObjectgetProperty(org.eclipse.birt.report.model.core.Module module, java.lang.String propName)Gets the locale value of a property.java.lang.StringgetStructName()Returns the name of the structure definition.booleanisDesignTime()Justifies whether the structure is generated in design time or not.booleanisReferencable()Justifies whether the structure can be referred by other design elements.
-
-
-
Method Detail
-
getStructName
java.lang.String getStructName()
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.
-
copy
IStructure copy()
Creates a deep copy of this structure.- Returns:
- a copy of this structure.
-
getDefn
IStructureDefn getDefn()
Returns the structure definition from the meta-data dictionary.- Returns:
- the structure definition
-
getLocalProperty
@Deprecated java.lang.Object getLocalProperty(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.metadata.PropertyDefn propDefn)Deprecated.Gets the locale value of a property.- Parameters:
module- the modulepropDefn- definition of the property to get- Returns:
- value of the item as an object, or null if the item is not set locally or is not found.
-
getProperty
java.lang.Object getProperty(org.eclipse.birt.report.model.core.Module module, java.lang.String propName)Gets the locale value of a property.- Parameters:
module- the modulepropName- the name of the property definition- Returns:
- value of the item as an object, or null if the item is not set locally or is not found.
-
isReferencable
boolean isReferencable()
Justifies whether the structure can be referred by other design elements.- Returns:
- true if the structure is referencable, otherwise false
-
isDesignTime
boolean isDesignTime()
Justifies whether the structure is generated in design time or not.- Returns:
if the structure is generated in design time, otherwise return .
-
-