FilterColumn

Inheritance: java.lang.Object

public class FilterColumn

Represents a filter for a single column or a column in the table.

Methods

Method	Description
equals(Object arg0)
getClass()
getColorFilter()	Gets ColorFilter for filtering data by color.
getCustomFilters()	Gets CustomFilterCollection for filtering data by custom criteria.
getDynamicFilter()	Gets getDynamicFilter() for filtering with dynamic criteria.
getFieldIndex()	Gets the column offset in the range.
getFilter()	Gets the condition of filtering data.
getFilterType()	Gets the type fo filtering data.
getFilterValues()	Gets FilterValueCollection for filtering data by labels or date time.
getIconFilter()	Gets getIconFilter() for filtering data by icon.
getMultipleFilters()	Gets MultipleFilterCollection for filtering data by labels or date time.
getTop10Filter()	Gets getTop10Filter() for filtering data by rank of data.
hashCode()
isDropdownVisible()	Indicates whether the AutoFilter button for this column is visible.
notify()
notifyAll()
selectAll()	Selects all.
setCustomFilters(CustomFilterCollection value)	Gets CustomFilterCollection for filtering data by custom criteria.
setDropdownVisible(boolean value)	Indicates whether the AutoFilter button for this column is visible.
setFieldIndex(int value)	Sets the column offset in the range.
setFilter(Object value)	Sets the condition of filtering data.
setFilterType(int value)	Sets the type fo filtering data.
setMultipleFilters(MultipleFilterCollection value)	Gets MultipleFilterCollection for filtering data by labels or date time.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColorFilter()

public ColorFilter getColorFilter()

Gets ColorFilter for filtering data by color.

Remarks

Sets FilterType as FilterType.COLOR_FILTER first,otherwise Null will be returned.

Returns: ColorFilter

getCustomFilters()

public CustomFilterCollection getCustomFilters()

Gets CustomFilterCollection for filtering data by custom criteria.

Remarks

NOTE: This setter of this propery is now obsolete. Instead,please use property getFilterType() by setting it as FilterType.CUSTOM_FILTERS. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

Returns: CustomFilterCollection

getDynamicFilter()

public DynamicFilter getDynamicFilter()

Gets getDynamicFilter() for filtering with dynamic criteria.

Remarks

Before using this property, please make sure getFilterType() is FilterType.DYNAMIC_FILTER, otherwise null will be returned.

Returns: DynamicFilter

getFieldIndex()

public int getFieldIndex()

Gets the column offset in the range.

Returns: int

getFilter()

public Object getFilter()

Gets the condition of filtering data.

Remarks

NOTE: This member is now obsolete. Instead, please use corresponding property according to getFilterType(). And for filter type FilterType.MULTIPLE_FILTERS, the returned object is FilterValueCollection now instead of MultipleFilterCollection. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.

Returns: java.lang.Object

getFilterType()

public int getFilterType()

Gets the type fo filtering data.

See FilterType.

Remarks

The corresponding filter object will be created when this property is set and corresponding property should be used to get the filter object accordingly:

FilterType	Property
MultipleFilters	getFilterValues()
CustomFilters	getCustomFilters()
ColorFilter	getColorFilter()
DynamicFilter	getDynamicFilter()
IconFilter	getIconFilter()
Top10	getTop10Filter()

Returns: int

getFilterValues()

public FilterValueCollection getFilterValues()

Gets FilterValueCollection for filtering data by labels or date time.

Remarks

Sets getFilterType() as FilterType.MULTIPLE_FILTERS first,otherwise Null will be returned.

Returns: FilterValueCollection

getIconFilter()

public IconFilter getIconFilter()

Gets getIconFilter() for filtering data by icon.

Remarks

Before using this property, please make sure getFilterType() is FilterType.ICON_FILTER, otherwise null will be returned.

Returns: IconFilter

getMultipleFilters()

public MultipleFilterCollection getMultipleFilters()

Gets MultipleFilterCollection for filtering data by labels or date time.

Remarks

NOTE: This member is now obsolete. Instead,please use FilterColumn.FilterValues property . This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

Returns: MultipleFilterCollection

getTop10Filter()

public Top10Filter getTop10Filter()

Gets getTop10Filter() for filtering data by rank of data.

Remarks

Before using this property, please make sure getFilterType() is FilterType.TOP_10, otherwise null will be returned.

Returns: Top10Filter

hashCode()

public native int hashCode()

Returns: int

isDropdownVisible()

public boolean isDropdownVisible()

Indicates whether the AutoFilter button for this column is visible.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

selectAll()

public void selectAll()

Selects all.

setCustomFilters(CustomFilterCollection value)

public void setCustomFilters(CustomFilterCollection value)

Gets CustomFilterCollection for filtering data by custom criteria.

Remarks

NOTE: This setter of this propery is now obsolete. Instead,please use property getFilterType() by setting it as FilterType.CUSTOM_FILTERS. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

Parameter	Type	Description
value	CustomFilterCollection

setDropdownVisible(boolean value)

public void setDropdownVisible(boolean value)

Indicates whether the AutoFilter button for this column is visible.

Parameters:

Parameter	Type	Description
value	boolean

setFieldIndex(int value)

public void setFieldIndex(int value)

Sets the column offset in the range.

Parameters:

Parameter	Type	Description
value	int

setFilter(Object value)

public void setFilter(Object value)

Sets the condition of filtering data.

Remarks

NOTE: This member is now obsolete. Instead, please use corresponding property according to getFilterType(). And for filter type FilterType.MULTIPLE_FILTERS, the returned object is FilterValueCollection now instead of MultipleFilterCollection. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

Parameter	Type	Description
value	java.lang.Object

setFilterType(int value)

public void setFilterType(int value)

Sets the type fo filtering data.

See FilterType.

Remarks

The corresponding filter object will be created when this property is set and corresponding property should be used to get the filter object accordingly:

FilterType	Property
MultipleFilters	getFilterValues()
CustomFilters	getCustomFilters()
ColorFilter	getColorFilter()
DynamicFilter	getDynamicFilter()
IconFilter	getIconFilter()
Top10	getTop10Filter()

Parameters:

Parameter	Type	Description
value	int

setMultipleFilters(MultipleFilterCollection value)

public void setMultipleFilters(MultipleFilterCollection value)

Gets MultipleFilterCollection for filtering data by labels or date time.

Remarks

NOTE: This member is now obsolete. Instead,please use FilterColumn.FilterValues property . This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

Parameter	Type	Description
value	MultipleFilterCollection

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int