|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.ColumnHintHandle
public class ColumnHintHandle
Represents the handle of column hint. The column hint provides the hint about result set columns.
ANALYSIS_MEMBER
property is set to
ANALYSIS_TYPE_DIMENSION
or ANALYSIS_TYPE_DETAIL
.
For ANALYSIS_TYPE_DIMENSION
, this property establishes the
dimension hierarchy.
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structContext |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
ColumnHintHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of computed column. |
Method Summary | |
---|---|
ExpressionHandle |
getACLExpression()
Gets the expression handle for the ACLExpression member. |
ActionHandle |
getActionHandle()
Returns a handle to work with the action property, action is a structure that defines a hyperlink. |
java.lang.String |
getAlias()
Returns the alias name of this column. |
java.lang.String |
getAnalysis()
Returns the analysis option. |
java.lang.String |
getAnalysisColumn()
Gets the analysis column. |
java.lang.String |
getColumnName()
Returns the column name. |
java.lang.String |
getDescription()
Deprecated. |
java.lang.String |
getDescriptionKey()
Deprecated. |
int |
getDisplayLength()
Deprecated. |
java.lang.String |
getDisplayName()
Returns the display name. |
java.lang.String |
getDisplayNameKey()
Returns the resource key for display name. |
java.lang.String |
getExport()
Returns the export option. |
java.lang.String |
getFormat()
Deprecated. |
java.lang.String |
getHeading()
Gets the heading of the column. |
java.lang.String |
getHeadingKey()
Gets the resource key of the heading of the column. |
java.lang.String |
getHelpText()
Returns the help text. |
java.lang.String |
getHelpTextKey()
Returns the resource key for help text. |
java.lang.String |
getHorizontalAlign()
Gets the horizontal alignment of the column. |
java.lang.String |
getParentLevel()
Returns the parent level. |
java.lang.String |
getSearching()
Returns the searching option. |
java.lang.String |
getTextFormat()
Deprecated. |
FormatValue |
getValueFormat()
Gets the value format of the column. |
boolean |
isCompressed()
Gets the flag which indicates whether the column needs to be compressed. |
boolean |
isIndexColumn()
Gets the flag which indicates whether the column should be generated with index. |
boolean |
isOnColumnLayout()
Gets the hint if the dimension data element should be layout on column. |
ActionHandle |
setAction(Action action)
Set an action on the image. |
void |
setAlias(java.lang.String alias)
Sets the alias name of this column. |
void |
setAnalysis(java.lang.String analysis)
Sets the analysis option. |
void |
setAnalysisColumn(java.lang.String column)
Sets the analysis column. |
void |
setColumnName(java.lang.String columnName)
Sets the column name. |
void |
setCompresssed(boolean compressed)
Sets the flag which indicates whether the column needs to be compressed. |
void |
setDescription(java.lang.String description)
Deprecated. |
void |
setDescriptionKey(java.lang.String descriptionID)
Deprecated. |
void |
setDisplayLength(int displayLength)
Deprecated. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name. |
void |
setDisplayNameKey(java.lang.String displayNameResourceKey)
Sets the resource key for display name. |
void |
setExport(java.lang.String export)
Sets the export option. |
void |
setFormat(java.lang.String format)
Deprecated. |
void |
setHeading(java.lang.String heading)
Sets the heading of the column. |
void |
setHeadingKey(java.lang.String headingID)
Sets the resource key of the heading of the column. |
void |
setHelpText(java.lang.String helpText)
Sets the help text. |
void |
setHelpTextKey(java.lang.String helpTextResourceKey)
Sets the resource key for help text. |
void |
setHorizontalAlign(java.lang.String align)
Sets the horizontal alignment of the column. |
void |
setIndexColumn(boolean indexColumn)
Sets the flag which indicates whether the column should be generated with index. |
void |
setOnColumnLayout(boolean onColumnLayout)
Sets the hint if the dimension data element should be layout on column. |
void |
setParentLevel(java.lang.String parentLevel)
Sets the parent level. |
void |
setSearching(java.lang.String searching)
Sets the searching option. |
void |
setTextFormat(java.lang.String format)
Deprecated. |
void |
setValueFormat(FormatValue format)
Sets the value format of the column. |
void |
setWordWrap(boolean wordWrap)
Deprecated. |
boolean |
wordWrap()
Deprecated. |
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, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle |
---|
getReference |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ColumnHintHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for computed column list of one propertyindex
- the position of this computed column in the listMethod Detail |
---|
public java.lang.String getAlias()
public void setAlias(java.lang.String alias)
alias
- the alias name to setpublic java.lang.String getAnalysis()
DesignChoiceConstants
,
and they are
public void setAnalysis(java.lang.String analysis) throws SemanticException
DesignChoiceConstants
,
and they are
analysis
- the analysis option to set
SemanticException
- if the analysis is not in the choice list.public java.lang.String getColumnName()
public void setColumnName(java.lang.String columnName) throws SemanticException
columnName
- the column name to set
SemanticException
- value required exception.public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- the display name to setpublic java.lang.String getDisplayNameKey()
public void setDisplayNameKey(java.lang.String displayNameResourceKey)
displayNameResourceKey
- the resource key to setpublic java.lang.String getExport()
DesignChoiceConstants
,
and they are
public void setExport(java.lang.String export) throws SemanticException
DesignChoiceConstants
,
and they are
export
- the export option to set
SemanticException
- if the export is not in the choice list.public java.lang.String getFormat()
public void setFormat(java.lang.String format)
format
- the format option to setpublic java.lang.String getHelpText()
public void setHelpText(java.lang.String helpText)
helpText
- the help text to setpublic java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String helpTextResourceKey)
helpTextResourceKey
- the resource key to setpublic java.lang.String getParentLevel()
public void setParentLevel(java.lang.String parentLevel)
parentLevel
- the parent level to setpublic java.lang.String getSearching()
DesignChoiceConstants
,
and they are
public void setSearching(java.lang.String searching) throws SemanticException
DesignChoiceConstants
,
and they are
searching
- the searching option to set
SemanticException
- if the searching is not in the choice list.public boolean isOnColumnLayout()
public void setOnColumnLayout(boolean onColumnLayout) throws SemanticException
onColumnLayout
- the hint if the dimension data element should be layout on
column.
SemanticException
public java.lang.String getHeading()
public void setHeading(java.lang.String heading)
heading
- the new headingpublic java.lang.String getHeadingKey()
public void setHeadingKey(java.lang.String headingID)
headingID
- the new resource key of the headingpublic int getDisplayLength()
public void setDisplayLength(int displayLength)
displayLength
- the new display lengthpublic java.lang.String getHorizontalAlign()
DesignChoiceConstants
:
TEXT_ALIGN_LEFT
TEXT_ALIGN_RIGHT
TEXT_ALIGN_CENTER
TEXT_ALIGN_JUSTIFY
public void setHorizontalAlign(java.lang.String align) throws SemanticException
DesignChoiceConstants
:
TEXT_ALIGN_LEFT
TEXT_ALIGN_RIGHT
TEXT_ALIGN_CENTER
TEXT_ALIGN_JUSTIFY
align
- the new horizontal alignment
SemanticException
- if the align is not defined.public boolean wordWrap()
public void setWordWrap(boolean wordWrap)
wordWrap
- the hint value indicates if the word needs to wrap.public java.lang.String getTextFormat()
DesignChoiceConstants
:
STRING_FORMAT_TYPE_UNFORMATTED
STRING_FORMAT_TYPE_UPPERCASE
STRING_FORMAT_TYPE_LOWERCASE
STRING_FORMAT_TYPE_CUSTOM
STRING_FORMAT_TYPE_ZIP_CODE
STRING_FORMAT_TYPE_ZIP_CODE_4
STRING_FORMAT_TYPE_PHONE_NUMBER
STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
public void setTextFormat(java.lang.String format) throws SemanticException
DesignChoiceConstants
:
STRING_FORMAT_TYPE_UNFORMATTED
STRING_FORMAT_TYPE_UPPERCASE
STRING_FORMAT_TYPE_LOWERCASE
STRING_FORMAT_TYPE_CUSTOM
STRING_FORMAT_TYPE_ZIP_CODE
STRING_FORMAT_TYPE_ZIP_CODE_4
STRING_FORMAT_TYPE_PHONE_NUMBER
STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
format
- the new text format
SemanticException
- if the format is not defined.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the new descriptionpublic java.lang.String getDescriptionKey()
public void setDescriptionKey(java.lang.String descriptionID)
descriptionID
- the new resource key of the descriptionpublic ActionHandle getActionHandle()
null
if the
action has not been set on the column hint; otherwise return nullActionHandle
public ActionHandle setAction(Action action) throws SemanticException
action
- new action to be set on the image, it represents a bookmark
link, hyperlink, and drill through etc.
null
if the
action has not been set on the image.
SemanticException
- if member of the action is not valid.public ExpressionHandle getACLExpression()
ACLExpression
member.
public java.lang.String getAnalysisColumn()
public void setAnalysisColumn(java.lang.String column) throws SemanticException
column
- the column to set
SemanticException
public FormatValue getValueFormat()
public void setValueFormat(FormatValue format) throws SemanticException
format
- the value format to set
SemanticException
public boolean isIndexColumn()
public void setIndexColumn(boolean indexColumn) throws SemanticException
indexColumn
- the new flag to set
SemanticException
public boolean isCompressed()
public void setCompresssed(boolean compressed) throws SemanticException
compressed
- the new flag to set
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |