Uses of Class
org.eclipse.birt.report.model.api.StructureHandle
-
Packages that use StructureHandle Package Description org.eclipse.birt.report.model.api Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")org.eclipse.birt.report.model.api.elements.structures Defines the structure types in Model system.org.eclipse.birt.report.model.api.util Utility classes. -
-
Uses of StructureHandle in org.eclipse.birt.report.model.api
Subclasses of StructureHandle in org.eclipse.birt.report.model.api Modifier and Type Class Description class
ActionHandle
Represents an "action" (hyperlink) attached to an element.class
AggregationArgumentHandle
AggregationArgumentHandle.class
CachedMetaDataHandle
Structure handle to deal with cached data set metadata informations.class
CalculationArgumentHandle
CalculationArgumentHandle.class
ColumnHintHandle
Represents the handle of column hint.class
ComputedColumnHandle
Represents the handle of computed column.class
ConfigVariableHandle
Represents the handle of configuration variable.class
CustomColorHandle
Represents the handle of custom color.class
DataSetParameterHandle
Represents the parameter for data set drivers.class
DimensionConditionHandle
Represents the handle of the cube-dimension/hierarchy join condition.class
DimensionJoinConditionHandle
Represents a dimension join condition in the DimensionCondition.class
EmbeddedImageHandle
Represents the handle of an embedded image.class
ExtendedPropertyHandle
Represents the handle of Extended property.class
FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.class
FormatValueHandle
Represents a format value in the style or the highlight rule.class
HideRuleHandle
Represents the handle of visibility rule.class
HighlightRuleHandle
Represents a highlight rule in the highlight property of a style.class
IncludedCssStyleSheetHandle
Represents a included css style sheet in report design and theme.class
IncludedLibraryHandle
Represents the handle of the included library.class
IncludeScriptHandle
Represents the handle of the included script.class
JoinConditionHandle
Represents a handle of condition used for joint dataset.class
LevelAttributeHandle
Represents the handle of one column in the result set.class
MapRuleHandle
Represents the handle of map rule.class
OdaDataSetParameterHandle
Represents the parameter for ODA drivers.class
OdaDesignerStateHandle
The structure handle of the Oda designer state.class
OdaLevelAttributeHandle
Represents the handle of one column in the oda result set.class
OdaResultSetColumnHandle
Represents the handle of one column in the oda result set.class
ParamBindingHandle
Represents the handle of parameter binding.class
PropertyBindingHandle
Represents the handle of property binding structure.class
PropertyMaskHandle
Represents the handle of property mask structure.class
ResultSetColumnHandle
Represents the handle of one column in the result set.class
RuleHandle
Represents a rule handle.class
ScriptLibHandle
Represents a handle of jar file used for script handle event.class
SearchKeyHandle
Represents the handle of key used for search.class
SelectionChoiceHandle
Represents the handle of selection choice.class
SortHintHandle
This class represents sort hint handle.class
SortKeyHandle
Represents the handle of sort key structure.class
StyleRuleHandle
Represents the handle of style rule.class
TimeIntervalHandle
The structure handle of time interval.class
TOCHandle
Represents an "TOC" attached to an element.Obtain an instance of this class by calling thegetTOCHandle
method on the handle of an element that defines an action.Fields in org.eclipse.birt.report.model.api declared as StructureHandle Modifier and Type Field Description protected StructureHandle
MemberIterator. structHandle
Handle to the structure itself.Methods in org.eclipse.birt.report.model.api that return StructureHandle Modifier and Type Method Description StructureHandle
SimpleValueHandle. addItem(IStructure item)
Adds an item to the end of a list property or member.StructureHandle
SimpleValueHandle. getAt(int n)
Returns the the nth entry in a list property or member.StructureHandle
SimpleValueHandle. insertItem(IStructure item, int posn)
Inserts a new item into a list property or member at the given position.Constructors in org.eclipse.birt.report.model.api with parameters of type StructureHandle Constructor Description MemberHandle(StructureHandle structHandle, org.eclipse.birt.report.model.metadata.StructPropertyDefn member)
Constructs a member handle with the given structure handle and the member property definition.MemberIterator(StructureHandle struct)
Constructs a member iterator with the given structure handle. -
Uses of StructureHandle in org.eclipse.birt.report.model.api.elements.structures
Methods in org.eclipse.birt.report.model.api.elements.structures that return StructureHandle Modifier and Type Method Description StructureHandle
Action. getHandle(SimpleValueHandle valueHandle)
StructureHandle
CachedMetaData. getHandle(SimpleValueHandle valueHandle)
StructureHandle
DateFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the date-time format.StructureHandle
DateTimeFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the date-time format.StructureHandle
FormatValue. getHandle(SimpleValueHandle valueHandle)
StructureHandle
NumberFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the number format.StructureHandle
OdaDesignerState. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the string format.StructureHandle
ParameterFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the parameter format.StructureHandle
StringFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the string format.StructureHandle
TimeFormatValue. getHandle(SimpleValueHandle valueHandle)
Return anFormatValueHandle
to deal with the date-time format.StructureHandle
TimeInterval. getHandle(SimpleValueHandle valueHandle)
StructureHandle
TOC. getHandle(SimpleValueHandle valueHandle)
protected StructureHandle
Action. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
AggregationArgument. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
CachedMetaData. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
CalculationArgument. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ColumnHint. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ComputedColumn. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ConfigVariable. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
CustomColor. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
DataSetParameter. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
DateFormatValue. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
DateTimeFormatValue. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
DimensionCondition. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
DimensionJoinCondition. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
EmbeddedImage. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ExtendedProperty. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
FilterCondition. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
FormatValue. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
HideRule. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
HighlightRule. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
IncludedCssStyleSheet. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
IncludedLibrary. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
IncludeScript. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
JoinCondition. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
LevelAttribute. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
MapRule. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
NumberFormatValue. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
OdaDataSetParameter. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
OdaDesignerState. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
OdaLevelAttribute. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
OdaResultSetColumn. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ParamBinding. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ParameterFormatValue. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
PropertyBinding. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
PropertyMask. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ResultSetColumn. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
Rule. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
ScriptLib. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
SearchKey. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
SelectionChoice. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
SortHint. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
SortKey. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
StringFormatValue. handle(SimpleValueHandle valueHandle, int index)
StructureHandle
TimeFormatValue. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
TimeInterval. handle(SimpleValueHandle valueHandle, int index)
protected StructureHandle
TOC. handle(SimpleValueHandle valueHandle, int index)
-
Uses of StructureHandle in org.eclipse.birt.report.model.api.util
Methods in org.eclipse.birt.report.model.api.util with parameters of type StructureHandle Modifier and Type Method Description static boolean
ElementExportUtilImpl. canExport(StructureHandle structToExport)
Checks whether the given structure can be exported into one library.static boolean
ElementExportUtilImpl. canExport(StructureHandle structToExport, boolean ignoreName)
Checks whether the given structure can be exported into one library.static boolean
ElementExportUtilImpl. canExport(StructureHandle structToExport, LibraryHandle targetLibraryHandle, boolean canOverride)
Checks whether the given structure can be exported into one library.static void
ElementExportUtilImpl. exportStructure(StructureHandle structToExport, java.lang.String libraryFileName, boolean canOverride)
Exports the given structure into one library.static void
ElementExportUtilImpl. exportStructure(StructureHandle structToExport, LibraryHandle targetLibraryHandle, boolean canOverride)
Exports the given structure into one library.
-