Package com.grapecity.documents.excel

Class CellColorSortField

java.lang.Object

com.grapecity.documents.excel.SortFieldBase

com.grapecity.documents.excel.CellColorSortField

All Implemented Interfaces:

ICellColorSortField, ISortField

public class CellColorSortField
extends SortFieldBase
implements ICellColorSortField

Specifies the interior sort.

Constructor Summary

Constructors

Constructor	Description
CellColorSortField(IRange key, IInterior interior)	Sorts the interior based on color.
CellColorSortField(IRange key, IInterior interior, SortOrder order)	Constructs a new CellColorSortField object with the specified key, interior, and sort order.

Method Summary

Modifier and Type	Method	Description
final IInterior	getInterior()	Specifies the interior to sort.
final SortOrder	getOrder()	Specifies the sort order.
final void	setOrder(SortOrder value)	Set the sort order.

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

getKey, getPriority, getSortOn, setPriority

Methods inherited from class java.lang.Object

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

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

getKey, getPriority, getSortOn, setPriority

Constructor Details

CellColorSortField

public CellColorSortField(IRange key,
 IInterior interior)

Sorts the interior based on color.

Parameters:

key - The column index.

interior - The interior.

CellColorSortField

public CellColorSortField(IRange key,
 IInterior interior,
 SortOrder order)

Constructs a new CellColorSortField object with the specified key, interior, and sort order.

Parameters:

key - The range representing the key for sorting.

interior - The interior representing the cell color used for sorting.

order - The sort order for the field.

Method Details

getOrder

public final SortOrder getOrder()

Specifies the sort order.

Specified by:

getOrder in interface ICellColorSortField

Returns:

The sort order of the cell color.

setOrder

public final void setOrder(SortOrder value)

Set the sort order.

Specified by:

setOrder in interface ICellColorSortField

Parameters:

value - The sort order of the cell color.

getInterior

public final IInterior getInterior()

Specifies the interior to sort.

Specified by:

getInterior in interface ICellColorSortField

Returns:

The interior of the sort.