|
||||||||||
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.SortKeyHandle
public class SortKeyHandle
Represents the handle of sort key structure. The sort key is the sort entry for a table or list item, it defines the column and sort direction pair. Each sort key has the following properties:
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
SortKeyHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of sort key. |
Method Summary | |
---|---|
java.lang.String |
getColumnName()
Deprecated. This property has been removed. See the method getKey() . |
java.lang.String |
getDirection()
Returns the sort direction. |
java.lang.String |
getKey()
Returns an expression that gives the sort key on which to sort. |
void |
setColumnName(java.lang.String columnName)
Deprecated. This property has been removed. See the method setKey(String) . |
void |
setDirection(java.lang.String direction)
Sets the sort direction. |
void |
setKey(java.lang.String key)
Sets an expression that gives the sort key on which to sort. |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
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 SortKeyHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for sort key list of one propertyindex
- the position of this sort key in the listMethod Detail |
---|
public java.lang.String getKey()
setKey(String)
public void setKey(java.lang.String key) throws SemanticException
key
- the key to sort
SemanticException
- value required exceptiongetKey()
public java.lang.String getDirection()
DesignChoiceConstants
,
and they are:
public void setDirection(java.lang.String direction) throws SemanticException
DesignChoiceConstants
,
and they are:
direction
- the direction to set
SemanticException
- if the direction is not in choice list.public java.lang.String getColumnName()
getKey()
.
public void setColumnName(java.lang.String columnName) throws SemanticException
setKey(String)
.
columnName
- the column name to set
SemanticException
- value required exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |