public class ColumnHint
extends org.eclipse.birt.report.model.core.PropertyStructure
This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each column hint has the following properties:
ANALYSIS_MEMBER
property is set to
ANALYSIS_TYPE_DIMENSION
or ANALYSIS_TYPE_DETAIL
.
For ANALYSIS_TYPE_DIMENSION
, this property establishes the
dimension hierarchy.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACL_EXPRESSION_MEMBER
Name of the member that defines expression to calculate ACL for the data
set column.
|
static java.lang.String |
ACTION_MEMBER
Name of the member that defines the action structure of result set column
and computed column.
|
static java.lang.String |
ALIAS_MEMBER
Name of the alias member.
|
static java.lang.String |
ANALYSIS_COLUMN_MEMBER
Name of the member which used to associate a field to the selected field
when the analysisType is attribute.
|
static java.lang.String |
ANALYSIS_MEMBER
Name of the analysis member.
|
static java.lang.String |
COLUMN_HINT_STRUCT
Name of this structure.
|
static java.lang.String |
COLUMN_NAME_MEMBER
Name of the column name member.
|
static java.lang.String |
COMPRESSED_MEMBER
Name of the member that indicates whether the column needs to be compressed.
|
static java.lang.String |
DESCRIPTION_ID_MEMBER
Deprecated.
|
static java.lang.String |
DESCRIPTION_MEMBER
Deprecated.
|
static java.lang.String |
DISPLAY_LENGTH_MEMBER
Deprecated.
|
static java.lang.String |
DISPLAY_NAME_ID_MEMBER
Name of the display name ID member.
|
static java.lang.String |
DISPLAY_NAME_MEMBER
Name of the display name member.
|
static java.lang.String |
EXPORT_MEMBER
Name of the export member.
|
static java.lang.String |
FORMAT_MEMBER
Deprecated.
|
static java.lang.String |
HEADING_ID_MEMBER
Name of the heading id member.
|
static java.lang.String |
HEADING_MEMBER
Name of the heading member.
|
static java.lang.String |
HELP_TEXT_ID_MEMBER
Name of the help text ID member.
|
static java.lang.String |
HELP_TEXT_MEMBER
Name of the help text member.
|
static java.lang.String |
HORIZONTAL_ALIGN_MEMBER
Name of the horizontal alignment member.
|
static java.lang.String |
INDEX_COLUMN_MEMBER
Name of the member that indicates whether the column should be generated with index.
|
static java.lang.String |
ON_COLUMN_LAYOUT_MEMBER
Name of the on column layout member.
|
static java.lang.String |
PARENT_LEVEL_MEMBER
Name of the parent level member.
|
static java.lang.String |
SEARCHING_MEMBER
Name of the searching member.
|
static java.lang.String |
TEXT_FORMAT_MEMBER
Deprecated.
|
static java.lang.String |
VALUE_FORMAT_MEMBER
Name of the member that defines the format of value.
|
static java.lang.String |
WORD_WRAP_MEMBER
Deprecated.
|
Constructor and Description |
---|
ColumnHint() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getStructName()
Returns the name of the structure definition.
|
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
Creates the specific handle of this structure.
|
java.util.List<SemanticException> |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validates this structure.
|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference
public static final java.lang.String COLUMN_HINT_STRUCT
public static final java.lang.String COLUMN_NAME_MEMBER
public static final java.lang.String ALIAS_MEMBER
public static final java.lang.String SEARCHING_MEMBER
public static final java.lang.String EXPORT_MEMBER
public static final java.lang.String ANALYSIS_MEMBER
EXPORT_MEMBER
property above.public static final java.lang.String PARENT_LEVEL_MEMBER
ANALYSIS_MEMBER
property is set to
ANALYSIS_TYPE_DIMENSION
or ANALYSIS_TYPE_DETAIL
. For ANALYSIS_TYPE_DIMENSION
, this property establishes the
dimension hierarchy. Lower (more detailed) dimensions identify their
parent (more general) dimensions. For ANALYSIS_TYPE_DETAIL
,
this property identifies the dimension for which this column is a detail.public static final java.lang.String FORMAT_MEMBER
public static final java.lang.String DISPLAY_NAME_ID_MEMBER
public static final java.lang.String DISPLAY_NAME_MEMBER
public static final java.lang.String HELP_TEXT_ID_MEMBER
public static final java.lang.String HELP_TEXT_MEMBER
public static final java.lang.String ON_COLUMN_LAYOUT_MEMBER
public static final java.lang.String HEADING_MEMBER
public static final java.lang.String HEADING_ID_MEMBER
public static final java.lang.String DISPLAY_LENGTH_MEMBER
public static final java.lang.String HORIZONTAL_ALIGN_MEMBER
public static final java.lang.String WORD_WRAP_MEMBER
public static final java.lang.String TEXT_FORMAT_MEMBER
public static final java.lang.String DESCRIPTION_MEMBER
public static final java.lang.String DESCRIPTION_ID_MEMBER
public static final java.lang.String ACTION_MEMBER
public static final java.lang.String ACL_EXPRESSION_MEMBER
public static final java.lang.String ANALYSIS_COLUMN_MEMBER
public static final java.lang.String VALUE_FORMAT_MEMBER
public static final java.lang.String INDEX_COLUMN_MEMBER
public static final java.lang.String COMPRESSED_MEMBER
public java.lang.String getStructName()
IStructure
public java.util.List<SemanticException> validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
validate
in class org.eclipse.birt.report.model.core.Structure
module
- the moduleelement
- the element contains this structureStructure.validate(Module,
org.eclipse.birt.report.model.core.DesignElement)
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
org.eclipse.birt.report.model.core.Structure
handle
in class org.eclipse.birt.report.model.core.Structure
valueHandle
- the value handle of this structure list property this
structure is inindex
- the position of this structure in structure listCopyright © 2008 Actuate Corp. All rights reserved.