Package com.grapecity.documents.excel

Class SortFieldBase

java.lang.Object

com.grapecity.documents.excel.SortFieldBase

All Implemented Interfaces:

ISortField

Direct Known Subclasses:

CellColorSortField, FontColorSortField, IconSortField, ValueSortField

public abstract class SortFieldBase
extends Object
implements ISortField

Represents the sort base class.

Constructor Summary

Constructors

Constructor	Description
SortFieldBase()

Method Summary

Modifier and Type	Method	Description
final IRange	getKey()	Specifies the column index.
final int	getPriority()	Specifies the priority of multiple sort columns.
final SortOnType	getSortOn()	Specifies the sort type.
final void	setPriority(int value)	Sets the priority of multiple sort columns.

Methods inherited from class java.lang.Object

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

Constructor Details

SortFieldBase

public SortFieldBase()

Method Details

getKey

public final IRange getKey()

Specifies the column index.

Specified by:

getKey in interface ISortField

Returns:

The range representing the sort key.

getPriority

public final int getPriority()

Specifies the priority of multiple sort columns.

Specified by:

getPriority in interface ISortField

Returns:

The priority of the sort field.

setPriority

public final void setPriority(int value)

Sets the priority of multiple sort columns.

Specified by:

setPriority in interface ISortField

Parameters:

value - The priority of the sort field.

getSortOn

public final SortOnType getSortOn()

Specifies the sort type.

Specified by:

getSortOn in interface ISortField

Returns:

The sort type.