Package org.zkoss.pivot.util

Class PivotExportSheetConfig

java.lang.Object

org.zkoss.pivot.util.PivotExportSheetConfig

public class PivotExportSheetConfig
extends Object

export configuration object containing Sheet name/order/hidden information

Since:

2.4.0

Author:

Robert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PivotExportSheetConfig.SheetOrder

Field Summary

Fields

Modifier and Type	Field	Description
static PivotExportSheetConfig	DEFAULT_SHEET_CONFIG

Constructor Summary

Constructors

Constructor	Description
PivotExportSheetConfig(String dataSheetName, String pivotSheetName, PivotExportSheetConfig.SheetOrder sheetOrder, boolean dataSheetHidden, boolean columnAutoSize)

Method Summary

Modifier and Type	Method	Description
String	getDataSheetName()
String	getPivotSheetName()
PivotExportSheetConfig.SheetOrder	getSheetOrder()
boolean	isColumnAutoSize()
boolean	isDataSheetHidden()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SHEET_CONFIG

public static PivotExportSheetConfig DEFAULT_SHEET_CONFIG

Constructor Details

PivotExportSheetConfig

public PivotExportSheetConfig(String dataSheetName,
 String pivotSheetName,
 PivotExportSheetConfig.SheetOrder sheetOrder,
 boolean dataSheetHidden,
 boolean columnAutoSize)

Throws:

IllegalArgumentException - if a sheet name is one Excel does not allow, or both sheets have the same name (ignoring case). A sheet name must not be empty, be longer than 31 characters, contain any of : \ / ? * [ ], start or end with an apostrophe, or be the reserved name "History".

Method Details

getPivotSheetName

public String getPivotSheetName()

getDataSheetName

public String getDataSheetName()

getSheetOrder

public PivotExportSheetConfig.SheetOrder getSheetOrder()

isDataSheetHidden

public boolean isDataSheetHidden()

isColumnAutoSize

public boolean isColumnAutoSize()