com.f1j.ss.pivot
Interface PivotRangeOptions

public interface PivotRangeOptions

extends Lockable

This interface defines the API for setting PivotRange characteristics, such as the name.

Field Summary

static int	kMaxPageWrapCount The maximum allowed value in the page wrap count.
static int	kMinPageWrapCount The minimum allowed value in the page wrap count.

Method Summary

boolean	alwaysDisplayItems() Indicates whether the row and column items will be displayed when a data field has not been added.
boolean	displayErrorString() Indicates whether a custom string should be used for errors in the data area.
boolean	displayNullString() Indicates whether a custom string should be used for empty cells in the data area.
java.lang.String	getErrorString() Returns the custom string that should be used for errors in the data area.
java.lang.String	getName() Returns the name of the PivotRange.
java.lang.String	getNullString() Returns the custom string that should be used for empty cells in the data area.
int	getPageWrapCount() Returns the wrap count that should be used in the page area.
boolean	isDrillDownEnabled() Indicates whether drill down is allowed in Fields.
boolean	preserveFormatting() Indicates whether the custom formatting should be preserved.
boolean	repeatLabelsWhenPrinting() Indicates whether field labels should be shown on every page while printing.
void	setAlwaysDisplayItems(boolean alwaysDisplayItems) Set whether the row and column items should be displayed when a data field has not been added.
void	setDisplayErrorString(boolean displayErrorString) Sets whether the custom string should be used for errors in the data area.
void	setDisplayNullString(boolean displayNullString) Sets whether the custom string should be used for empty cells in the data area.
void	setDrillDownEnabled(boolean enabled) Sets whether drill down is allowed in Fields.
void	setErrorString(java.lang.String str) Sets the custom string should be used for errors in the data area.
void	setName(java.lang.String str) Sets the name of the PivotRange.
void	setNullString(java.lang.String str) Sets the custom string should be used for empty cells in the data area.
void	setPageWrapCount(int count) Sets the page area wrap count.
void	setPreserveFormatting(boolean preserveFormatting) Sets whether the custom formatting should be preserved.
void	setRepeatLabelsWhenPrinting(boolean repeatLabels) Sets whether field labels should be shown on every page while printing.
void	setSubtotalHiddenPageItems(boolean subtotalHiddenItems) Sets whether hidden items in page area should be included in subtotals.
void	setUseAcrossPageLayout(boolean useAcrossLayout) Sets the layout direction of Fields in the page area.
void	setUseAutoFormat(boolean useAutoFormat) Sets whether autoformatting should be allowed.
void	setWantColumnGrandTotal(boolean wantTotal) Sets whether grand totals should be diplayed for Fields in the column area.
void	setWantMergedLabels(boolean wantMergedLabels) Sets whether an Item label and adjoining empty cells should be treated as merged cells in the row and column areas.
void	setWantPrintedTitles(boolean wantTitles) Indicates whether printed titles should be used.
void	setWantRowGrandTotal(boolean wantTotal) Sets whether grand totals should be diplayed for Fields in the row area.
boolean	subtotalHiddenPageItems() Indicates whether hidden items in page area should be included in subtotals.
boolean	useAcrossPageLayout() Indicates the layout direction of Fields in the page area.
boolean	useAutoFormat() Indicates whether autoformatting should be allowed.
boolean	wantColumnGrandTotal() Indicates whether grand totals will be diplayed for Fields in the column area.
boolean	wantMergedLabels() Indicates whether an Item label and adjoining empty cells will be treated as merged cells in the row and column areas.
boolean	wantPrintedTitles() Sets whether printed titles should be used.
boolean	wantRowGrandTotal() Indicates whether grand totals will be diplayed for Fields in the row area.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Field Detail

kMinPageWrapCount

public static final int kMinPageWrapCount

The minimum allowed value in the page wrap count.

kMaxPageWrapCount

public static final int kMaxPageWrapCount

The maximum allowed value in the page wrap count.

Method Detail

alwaysDisplayItems

public boolean alwaysDisplayItems()

Indicates whether the row and column items will be displayed when a data field has not been added.

Returns:

boolean. true = if row/column fields will be displayed when no data field is present.

See Also:

PivotRange

displayErrorString

public boolean displayErrorString()

Indicates whether a custom string should be used for errors in the data area.

Returns:

boolean. true = if a custom string should be used.

See Also:

PivotRange

displayNullString

public boolean displayNullString()

Indicates whether a custom string should be used for empty cells in the data area.

Returns:

boolean. true = if a custom string should be used.

See Also:

PivotRange

getErrorString

public java.lang.String getErrorString()

Returns the custom string that should be used for errors in the data area.

Returns:

The custom string that should be used for errors in the data area.

See Also:

PivotRange

getName

public java.lang.String getName()

Returns the name of the PivotRange.

Returns:

The name of the PivotRange.

See Also:

PivotRange

getNullString

public java.lang.String getNullString()

Returns the custom string that should be used for empty cells in the data area.

Returns:

The custom string that should be used for empty cells in the data area.

See Also:

PivotRange

getPageWrapCount

public int getPageWrapCount()

Returns the wrap count that should be used in the page area.

Returns:

The page area wrap count.

See Also:

PivotRange

isDrillDownEnabled

public boolean isDrillDownEnabled()

Indicates whether drill down is allowed in Fields.

Returns:

boolean. true = if drill down is allowed.

See Also:

Field, PivotRange

preserveFormatting

public boolean preserveFormatting()

Indicates whether the custom formatting should be preserved.

Returns:

boolean. true = if formatting is preserved.

See Also:

PivotRange

repeatLabelsWhenPrinting

public boolean repeatLabelsWhenPrinting()

Indicates whether field labels should be shown on every page while printing.

Returns:

boolean. true = if want labels on every page.

See Also:

PivotRange

setAlwaysDisplayItems

public void setAlwaysDisplayItems(boolean alwaysDisplayItems)

Set whether the row and column items should be displayed when a data field has not been added.

Parameters:

alwaysDisplayItems - true = if row/column fields should be displayed when no data field is present.

See Also:

PivotRange

setDisplayErrorString

public void setDisplayErrorString(boolean displayErrorString)

Sets whether the custom string should be used for errors in the data area.

Parameters:

displayErrorString - boolean. true to display the custom string.

See Also:

PivotRange

setDisplayNullString

public void setDisplayNullString(boolean displayNullString)

Sets whether the custom string should be used for empty cells in the data area.

Parameters:

displayNullString - boolean. true to display the custom string.

See Also:

PivotRange

setErrorString

public void setErrorString(java.lang.String str)

Sets the custom string should be used for errors in the data area.

Parameters:

str - The custom string that should be used for errors in the data area.

See Also:

PivotRange

setName

public void setName(java.lang.String str)
             throws DuplicateNameException,
                    com.f1j.ss.pivot.InvalidNameException,
                    F1Exception

Sets the name of the PivotRange.

Parameters:

str - The name of the PivotRange.

Throws:

DuplicateNameException - if PivotRange with this name exists.

com.f1j.ss.pivot.InvalidNameException - if name is invalid.

F1Exception - if an error occurs.

See Also:

PivotRange

setNullString

public void setNullString(java.lang.String str)

Sets the custom string should be used for empty cells in the data area.

Parameters:

str - The custom string that should be used for empty cells in the data area.

See Also:

PivotRange

setPageWrapCount

public void setPageWrapCount(int count)
                      throws InvalidArgumentException,
                             F1Exception

Sets the page area wrap count.

Parameters:

count - The number of fields to show in page area before wrapping.

Throws:

InvalidArgumentException - if count is invalid.

F1Exception - if an error occurs.

See Also:

PivotRange

setDrillDownEnabled

public void setDrillDownEnabled(boolean enabled)

Sets whether drill down is allowed in Fields.

Parameters:

enabled - boolean. true = if drill down is allowed.

See Also:

Field, PivotRange

setPreserveFormatting

public void setPreserveFormatting(boolean preserveFormatting)

Sets whether the custom formatting should be preserved.

Parameters:

preserveFormatting - boolean. true = if formatting is preserved.

See Also:

Field, PivotRange

setRepeatLabelsWhenPrinting

public void setRepeatLabelsWhenPrinting(boolean repeatLabels)

Sets whether field labels should be shown on every page while printing.

Parameters:

repeatLabels - boolean. true = if want labels on every page.

See Also:

PivotRange

setSubtotalHiddenPageItems

public void setSubtotalHiddenPageItems(boolean subtotalHiddenItems)

Sets whether hidden items in page area should be included in subtotals.

Parameters:

subtotalHiddenItems - boolean. true = if hidden page items should be included in subtotals.

See Also:

PivotRange

setUseAcrossPageLayout

public void setUseAcrossPageLayout(boolean useAcrossLayout)

Sets the layout direction of Fields in the page area.

Parameters:

useAcrossLayout - boolean. true = if fields should be displayed across then down. false = if fields should be displayed down then across.

See Also:

Field, PivotRange

setUseAutoFormat

public void setUseAutoFormat(boolean useAutoFormat)

Sets whether autoformatting should be allowed.

Parameters:

useAutoFormat - boolean. true = if autoformatting is allowed.

See Also:

PivotRange

setWantColumnGrandTotal

public void setWantColumnGrandTotal(boolean wantTotal)

Sets whether grand totals should be diplayed for Fields in the column area.

Parameters:

wantTotal - boolean. true = if grand totals should be displayed.

See Also:

Field, PivotRange

setWantMergedLabels

public void setWantMergedLabels(boolean wantMergedLabels)

Sets whether an Item label and adjoining empty cells should be treated as merged cells in the row and column areas.

Parameters:

wantMergedLabels - boolean. true = if merged cells should be used.

See Also:

Item, PivotRange

setWantPrintedTitles

public void setWantPrintedTitles(boolean wantTitles)

Indicates whether printed titles should be used.

Parameters:

wantTitles - boolean. true = if using printed titles.

See Also:

PivotRange

setWantRowGrandTotal

public void setWantRowGrandTotal(boolean wantTotal)

Sets whether grand totals should be diplayed for Fields in the row area.

Parameters:

wantTotal - boolean. true = if grand totals should be displayed.

See Also:

Field, PivotRange

subtotalHiddenPageItems

public boolean subtotalHiddenPageItems()

Indicates whether hidden items in page area should be included in subtotals.

Returns:

boolean. true = if hidden page items should be included in subtotals.

See Also:

PivotRange

useAcrossPageLayout

public boolean useAcrossPageLayout()

Indicates the layout direction of Fields in the page area.

Returns:

boolean. true = if fields will be displayed across then down. false = if fields will be displayed down then across.

See Also:

Field, PivotRange

useAutoFormat

public boolean useAutoFormat()

Indicates whether autoformatting should be allowed.

Returns:

boolean. true = if autoformatting is allowed.

See Also:

PivotRange

wantColumnGrandTotal

public boolean wantColumnGrandTotal()

Indicates whether grand totals will be diplayed for Fields in the column area.

Returns:

boolean. true = if grand totals should be displayed.

See Also:

Field, PivotRange

wantMergedLabels

public boolean wantMergedLabels()

Indicates whether an Item label and adjoining empty cells will be treated as merged cells in the row and column areas.

Returns:

boolean. true = if merged cells will be used.

See Also:

Item, PivotRange

wantPrintedTitles

public boolean wantPrintedTitles()

Sets whether printed titles should be used.

Returns:

boolean. true = if using printed titles.

See Also:

PivotRange

wantRowGrandTotal

public boolean wantRowGrandTotal()

Indicates whether grand totals will be diplayed for Fields in the row area.

Returns:

boolean. true = if grand totals should be displayed.

See Also:

Field, PivotRange