com.f1j.ss.pivot
Interface FieldSettings

public interface FieldSettings

extends RowColumnFieldSettings

This interface defines the PivotRange field settings API.

Since:

11.0

Inner Class Summary

static class	FieldSettings.EAutoSortOption Enumeration class for defining the auto sorting that should be applied to the items in this field.
static class	FieldSettings.ESubtotalType Enumeration class for defining the type of Field subtotalling to use.

Inner classes inherited from class com.f1j.ss.pivot.BaseFieldSettings

BaseFieldSettings.EFunctionType

Method Summary

java.lang.String	getAutoShowField() Returns the name of the summary field that will be used as the key for auto show.
int	getAutoShowFieldCount() Returns the number of summary fields available for auto show.
java.lang.String[]	getAutoShowFields() Returns an array of summary fields that can be used as the key field for auto show.
int	getAutoShowItemCount() Returns the number of items that will be displayed with auto show.
java.lang.String	getAutoSortField() Returns the name of the field that will be used when sorting in ascending or descending order.
int	getAutoSortFieldCount() Returns the number of fields available for auto sort.
java.lang.String[]	getAutoSortFields() Returns an array of fields that can be used as the key field when sorting in ascending or descending order.
FieldSettings.EAutoSortOption	getAutoSortOption() Returns an enumeration indicating which auto sort option is currently applied to the items in the field.
int	getCustomSubtotalCount() /** Returns the number of custom subtotals applied to this Field.
FieldLayout	getFieldLayout() Returns a FieldLayout object for defining layout characteristics for the current Field.
FieldSettings.ESubtotalType	getSubtotalType() Returns an enumeration indicating the type of subtotal, if any, to apply to the current Field.
boolean	isAutoShowEnabled() Indicates whether auto show is enabled.
boolean	isAutoShowingTopItems() Indicates whether top or bottom items are being shown.
boolean	isShowingAllItems() Indicates whether all items in the PivotRange report are to being displayed, even if they do not contain summary data.
boolean	isSubtotalEnabled(BaseFieldSettings.EFunctionType function) Indicates whether the indexed subtotal is enabled.
void	setAutoShowEnabled(boolean enabled) Sets whether auto show is enabled.
void	setAutoShowField(java.lang.String name) Sets the summary field that will be used for auto show.
void	setAutoShowingTopItems(boolean wantTopItems) Sets whether top or bottom items should be shown.
void	setAutoSortField(java.lang.String name) Sets the field that will be used when sorting in ascending or descending order.
void	setAutoSortOption(FieldSettings.EAutoSortOption option) Sets which auto sort option should be applied to the items in the field.
void	setFieldLayout(FieldLayout fieldLayout) Sets the layout characteristics of the current field.
void	setNumAutoShowItems(int count) Sets the number of items that should be displayed with auto show.
void	setShowAllItems(boolean show) Sets whether all items in the PivotRange report are to be displayed, even if they do not contain summary data.
void	setSubtotalEnabled(BaseFieldSettings.EFunctionType function, boolean enabled) Sets whether the subtotal function type should be enabled.
void	setSubtotalType(FieldSettings.ESubtotalType type) Sets the type of subtotal, if any, to apply to the current Field.

Methods inherited from interface com.f1j.ss.pivot.RowColumnFieldSettings

getItemCount, getItems, isVisible, setVisibility

Methods inherited from interface com.f1j.ss.pivot.BaseFieldSettings

getName, getNumberFormat, setName, setNumberFormat

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

getAutoShowField

public java.lang.String getAutoShowField()

Returns the name of the summary field that will be used as the key for auto show.

Returns:

The name of the auto show key field.

Since:

11.0

See Also:

Field

getAutoShowFields

public java.lang.String[] getAutoShowFields()

Returns an array of summary fields that can be used as the key field for auto show.

Returns:

An array of field names.

Since:

11.0

See Also:

Field

getAutoSortField

public java.lang.String getAutoSortField()

Returns the name of the field that will be used when sorting in ascending or descending order.

Returns:

The name of the auto sort key field.

Since:

11.0

See Also:

Field

getAutoSortFields

public java.lang.String[] getAutoSortFields()

Returns an array of fields that can be used as the key field when sorting in ascending or descending order.

Returns:

An array of field names.

Since:

11.0

See Also:

Field

getAutoSortOption

public FieldSettings.EAutoSortOption getAutoSortOption()

Returns an enumeration indicating which auto sort option is currently applied to the items in the field.

Returns:

An enumeration of EAutoSortOption.

Since:

11.0

See Also:

FieldSettings.EAutoSortOption, Field

getFieldLayout

public FieldLayout getFieldLayout()

Returns a FieldLayout object for defining layout characteristics for the current Field.

Returns:

A FieldLayout object.

Since:

11.0

See Also:

Field, FieldLayout

getAutoShowFieldCount

public int getAutoShowFieldCount()

Returns the number of summary fields available for auto show.

Returns:

Number of summary fields for auto show.

Since:

11.0

See Also:

Field

getAutoShowItemCount

public int getAutoShowItemCount()

Returns the number of items that will be displayed with auto show.

Returns:

Number of items to show.

Since:

11.0

See Also:

Field

getAutoSortFieldCount

public int getAutoSortFieldCount()

Returns the number of fields available for auto sort.

Returns:

Number of fields for auto sort.

Since:

11.0

See Also:

Field

getCustomSubtotalCount

public int getCustomSubtotalCount()

/** Returns the number of custom subtotals applied to this Field.

Returns:

The number of custom subtotals applied to this Field.

Since:

11.0

See Also:

Field

getSubtotalType

public FieldSettings.ESubtotalType getSubtotalType()

Returns an enumeration indicating the type of subtotal, if any, to apply to the current Field.

Returns:

An enumeration of ESubtotalType.

Since:

11.0

See Also:

FieldSettings.ESubtotalType, Field

isAutoShowEnabled

public boolean isAutoShowEnabled()

Indicates whether auto show is enabled.

Returns:

boolean. true = if subtotal is enabled.

Since:

11.0

isAutoShowingTopItems

public boolean isAutoShowingTopItems()

Indicates whether top or bottom items are being shown.

Returns:

boolean. true = if top items are being shown.

Since:

11.0

isShowingAllItems

public boolean isShowingAllItems()

Indicates whether all items in the PivotRange report are to being displayed, even if they do not contain summary data.

Returns:

true = if all items are being displayed.

Since:

11.0

See Also:

Field

isSubtotalEnabled

public boolean isSubtotalEnabled(BaseFieldSettings.EFunctionType function)
                          throws com.f1j.util.InvalidIndexException,
                                 F1Exception

Indicates whether the indexed subtotal is enabled.

Parameters:

function - The subtotal function type.

Returns:

boolean. true = if subtotal is enabled.

Throws:

com.f1j.util.InvalidIndexException - if index is invalid.

F1Exception - if an error occurs.

Since:

11.0

setAutoShowEnabled

public void setAutoShowEnabled(boolean enabled)

Sets whether auto show is enabled.

Parameters:

enabled - boolean. true = if auto show is enabled.

Since:

11.0

setAutoShowingTopItems

public void setAutoShowingTopItems(boolean wantTopItems)

Sets whether top or bottom items should be shown.

Parameters:

wantTopItems - boolean. true = if top items should be shown.

Since:

11.0

setAutoShowField

public void setAutoShowField(java.lang.String name)
                      throws InvalidArgumentException,
                             F1Exception

Sets the summary field that will be used for auto show.

Parameters:

name - The name of the auto show key field.

Throws:

InvalidArgumentException - if name is invalid.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setAutoSortField

public void setAutoSortField(java.lang.String name)
                      throws InvalidArgumentException,
                             F1Exception

Sets the field that will be used when sorting in ascending or descending order.

Parameters:

name - The name of the auto sort key field.

Throws:

InvalidArgumentException - if name is invalid.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setAutoSortOption

public void setAutoSortOption(FieldSettings.EAutoSortOption option)

Sets which auto sort option should be applied to the items in the field.

Parameters:

option - An enumeration of EAutoSortOption.

Since:

11.0

See Also:

FieldSettings.EAutoSortOption, Field

setFieldLayout

public void setFieldLayout(FieldLayout fieldLayout)

Sets the layout characteristics of the current field.

Parameters:

fieldLayout - A FieldLayout object.

Since:

11.0

See Also:

Field, FieldLayout

setNumAutoShowItems

public void setNumAutoShowItems(int count)

Sets the number of items that should be displayed with auto show.

Parameters:

count - Number of items to show.

Since:

11.0

See Also:

Field

setShowAllItems

public void setShowAllItems(boolean show)

Sets whether all items in the PivotRange report are to be displayed, even if they do not contain summary data. The default is false.

Parameters:

show - true = if all items are displayed.

Since:

11.0

See Also:

Field

setSubtotalEnabled

public void setSubtotalEnabled(BaseFieldSettings.EFunctionType function,
                               boolean enabled)
                        throws com.f1j.util.InvalidIndexException,
                               F1Exception

Sets whether the subtotal function type should be enabled.

Parameters:

function - Subtotal function type.

enabled - true = if subtotal is enabled.

Throws:

com.f1j.util.InvalidIndexException - if index is invalid.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setSubtotalType

public void setSubtotalType(FieldSettings.ESubtotalType type)

Sets the type of subtotal, if any, to apply to the current Field.

Parameters:

type - An enumeration of ESubtotalType.

Since:

11.0

See Also:

FieldSettings.ESubtotalType, Field