com.grapecity.documents.excel

Class ValueSortField

java.lang.Object

com.grapecity.documents.excel.SortFieldBase

com.grapecity.documents.excel.ValueSortField

All Implemented Interfaces:

ISortField, IValueSortField

public class ValueSortField
extends SortFieldBase
implements IValueSortField

Represents the sort by value field.

Constructor Summary

Constructors

Constructor and Description
ValueSortField(IRange key) Specifies the normal construct method.
ValueSortField(IRange key, SortOrder order) Specifies the normal construct method.
ValueSortField(IRange key, java.lang.String customValues) Specifies the custom sort construct method.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomValues() Specifies the custom sort list string.
SortDataOption	getDataOption() Specifies the data option of the sort field.
SortOrder	getOrder() Specifies the sort order.
void	setCustomValues(java.lang.String value) Sets the custom value list, such as:3,2,5,1.
void	setDataOption(SortDataOption value) Sets the data option of the sort field.
void	setOrder(SortOrder value) Sets the sort order.

Methods inherited from class com.grapecity.documents.excel.SortFieldBase

getKey, getPriority, getSortCondition, getSortOn, setPriority, setSortCondition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.grapecity.documents.excel.ISortField

getKey, getPriority, getSortOn, setPriority

Constructor Detail

ValueSortField

public ValueSortField(IRange key)

Specifies the normal construct method.

Parameters:

key - The column index.

ValueSortField

public ValueSortField(IRange key,
                      SortOrder order)

Specifies the normal construct method.

Parameters:

key - The column index.

order - The sort order.

ValueSortField

public ValueSortField(IRange key,
                      java.lang.String customValues)

Specifies the custom sort construct method.

Parameters:

key - the column index

customValues - custom list string

Method Detail

getDataOption

public final SortDataOption getDataOption()

Specifies the data option of the sort field.

Specified by:

getDataOption in interface IValueSortField

setDataOption

public final void setDataOption(SortDataOption value)

Sets the data option of the sort field.

Specified by:

setDataOption in interface IValueSortField

getOrder

public final SortOrder getOrder()

Specifies the sort order.

Specified by:

getOrder in interface IValueSortField

setOrder

public final void setOrder(SortOrder value)

Sets the sort order.

Specified by:

setOrder in interface IValueSortField

getCustomValues

public final java.lang.String getCustomValues()

Specifies the custom sort list string.

Specified by:

getCustomValues in interface IValueSortField

setCustomValues

public final void setCustomValues(java.lang.String value)

Description copied from interface: IValueSortField

Sets the custom value list, such as:3,2,5,1.

Specified by:

setCustomValues in interface IValueSortField