Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
OpenAPI 1.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.aquafold.openapi.data
Interface AQDataSetSettings

All Known Subinterfaces:
AQReportDataSetSettings
public interface AQDataSetSettings

The AQDataSetSettings interface describes how a data set to be formatted when presented in a 2-dimensional grid.

Data sets listed below are currently supported:

And, as of this release, a grid can be presented in one of the following ways:

A typical plain text grid would be similar to the one shown below: 

   Title text goes here.
   Report time goes here.
   ===  =========  |  =========  =========  (title divider)
         header-1  |   header-2   header-3  (header row)
   ===  =========  |  =========  =========  (header divider)
     1  value 1-1  |  value 1-2  value 1-3
     2  value 2-1  |  value 2-2  value 2-3
   ...  .........  |  .........  .........  (row divider)
     3  value 3-1  |  value 3-2  value 3-3
     4  value 4-1  |  value 4-2  value 4-3
     5  value 3-1  |  value 5-2  value 5-3
   ---  ---------  |  ---------  ---------  (footer divider)
   Footer text goes here.
where

The followings are set by default:

Please see method definitions for more information about:

Please note that all of dividers described above are only applicable to plain text grid but not HTML.

Values presented in the generated grid will be formatted by default, using the following format patterns (please see java.text.SimpleDateFormat and java.text.DecimalFormat for more information about meanings of letters used in the patterns):

Default format patterns described above can be customized or turned off, please see method definitions for more information.

When presented in HTML, hyperlinks can be assigned to either header cells or data cells with cell value substitutions supported. Cell value substitution is done by adding <ColumnName> keyword(s) to the URL string, where ColumnName is the name of the column defined in the data set. During grid generation, <ColumnName> is substituted to the cell value identified by the ColumnName.

Using the example given above, assuming the column names associated with header-1, header-2 and header-3 columns are column_1, column_2 and column_3 respectively. The invocation of this method:
      addHtmlDataLink("column_2", "http://www.company.com?type=any&c1=<column_1>&c2=<column_2>");
would create the following links on data cells displayed in the header-2 column, from top to bottom, as:
      http://www.company.com?type=any&c1=value+1-1&c2=value+1-2
      http://www.company.com?type=any&c1=value+2-1&c2=value+2-2
      http://www.company.com?type=any&c1=value+3-1&c2=value+3-2
      http://www.company.com?type=any&c1=value+4-1&c2=value+4-2
      http://www.company.com?type=any&c1=value+5-1&c2=value+5-2

When rendering in HTML, sorting icons can be displayed in those cells containing column headers if sorting specific hyperlinks are specified. The sorting hyperlinks can be defined by invoking addHtmlHeaderSortLink(String columnName, String url) or setHtmlDataColumnSortLink(String url), note that the former method only affects AQPivotDataSet while the latter method works on both AQDataSet and AQPivotDataSet. In addition, setHtmlDataColumnSortLink( ) supports more keyword substitutions than addHtmlHeaderSortLink( ) does; see setHtmlDataColumnSortLink( ) section below for details.

Sorting icons consist of a pair of up-arrow and down-arrow. Clicking the up-arrow will sort all of cell values in the containing column in ascending order if cells have not been sorted yet; if cells have been sorted in ascending order, clicking the up-arrow would change the order of cell values to the order they are originally defined. The color of the up-arrow icon used by the former case is lighter than the one used by the latter case. The down-arrow icon is represented and works the similar way as the up-arrow does. Keyword substitution is also supported on sorting hyperlinks by <AQSO> keyword, they are 3 cases:

Using the example given above, the invocation of this method:
      addHtmlHeaderSortLink("column_1", "http://www.company.com?name=column_1&sort=<AQSO>");
would attach the following links to the sorting icons if cell values contained in the column column_1 are not sorted yet:
      up-arrow icon: http://www.company.com?name=column_1&sort=1
      down-arrow icon: http://www.company.com?name=column_1&sort=-1
and would attach the following links to the sorting icons if cell values contained in the column column_1 are currently sorted in ascending order:
      up-arrow icon: http://www.company.com?name=column_1&sort=0
      down-arrow icon: http://www.company.com?name=column_1&sort=-1
and would attach the following links to the sorting icons if cell values contained in the column column_1 are currently sorted in descending order:
      up-arrow icon: http://www.company.com?name=column_1&sort=1
      down-arrow icon: http://www.company.com?name=column_1&sort=0

Additional keyword substitution on sorting hyperlinks is supported if the hyperlink is defined by setHtmlDataColumnSortLink(String). In such a case, the index of the column can be generated via <AQSID> keyword substitution, where index is zero-based.

For example, the invocation of this method:
      setHtmlDataColumnSortLink("http://www.company.com?order=<AQSO>&sid=<AQSID>");
would attach the following links to the sorting icons on the sixth data column if cell values contained in that column are not sorted yet:
      up-arrow icon: http://www.company.com?sort=1&sid=5
      down-arrow icon: http://www.company.com?sort=-1&sid=5

Method Summary
 void addCustomColumnDividerLocation(int location)
          Shows a column divider in front of the specified column.
 void addCustomColumnDividerLocations(int[] locations)
          Shows a column divider in front of the specified columns.
 void addCustomRowDivider(int rowIndex, String divider)
          Sets the character used to compose a row divider at the specified row.
 void addCustomRowDividerLocation(int location)
          Shows a row divider in front of the specified row.
 void addCustomRowDividerLocations(int[] locations)
          Shows a row divider in front of the specified rows.
 void addHtmlDataLink(int columnIndex, String url)
          Sets the URL link for the column data cells identified by the specified column index.
 void addHtmlDataLink(String columnName, String url)
          Sets the URL link for the column data cells identified by the specified column name.
 void addHtmlDataLinkByIndexes(int[] columnIndexes, String[] urlList)
          Sets the URL links for a list column data cells.
 void addHtmlDataLinkByNames(String[] columnNames, String[] urlList)
          Sets the URL links for a list column data cells.
 void addHtmlHeaderLink(int columnIndex, String url)
          Sets the URL link for the header cell identified by the specified column index.
 void addHtmlHeaderLink(String columnName, String url)
          Sets the URL link for the header cell identified by the specified column name.
 void addHtmlHeaderLinkByIndexes(int[] columnIndexes, String[] urlList)
          Sets the URL links for a list header cells.
 void addHtmlHeaderLinkByNames(String[] columnNames, String[] urlList)
          Sets the URL links for a list header cells.
 void addHtmlHeaderSortLink(int columnIndex, String url)
          Sets the sorting URL link for the header cell identified by the specified column index.
 void addHtmlHeaderSortLink(String columnName, String url)
          Sets the sorting URL link for the header cell identified by the specified column name.
 void addHtmlHeaderSortLinkByIndexes(int[] columnIndexes, String[] urlList)
          Sets the sorting URL links for a list header cells.
 void addHtmlHeaderSortLinkByNames(String[] columnNames, String[] urlList)
          Sets the sorting URL links for a list header cells.
 void clearColumnHeaderIndexes()
          Clears all of column headers created by using column indexes.
 void clearColumnHeaderNames()
          Clears all of custom column headers created by using column names.
 void clearColumnHeaders()
          Clears all of column headers, including both created by column indexes and by column names.
 void clearCustomColumnDividerLocations()
          Clears all of custom column divider settings.
 void clearCustomRowDividerLocations()
          Clears all of custom row divider settings.
 void clearCustomRowDividers()
          Clears all of custom row divider character settings.
 void clearHiddenColumnIndexes()
          Clears all of hidden columns tracked by column indexes.
 void clearHiddenColumnNames()
          Clears all of hidden columns tracked by column names.
 void clearHiddenColumns()
          Clears all of hidden columns, including both tracked by column indexes and by column names.
 void clearHtmlDataCellStyles()
          Clears custom CSS style settings for all of data cells.
 void clearHtmlDataColumnSortLink()
          Clears the sorting URL link associated with data column; this method is only applied to the data set derived from a pivot table.
 void clearHtmlDataLinkIndexes()
          Clears all of URL links associated with column data cells created by using column indexes.
 void clearHtmlDataLinkNames()
          Clears all of URL links associated with column data cells created by using column names.
 void clearHtmlDataLinks()
          Clears all of URL links associated with column data cells, including both created by column indexes and by column names.
 void clearHtmlHeaderLinkIndexes()
          Clears all of URL links associated with column headers created by using column indexes.
 void clearHtmlHeaderLinkNames()
          Clears all of URL links associated with column headers created by using column names.
 void clearHtmlHeaderLinks()
          Clears all of URL links associated with column headers, including both created by column indexes and by column names.
 void clearHtmlHeaderSortLinkIndexes()
          Clears all of sorting URL links associated with column headers created by using column indexes.
 void clearHtmlHeaderSortLinkNames()
          Clears all of sorting URL links associated with column headers created by using column names.
 void clearHtmlHeaderSortLinks()
          Clears all of sorting URL links associated with column headers, including both created by column indexes and by column names.
 String getAltRowBackgroundColorHexCode()
          Returns a hexadecimal color code representing the alternate row background color; see setAltRowBackgroundColor(String hexCode) for more information about hexadecimal color code.
 int getAltRowBackgroundColorRGB()
          Returns an integer value representing the alternate row background color; bits 16-23 are red, 8-15 are green, 0-7 are blue.
 String getAltRowForegroundColorHexCode()
          Returns a hexadecimal color code representing the alternate row foreground color; see setAltRowForegroundColor(String hexCode) for more information about hexadecimal color code.
 int getAltRowForegroundColorRGB()
          Returns an integer value representing the alternate row foreground color; bits 16-23 are red, 8-15 are green, 0-7 are blue.
 int getChartCacheTime()
          Returns the time period, in seconds, that the generated trend chart images for rows will be kept.
 String getColumnDateFormat(int index)
          Returns the date format pattern for the column identified by the specified index.
 String getColumnDateFormat(String name)
          Returns the date format pattern for the column identified by the specified name.
 String getColumnDateTimeFormat(int index)
          Returns the datetime format pattern for the column identified by the specified index.
 String getColumnDateTimeFormat(String name)
          Returns the datetime format pattern for the column identified by the specified name.
 String getColumnDivider()
          Returns the String representation of the character used to represent the column divider.
 int getColumnGap()
          Returns the width of the column gap divider.
 String getColumnGapDivider()
          Returns the String representation of the character used to represent the column gap divider.
 String getColumnHeader(int columnIndex)
          Returns the header of the column identified by the specified column index.
 String getColumnHeader(String columnName)
          Returns the header of the column identified by the specified column name.
 String getColumnNumericFormat(int index)
          Returns the numeric format pattern for the column identified by the specified index.
 String getColumnNumericFormat(String name)
          Returns the numeric format pattern for the column identified by the specified name.
 String getColumnTimeFormat(int index)
          Returns the time format pattern for the column identified by the specified index.
 String getColumnTimeFormat(String name)
          Returns the time format pattern for the column identified by the specified name.
 String getCustomRowDivider(int rowIndex)
          Returns the String representation of the character used to compose a row divider at the specified row.
 String getDateFormat()
          Returns the pattern used to format date values.
 String getDateTimeFormat()
          Returns the pattern used to format datetime values.
 String getFooter()
          Returns the footer text.
 String getFooterDivider()
          Returns the String representation of the character used to represent the footer divider.
 String getHeaderDivider()
          Returns the String representation of the character used to represent the header divider.
 List<Integer> getHiddenColumnIndexes()
          Returns the list of indexes tracked as hidden column indexes.
 List<String> getHiddenColumnNames()
          Returns the list of names tracked as hidden column names.
 String getHtmlDataCellStyle(int rowIndex, int columnIndex)
          Returns the custom CSS style associated with the specified data cell.
 String getHtmlDataColumnSortLink()
          Returns the sorting URL link associated with data column; this method is only applied to the data set derived from a pivot table.
 String getHtmlDataLink(int columnIndex)
          Returns the URL associated with the column data cells identified by the specified column index.
 String getHtmlDataLink(String columnName)
          Returns the URL associated with the column data cells identified by the specified column name.
 String getHtmlHeaderLink(int columnIndex)
          Returns the URL associated with the header cell identified by the specified column index.
 String getHtmlHeaderLink(String columnName)
          Returns the URL associated with the header cell identified by the specified column name.
 String getHtmlHeaderSortLink(int columnIndex)
          Returns the URL associated with the header cell identified by the specified column index.
 String getHtmlHeaderSortLink(String columnName)
          Returns the URL associated with the header cell identified by the specified column name.
 int getLineCount()
          Returns the maximum number of rows to be displayed.
 float getMaxColumnWidth()
          Returns the maximum column width, in unit of characters using default font.
 String getNumericFormat()
          Returns the pattern used to format numeric values.
 int getPageSize()
          Returns the preferred page size.
 String getPercentFormat()
          Returns the pattern used to format percentage values displayed in data cells.
 String getRowDivider()
          Returns the String representation of the character used to represent the row divider.
 String getRowNumberHeader()
          Returns the header text of the row number column.
 int getRowNumberStartRowIndex()
          Returns the row index from where the row number calculation to be started.
 int getRowTrendChartCacheTime()
          Returns the time period, in seconds, that the generated trend chart images for rows will be kept.
 String getTimeFormat()
          Returns the pattern used to format time values.
 String getTitle()
          Returns the title text.
 String getTitleDivider()
          Returns the String representation of the character used to represent the title divider.
 void hideColumn(int index)
          Sets the column identified by the specified column index as a hidden column.
 void hideColumn(String name)
          Sets the column identified by the specified column name as a hidden column.
 void hideColumnsByIndex(int[] indexes)
          Sets the columns identified by the specified column indexes as hidden columns.
 void hideColumnsByName(String[] names)
          Sets the columns identified by the specified column names as hidden columns.
 boolean isColumnDateFormatNone(int index)
          Returns true if formatting date values is not desired for the column identified by the specified index.
 boolean isColumnDateFormatNone(String name)
          Returns true if formatting date values is not desired for the column identified by the specified name.
 boolean isColumnDateTimeFormatNone(int index)
          Returns true if formatting datetime values is not desired for the column identified by the specified index.
 boolean isColumnDateTimeFormatNone(String name)
          Returns true if formatting datetime values is not desired for the column identified by the specified name.
 boolean isColumnNumericFormatNone(int index)
          Returns true if formatting numeric values is not desired for the column identified by the specified index.
 boolean isColumnNumericFormatNone(String name)
          Returns true if formatting numeric values is not desired for the column identified by the specified name.
 boolean isColumnTimeFormatNone(int index)
          Returns true if formatting time values is not desired for the column identified by the specified index.
 boolean isColumnTimeFormatNone(String name)
          Returns true if formatting time values is not desired for the column identified by the specified name.
 boolean isCustomColumnDividerLocation(int location)
          Returns true if the column divider to be displayed in front of the specified column.
 boolean isCustomRowDividerLocation(int location)
          Returns true if the row divider to be displayed in front of the specified row.
 boolean isDateFormatNone()
          Returns true if formatting date values is not desired.
 boolean isDateTimeFormatNone()
          Returns true if formatting datetime values is not desired.
 boolean isHiddenColumn(int index)
          Returns true if the column identified by the specified column index is a hidden column.
 boolean isHiddenColumn(String name)
          Returns true if the column identified by the specified column name is a hidden column.
 boolean isNumericFormatNone()
          Returns true if formatting numeric values is not desired.
 boolean isShowAdjustedRowNumberHeader()
          Returns true if the row number header to be shown at the adjusted location.
 boolean isShowAltRowColor()
          Returns true if rows are to be displayed in alternate colors.
 boolean isShowCellPercentageByColumn()
          Returns true if to show percentage value of each cell in the same column to the total value of the column.
 boolean isShowCellPercentageByRow()
          Returns true if to show percentage value of each cell in the same row to the total value of the row.
 boolean isShowFooter()
          Returns true if the footer text to be shown.
 boolean isShowFooterDivider()
          Returns true if the footer divider to be shown.
 boolean isShowHeader()
          Returns true if the header row to be shown.
 boolean isShowHeaderDivider()
          Returns true if the header divider to be shown.
 boolean isShowReportTime()
          Returns true if the report time to be shown.
 boolean isShowRowNumber()
          Returns true if the row number column to be shown.
 boolean isShowRowTrendChart()
          Returns true if to show trend charts for rows.
 boolean isShowTitle()
          Returns true if the title text to be shown.
 boolean isShowTitleDivider()
          Returns true if the title divider to be shown.
 boolean isTimeFormatNone()
          Returns true if formatting time values is not desired.
 void removeCustomColumnDividerLocation(int location)
          Hides the column divider corresponded to the specified column.
 void removeCustomColumnDividerLocations(int[] locations)
          Hides the column dividers corresponded to the specified columns.
 void removeCustomRowDivider(int rowIndex)
          Clears the custom row divider character at the specified row.
 void removeCustomRowDividerLocation(int location)
          Hides the row divider corresponded to the specified row.
 void removeCustomRowDividerLocations(int[] locations)
          Hides the row dividers corresponded to the specified rows.
 void removeHtmlDataLink(int columnIndex)
          Removes the URL link associated with the column data cells identified by the specified column index.
 void removeHtmlDataLink(String columnName)
          Removes the URL link associated with the column data cells identified by the specified column name.
 void removeHtmlHeaderLink(int columnIndex)
          Removes the URL link associated with the header cell identified by the specified column index.
 void removeHtmlHeaderLink(String columnName)
          Removes the URL link associated with the header cell identified by the specified column name.
 void removeHtmlHeaderSortLink(int columnIndex)
          Removes the sorting URL link associated with the header cell identified by the specified column index.
 void removeHtmlHeaderSortLink(String columnName)
          Removes the sorting URL link associated with the header cell identified by the specified column name.
 void setAltRowBackgroundColor(int red, int green, int blue)
          Sets alternate row background color with the specified red, green and blue values in the range (0 - 255).
 void setAltRowBackgroundColor(String hexCode)
          Sets alternate row background color with the specified hexadecimal color code.
 void setAltRowForegroundColor(int red, int green, int blue)
          Sets alternate row foreground color with the specified red, green and blue values in the range (0 - 255).
 void setAltRowForegroundColor(String hexCode)
          Sets alternate row foreground color with the specified hexadecimal color code.
 void setChartCacheTime(int cacheTime)
          Sets the time period, in seconds, that the generated chart images should be kept; default is 300 seconds.
 void setColumnDateFormat(int index, String pattern)
          Sets the date format pattern for the column identified by the specified index.
 void setColumnDateFormat(String name, String pattern)
          Sets the date format pattern for the column identified by the specified name.
 void setColumnDateFormatDefault(int index)
          Sets the date format pattern for the column identified by the specified index to system's default, i.e.
 void setColumnDateFormatDefault(String name)
          Sets the date format pattern for the column identified by the specified name to system's default, i.e.
 void setColumnDateFormatNone(int index)
          Requests to not formatting date values for the column identified by the specified index.
 void setColumnDateFormatNone(String name)
          Requests to not formatting date values for the column identified by the specified name.
 void setColumnDateTimeFormat(int index, String pattern)
          Sets the datetime format pattern for the column identified by the specified index.
 void setColumnDateTimeFormat(String name, String pattern)
          Sets the datetime format pattern for the column identified by the specified name.
 void setColumnDateTimeFormatDefault(int index)
          Sets the datetime format pattern for the column identified by the specified index to system's default, i.e.
 void setColumnDateTimeFormatDefault(String name)
          Sets the datetime format pattern for the column identified by the specified name to system's default, i.e.
 void setColumnDateTimeFormatNone(int index)
          Requests to not formatting datetime values for the column identified by the specified index.
 void setColumnDateTimeFormatNone(String name)
          Requests to not formatting datetime values for the column identified by the specified name.
 void setColumnDivider(String divider)
          Sets the character used to represent the column divider; vertical bar, '|', is used as default.
 void setColumnGap(int gap)
          Sets the width of the column gap divider, the default width is 2.
 void setColumnGapDivider(String divider)
          Sets the character used to represent the gap between columns; space character, '  ', is used as default.
 void setColumnHeader(int columnIndex, String columnHeader)
          Sets the header for the column identified by the specified column index.
 void setColumnHeader(String columnName, String columnHeader)
          Sets the header for the column identified by the specified column name.
 void setColumnHeaders(String[] columnHeaders)
          Sets the headers for a list of columns.
 void setColumnHeaders(String[] columnNames, String[] columnHeaders)
          Sets the headers for a list of columns.
 void setColumnNumericFormat(int index, String pattern)
          Sets the numeric format pattern for the column identified by the specified index.
 void setColumnNumericFormat(String name, String pattern)
          Sets the numeric format pattern for the column identified by the specified name.
 void setColumnNumericFormatDefault(int index)
          Sets the numeric format pattern for the column identified by the specified index to system's default, i.e.
 void setColumnNumericFormatDefault(String name)
          Sets the numeric format pattern for the column identified by the specified name to system's default, i.e.
 void setColumnNumericFormatNone(int index)
          Requests to not formatting numeric values for the column identified by the specified index.
 void setColumnNumericFormatNone(String name)
          Requests to not formatting numeric values for the column identified by the specified name.
 void setColumnTimeFormat(int index, String pattern)
          Sets the time format pattern for the column identified by the specified index.
 void setColumnTimeFormat(String name, String pattern)
          Sets the time format pattern for the column identified by the specified name.
 void setColumnTimeFormatDefault(int index)
          Sets the time format pattern for the column identified by the specified index to system's default, i.e.
 void setColumnTimeFormatDefault(String name)
          Sets the time format pattern for the column identified by the specified name to system's default, i.e.
 void setColumnTimeFormatNone(int index)
          Requests to not formatting time values for the column identified by the specified index.
 void setColumnTimeFormatNone(String name)
          Requests to not formatting time values for the column identified by the specified name.
 void setDateFormat(String pattern)
          Sets the pattern for formatting date values, 'M/d/yyyy' is used as default.
 void setDateFormatDefault()
          Sets the pattern for formatting date values to the default pattern.
 void setDateFormatNone()
          Requests to not formatting date values at all.
 void setDateTimeFormat(String pattern)
          Sets the pattern for formatting datetime values, 'M/d/yyyy h:mm:ss a' is used as default.
 void setDateTimeFormatDefault()
          Sets the pattern for formatting datetime values to the default pattern.
 void setDateTimeFormatNone()
          Requests to not formatting datetime values at all.
 void setFooter(String footer)
          Sets footer text.
 void setFooterDivider(String divider)
          Sets the character used to represent the footer divider; equals sign, '=', is used as default.
 void setHeaderDivider(String divider)
          Sets the character used to represent the header divider; equals sign, '=', is used as default.
 void setHtmlDataCellStyle(int rowIndex, int columnIndex, String cssStyle)
          Sets the custom CSS style for the specified data cell.
 void setHtmlDataColumnSortLink(String url)
          Sets the sorting URL link for data column; this method is only applied to the data set derived from a pivot table.
 void setLineCount(int lineCount)
          Sets the maximum number of rows to be displayed, a negative value means displaying all of rows contained in the data set.
 void setMaxColumnWidth(float width)
          Sets the maximum column width, in unit of characters using default font; this setting is only applied to saving grid to a Microsoft Excel file.
 void setNumericFormat(String pattern)
          Sets the pattern for formatting numeric values, '###0.############' is used as default.
 void setNumericFormatDefault()
          Sets the pattern for formatting numeric values to the default pattern.
 void setNumericFormatNone()
          Requests to not formatting numeric values at all.
 void setPageSize(int size)
          Sets the preferred page size; this setting is only applied to saving AQDataSet grid to a Microsoft Excel file.
 void setPercentFormat(String pattern)
          Sets the pattern for formatting percentage values displayed in data cells, '#,##0.##%' is used as default.
 void setRowDivider(String divider)
          Sets the character used to represent the row divider; hyphen, '-', is used as default.
 void setRowNumberHeader(String header)
          Set the header text for the row number column.
 void setRowNumberStartRowIndex(int index)
          Sets the row index from where the row number calculation to be started.
 void setRowTrendChartCacheTime(int cacheTime)
          Sets the time period, in seconds, that the generated trend chart images for rows should be kept; defaults to the value returned from getChartCacheTime().
 void setShowAdjustedRowNumberHeader(boolean flag)
          Shows or hides the row number header at the adjusted location.
 void setShowAltRowColor(boolean flag)
          Displays rows in alternate colors if set to true.
 void setShowCellPercentageByColumn(boolean flag)
          Shows or hides percentage value of each cell in the same column to the total value of the column.
 void setShowCellPercentageByRow(boolean flag)
          Shows or hides percentage value of each cell in the same row to the total value of the row.
 void setShowFooter(boolean showFooter)
          Shows or hides the footer text.
 void setShowFooterDivider(boolean showFooterDivider)
          Shows or hides the footer divider.
 void setShowHeader(boolean showHeader)
          Shows or hides the header row.
 void setShowHeaderDivider(boolean showHeaderDivider)
          Shows or hides the header divider.
 void setShowReportTime(boolean showReportTime)
          Shows or hides the report time.
 void setShowRowNumber(boolean showRowNumber)
          Shows or hides the row number column.
 void setShowRowTrendChart(boolean flag)
          Shows or hides trend charts for rows; a row based trend chart is a chart created using data values retrieved from the same row on a grid.
 void setShowTitle(boolean showTitle)
          Shows or hides the title text.
 void setShowTitleDivider(boolean showTitleDivider)
          Shows or hides the title divider.
 void setTimeFormat(String pattern)
          Sets the pattern for formatting time values, 'h:mm:ss a' is used as default.
 void setTimeFormatDefault()
          Sets the pattern for formatting time values to the default pattern.
 void setTimeFormatNone()
          Requests to not formatting time values at all.
 void setTitle(String title)
          Sets title text.
 void setTitleDivider(String divider)
          Sets the character used to represent the title divider; equals sign, '=', is used as default.
 void showColumn(int index)
          Sets the column identified by the specified column index as a non-hidden column.
 void showColumn(String name)
          Sets the column identified by the specified column name as a non-hidden column.
 void showColumnsByIndex(int[] indexes)
          Sets the columns identified by the specified column indexes as non-hidden columns.
 void showColumnsByName(String[] names)
          Sets the columns identified by the specified column names as non-hidden columns.
 

Method Detail

setTitleDivider

void setTitleDivider(String divider)
Sets the character used to represent the title divider; equals sign, '=', is used as default. Note that the title divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getTitleDivider

String getTitleDivider()
Returns the String representation of the character used to represent the title divider.

Returns:
the String representation of the character used to represent the title divider.

setHeaderDivider

void setHeaderDivider(String divider)
Sets the character used to represent the header divider; equals sign, '=', is used as default. Note that the header divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getHeaderDivider

String getHeaderDivider()
Returns the String representation of the character used to represent the header divider.

Returns:
the String representation of the character used to represent the header divider.

setRowDivider

void setRowDivider(String divider)
Sets the character used to represent the row divider; hyphen, '-', is used as default. Row dividers are not displayed by default, and can be enabled by calling addCustomRowDividerLocation(int location) or addCustomRowDividerLocations(int[] locations). Note that the row divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getRowDivider

String getRowDivider()
Returns the String representation of the character used to represent the row divider.

Returns:
the String representation of the character used to represent the row divider.

setColumnDivider

void setColumnDivider(String divider)
Sets the character used to represent the column divider; vertical bar, '|', is used as default. Column dividers are not displayed by default, and can be enabled by calling addCustomColumnDividerLocation(int location) or addCustomColumnDividerLocations(int[] locations). Note that the column divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getColumnDivider

String getColumnDivider()
Returns the String representation of the character used to represent the column divider.

Returns:
the String representation of the character used to represent the column divider.

setFooterDivider

void setFooterDivider(String divider)
Sets the character used to represent the footer divider; equals sign, '=', is used as default. Note that the footer divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getFooterDivider

String getFooterDivider()
Returns the String representation of the character used to represent the footer divider.

Returns:
the String representation of the character used to represent the footer divider.

setColumnGapDivider

void setColumnGapDivider(String divider)
Sets the character used to represent the gap between columns; space character, '  ', is used as default. Note that the column gap divider is only applicable to a plain text grid.

Parameters:
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getColumnGapDivider

String getColumnGapDivider()
Returns the String representation of the character used to represent the column gap divider.

Returns:
the String representation of the character used to represent the column gap divider.

setColumnGap

void setColumnGap(int gap)
Sets the width of the column gap divider, the default width is 2. See setColumnGapDivider(String divider) for more information about column gap divider.

Parameters:
gap - the desired width, the width of the column gap is reset to default if the specified gap is less than zero

getColumnGap

int getColumnGap()
Returns the width of the column gap divider. See setColumnGapDivider(String divider) for more information about column gap divider.

Returns:
the width of the column gap divider.

setShowTitle

void setShowTitle(boolean showTitle)
Shows or hides the title text.

Parameters:
showTitle - shows title text if set to true

isShowTitle

boolean isShowTitle()
Returns true if the title text to be shown.

Returns:
true if the title text to be shown

setShowTitleDivider

void setShowTitleDivider(boolean showTitleDivider)
Shows or hides the title divider.

Parameters:
showTitleDivider - shows title divider if set to true

isShowTitleDivider

boolean isShowTitleDivider()
Returns true if the title divider to be shown.

Returns:
true if the title divider to be shown

setShowReportTime

void setShowReportTime(boolean showReportTime)
Shows or hides the report time.

Parameters:
showReportTime - shows report time if set to true

isShowReportTime

boolean isShowReportTime()
Returns true if the report time to be shown.

Returns:
true if the report time to be shown

setShowHeader

void setShowHeader(boolean showHeader)
Shows or hides the header row.

Parameters:
showHeader - shows header row if set to true

isShowHeader

boolean isShowHeader()
Returns true if the header row to be shown.

Returns:
true if the header row to be shown

setShowHeaderDivider

void setShowHeaderDivider(boolean showHeaderDivider)
Shows or hides the header divider.

Parameters:
showHeaderDivider - shows header divider if set to true

isShowHeaderDivider

boolean isShowHeaderDivider()
Returns true if the header divider to be shown.

Returns:
true if the header divider to be shown

setShowFooter

void setShowFooter(boolean showFooter)
Shows or hides the footer text.

Parameters:
showFooter - shows footer text if set to true

isShowFooter

boolean isShowFooter()
Returns true if the footer text to be shown.

Returns:
true if the footer text to be shown

setShowFooterDivider

void setShowFooterDivider(boolean showFooterDivider)
Shows or hides the footer divider.

Parameters:
showFooterDivider - shows footer divider if set to true

isShowFooterDivider

boolean isShowFooterDivider()
Returns true if the footer divider to be shown.

Returns:
true if the footer divider to be shown

setShowRowNumber

void setShowRowNumber(boolean showRowNumber)
Shows or hides the row number column.

Parameters:
showRowNumber - shows row number column if set to true

isShowRowNumber

boolean isShowRowNumber()
Returns true if the row number column to be shown.

Returns:
true if the row number column to be shown

setTitle

void setTitle(String title)
Sets title text.

Parameters:
title - the title text

getTitle

String getTitle()
Returns the title text.

Returns:
the title text.

setFooter

void setFooter(String footer)
Sets footer text.

Parameters:
footer - the footer text

getFooter

String getFooter()
Returns the footer text.

Returns:
the footer text.

setLineCount

void setLineCount(int lineCount)
Sets the maximum number of rows to be displayed, a negative value means displaying all of rows contained in the data set. If lineCount is non-negative and the number of rows contained in the data set is greater than lineCount, only the first lineCount rows are displayed.

Parameters:
lineCount - the maximum number of rows to display

getLineCount

int getLineCount()
Returns the maximum number of rows to be displayed.

Returns:
the maximum number of rows to be displayed

setRowNumberHeader

void setRowNumberHeader(String header)
Set the header text for the row number column.

Parameters:
header - the header text

getRowNumberHeader

String getRowNumberHeader()
Returns the header text of the row number column.

Returns:
the header text of the row number column

setRowNumberStartRowIndex

void setRowNumberStartRowIndex(int index)
Sets the row index from where the row number calculation to be started. The numbers displayed in the row number column are generated and the row number calculation starts from the very first row by default.

Parameters:
index - the row index from where the row number calculation to be started; note that index is zero-based.

getRowNumberStartRowIndex

int getRowNumberStartRowIndex()
Returns the row index from where the row number calculation to be started.

Returns:
the row index from where the row number calculation to be started

setShowAdjustedRowNumberHeader

void setShowAdjustedRowNumberHeader(boolean flag)
Shows or hides the row number header at the adjusted location. If setRowNumberStartRowIndex(index) is used to customize the row number calculation, the row number header can be placed at the (index - 1)th grid cell if desired.

Parameters:
flag - shows row number header at the adjusted location if set to true

isShowAdjustedRowNumberHeader

boolean isShowAdjustedRowNumberHeader()
Returns true if the row number header to be shown at the adjusted location.

Returns:
true if the row number header to be shown at the adjusted location

clearColumnHeaders

void clearColumnHeaders()
Clears all of column headers, including both created by column indexes and by column names.

clearColumnHeaderIndexes

void clearColumnHeaderIndexes()
Clears all of column headers created by using column indexes.

Custom headers created via setColumnHeader(int columnIndex, String columnHeader) and setColumnHeaders(String[] columnHeaders) are cleared by this method.

setColumnHeader

void setColumnHeader(int columnIndex,
                     String columnHeader)
Sets the header for the column identified by the specified column index.

Header created by this method will be overridden by setColumnHeader(String columnName, String columnHeader) or setColumnHeaders(String[] columnNames, String[] columnHeaders) if they point to the same column.

Parameters:
columnIndex - the index to identify the column of interest
columnHeader - the custom column header

setColumnHeaders

void setColumnHeaders(String[] columnHeaders)
Sets the headers for a list of columns. The indexes of the specified columnHeaders array are mapped to the indexes of the columns contained in the data set; for each index, setColumnHeader(index, columnHeaders[index]) is called to set up the desired column header.

Headers created by this method will be overridden by setColumnHeader(String columnName, String columnHeader) or setColumnHeaders(String[] columnNames, String[] columnHeaders) if they point to the same columns.

Parameters:
columnHeaders - the list of column headers

getColumnHeader

String getColumnHeader(int columnIndex)
Returns the header of the column identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest
Returns:
the header of the column

clearColumnHeaderNames

void clearColumnHeaderNames()
Clears all of custom column headers created by using column names.

Custom headers created via setColumnHeader(String columnName, String columnHeader) and setColumnHeaders(String[] columnNames, String[] columnHeaders) are cleared by this method.

setColumnHeader

void setColumnHeader(String columnName,
                     String columnHeader)
Sets the header for the column identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
columnHeader - the custom column header

setColumnHeaders

void setColumnHeaders(String[] columnNames,
                      String[] columnHeaders)
Sets the headers for a list of columns. The elements contained in columnNames array and columnHeaders array should have a one-to-one mapping relationship. For each paired name and header, setColumnHeader(name, header) is called to set up the desired column header.

Parameters:
columnNames - the list of column names
columnHeaders - the list of column headers

getColumnHeader

String getColumnHeader(String columnName)
Returns the header of the column identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
Returns:
the header of the column

clearCustomRowDividers

void clearCustomRowDividers()
Clears all of custom row divider character settings.

addCustomRowDivider

void addCustomRowDivider(int rowIndex,
                         String divider)
Sets the character used to compose a row divider at the specified row. Note that specifying a custom row divider character will not draw the divider at the specified row automatically. To draw a divider at the specified row, addCustomRowDividerLocation(int location) needs to be called.

Parameters:
rowIndex - the row index
divider - the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is zero

getCustomRowDivider

String getCustomRowDivider(int rowIndex)
Returns the String representation of the character used to compose a row divider at the specified row.

Parameters:
rowIndex - the row index
Returns:
the custom row divider or null if the custom row divider is not defined at the specified row

removeCustomRowDivider

void removeCustomRowDivider(int rowIndex)
Clears the custom row divider character at the specified row.

Parameters:
rowIndex - the row index

clearCustomRowDividerLocations

void clearCustomRowDividerLocations()
Clears all of custom row divider settings.

isCustomRowDividerLocation

boolean isCustomRowDividerLocation(int location)
Returns true if the row divider to be displayed in front of the specified row.

Parameters:
location - the row index
Returns:
true if the row divider to be displayed

addCustomRowDividerLocation

void addCustomRowDividerLocation(int location)
Shows a row divider in front of the specified row. The character used to draw the divider can be customized by addCustomRowDivider(int rowIndex, String divider), the default divider is used if no custom divider being set.

Parameters:
location - the row index

addCustomRowDividerLocations

void addCustomRowDividerLocations(int[] locations)
Shows a row divider in front of the specified rows. The character used to draw the divider can be customized by addCustomRowDivider(int rowIndex, String divider), the default divider is used if no custom divider being set.

Parameters:
locations - the list of row indexes

removeCustomRowDividerLocation

void removeCustomRowDividerLocation(int location)
Hides the row divider corresponded to the specified row.

Parameters:
location - the row index

removeCustomRowDividerLocations

void removeCustomRowDividerLocations(int[] locations)
Hides the row dividers corresponded to the specified rows.

Parameters:
locations - the list of row indexes

clearCustomColumnDividerLocations

void clearCustomColumnDividerLocations()
Clears all of custom column divider settings.

isCustomColumnDividerLocation

boolean isCustomColumnDividerLocation(int location)
Returns true if the column divider to be displayed in front of the specified column.

Parameters:
location - the column index
Returns:
true if the column divider to be displayed

addCustomColumnDividerLocation

void addCustomColumnDividerLocation(int location)
Shows a column divider in front of the specified column. The character used to draw the divider can be customized by setColumnDivider(String divider), the default divider is used if no custom divider being set.

Parameters:
location - the column index

addCustomColumnDividerLocations

void addCustomColumnDividerLocations(int[] locations)
Shows a column divider in front of the specified columns. The character used to draw the divider can be customized by setColumnDivider(String divider), the default divider is used if no custom divider being set.

Parameters:
locations - the list of column indexes

removeCustomColumnDividerLocation

void removeCustomColumnDividerLocation(int location)
Hides the column divider corresponded to the specified column.

Parameters:
location - the column index

removeCustomColumnDividerLocations

void removeCustomColumnDividerLocations(int[] locations)
Hides the column dividers corresponded to the specified columns.

Parameters:
locations - the list of column indexes

clearHiddenColumns

void clearHiddenColumns()
Clears all of hidden columns, including both tracked by column indexes and by column names.

clearHiddenColumnIndexes

void clearHiddenColumnIndexes()
Clears all of hidden columns tracked by column indexes.

Hidden columns created via hideColumn(int index) and hideColumnsByIndex(int[] indexes) are cleared by this method.

isHiddenColumn

boolean isHiddenColumn(int index)
Returns true if the column identified by the specified column index is a hidden column.

Returns:
true if the column identified by the specified column index is a hidden column

hideColumn

void hideColumn(int index)
Sets the column identified by the specified column index as a hidden column.

Parameters:
index - the column index

hideColumnsByIndex

void hideColumnsByIndex(int[] indexes)
Sets the columns identified by the specified column indexes as hidden columns.

Parameters:
indexes - the list of column indexes

showColumn

void showColumn(int index)
Sets the column identified by the specified column index as a non-hidden column.

Parameters:
index - the column index

showColumnsByIndex

void showColumnsByIndex(int[] indexes)
Sets the columns identified by the specified column indexes as non-hidden columns.

Parameters:
indexes - the list of column indexes

getHiddenColumnIndexes

List<Integer> getHiddenColumnIndexes()
Returns the list of indexes tracked as hidden column indexes.

Returns:
the list of column indexes.

clearHiddenColumnNames

void clearHiddenColumnNames()
Clears all of hidden columns tracked by column names.

Hidden columns created via hideColumn(String name) and hideColumnsByName(String[] names) are cleared by this method.

isHiddenColumn

boolean isHiddenColumn(String name)
Returns true if the column identified by the specified column name is a hidden column.

Returns:
true if the column identified by the specified column name is a hidden column

hideColumn

void hideColumn(String name)
Sets the column identified by the specified column name as a hidden column.

Parameters:
name - the column name

hideColumnsByName

void hideColumnsByName(String[] names)
Sets the columns identified by the specified column names as hidden columns.

Parameters:
names - the list of column names

showColumn

void showColumn(String name)
Sets the column identified by the specified column name as a non-hidden column.

Parameters:
name - the column name

showColumnsByName

void showColumnsByName(String[] names)
Sets the columns identified by the specified column names as non-hidden columns.

Parameters:
names - the list of column names

getHiddenColumnNames

List<String> getHiddenColumnNames()
Returns the list of names tracked as hidden column names.

Returns:
the list of column names.

setNumericFormat

void setNumericFormat(String pattern)
                      throws Exception
Sets the pattern for formatting numeric values, '###0.############' is used as default.

Parameters:
pattern - the format pattern
Throws:
Exception - if the specified pattern is not a valid format pattern

setNumericFormatDefault

void setNumericFormatDefault()
Sets the pattern for formatting numeric values to the default pattern.

setNumericFormatNone

void setNumericFormatNone()
Requests to not formatting numeric values at all.

getNumericFormat

String getNumericFormat()
Returns the pattern used to format numeric values. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isNumericFormatNone() should be consulted for further clarification.

Returns:
the pattern used to format numeric values

isNumericFormatNone

boolean isNumericFormatNone()
Returns true if formatting numeric values is not desired.

Returns:
true if formatting numeric values is not desired

setDateFormat

void setDateFormat(String pattern)
                   throws Exception
Sets the pattern for formatting date values, 'M/d/yyyy' is used as default.

Parameters:
pattern - the format pattern
Throws:
Exception - if the specified pattern is not a valid format pattern

setDateFormatDefault

void setDateFormatDefault()
Sets the pattern for formatting date values to the default pattern.

setDateFormatNone

void setDateFormatNone()
Requests to not formatting date values at all.

getDateFormat

String getDateFormat()
Returns the pattern used to format date values. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isDateFormatNone() should be consulted for further clarification.

Returns:
the pattern used to format date values

isDateFormatNone

boolean isDateFormatNone()
Returns true if formatting date values is not desired.

Returns:
true if formatting date values is not desired

setDateTimeFormat

void setDateTimeFormat(String pattern)
                       throws Exception
Sets the pattern for formatting datetime values, 'M/d/yyyy h:mm:ss a' is used as default.

Parameters:
pattern - the format pattern
Throws:
Exception - if the specified pattern is not a valid format pattern

setDateTimeFormatDefault

void setDateTimeFormatDefault()
Sets the pattern for formatting datetime values to the default pattern.

setDateTimeFormatNone

void setDateTimeFormatNone()
Requests to not formatting datetime values at all.

getDateTimeFormat

String getDateTimeFormat()
Returns the pattern used to format datetime values. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isDateTimeFormatNone() should be consulted for further clarification.

Returns:
the pattern used to format datetime values

isDateTimeFormatNone

boolean isDateTimeFormatNone()
Returns true if formatting datetime values is not desired.

Returns:
true if formatting datetime values is not desired

setTimeFormat

void setTimeFormat(String pattern)
                   throws Exception
Sets the pattern for formatting time values, 'h:mm:ss a' is used as default.

Parameters:
pattern - the format pattern
Throws:
Exception - if the specified pattern is not a valid format pattern

setTimeFormatDefault

void setTimeFormatDefault()
Sets the pattern for formatting time values to the default pattern.

setTimeFormatNone

void setTimeFormatNone()
Requests to not formatting time values at all.

getTimeFormat

String getTimeFormat()
Returns the pattern used to format time values. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isTimeFormatNone() should be consulted for further clarification.

Returns:
the pattern used to format time values

isTimeFormatNone

boolean isTimeFormatNone()
Returns true if formatting time values is not desired.

Returns:
true if formatting time values is not desired

setPercentFormat

void setPercentFormat(String pattern)
                      throws Exception
Sets the pattern for formatting percentage values displayed in data cells, '#,##0.##%' is used as default. setShowCellPercentageByColumn(boolean flag) and setShowCellPercentageByRow(boolean flag) provide control on displaying percentage values in data cells.

Parameters:
pattern - the format pattern
Throws:
Exception - if the specified pattern is not a valid format pattern

getPercentFormat

String getPercentFormat()
Returns the pattern used to format percentage values displayed in data cells. Null is returned if custom pattern is not.

Returns:
the pattern used to format percentage values

setColumnNumericFormat

void setColumnNumericFormat(String name,
                            String pattern)
                            throws Exception
Sets the numeric format pattern for the column identified by the specified name. Please note that column name which is an empty string has special meanings and is reserved for system use. When formatting a AQPivotDataSet, if there are no data fields defined, the column name which is an empty string is used to specify the numeric format pattern for all of pivot data cells and grand total cells.

Parameters:
name - the column name
pattern - the format pattern
Throws:
Exception - if the specified name is null or the specified pattern is invalid

setColumnNumericFormatDefault

void setColumnNumericFormatDefault(String name)
Sets the numeric format pattern for the column identified by the specified name to system's default, i.e. the pattern returned by getNumericFormat(). Please note that column name which is an empty string has special meaning, see setColumnNumericFormat(String name, String pattern) for details.

Parameters:
name - the column name

setColumnNumericFormatNone

void setColumnNumericFormatNone(String name)
Requests to not formatting numeric values for the column identified by the specified name. Please note that column name which is an empty string has special meaning, see setColumnNumericFormat(String name, String pattern) for details.

Parameters:
name - the column name

getColumnNumericFormat

String getColumnNumericFormat(String name)
Returns the numeric format pattern for the column identified by the specified name. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnNumericFormatNone(String name) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getNumericFormat() is called to determine the pattern to be used. Please note that column name which is an empty string has special meaning, see setColumnNumericFormat(String name, String pattern) for details.

Parameters:
name - the column name
Returns:
the pattern used to format numeric values

isColumnNumericFormatNone

boolean isColumnNumericFormatNone(String name)
Returns true if formatting numeric values is not desired for the column identified by the specified name. Please note that column name which is an empty string has special meaning, see setColumnNumericFormat(String name, String pattern) for details.

Parameters:
name - the column name
Returns:
true if formatting numeric values is not desired

setColumnDateFormat

void setColumnDateFormat(String name,
                         String pattern)
                         throws Exception
Sets the date format pattern for the column identified by the specified name.

Parameters:
name - the column name
pattern - the format pattern
Throws:
Exception - if the specified name is null or the specified pattern is invalid

setColumnDateFormatDefault

void setColumnDateFormatDefault(String name)
Sets the date format pattern for the column identified by the specified name to system's default, i.e. the pattern returned by getDateFormat().

Parameters:
name - the column name

setColumnDateFormatNone

void setColumnDateFormatNone(String name)
Requests to not formatting date values for the column identified by the specified name.

Parameters:
name - the column name

getColumnDateFormat

String getColumnDateFormat(String name)
Returns the date format pattern for the column identified by the specified name. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnDateFormatNone(String name) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getDateFormat() is called to determine the pattern to be used.

Parameters:
name - the column name
Returns:
the pattern used to format date values

isColumnDateFormatNone

boolean isColumnDateFormatNone(String name)
Returns true if formatting date values is not desired for the column identified by the specified name.

Parameters:
name - the column name
Returns:
true if formatting date values is not desired

setColumnDateTimeFormat

void setColumnDateTimeFormat(String name,
                             String pattern)
                             throws Exception
Sets the datetime format pattern for the column identified by the specified name.

Parameters:
name - the column name
pattern - the format pattern
Throws:
Exception - if the specified name is null or the specified pattern is invalid

setColumnDateTimeFormatDefault

void setColumnDateTimeFormatDefault(String name)
Sets the datetime format pattern for the column identified by the specified name to system's default, i.e. the pattern returned by getDateTimeFormat().

Parameters:
name - the column name

setColumnDateTimeFormatNone

void setColumnDateTimeFormatNone(String name)
Requests to not formatting datetime values for the column identified by the specified name.

Parameters:
name - the column name

getColumnDateTimeFormat

String getColumnDateTimeFormat(String name)
Returns the datetime format pattern for the column identified by the specified name. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnDateTimeFormatNone(String name) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getDateTimeFormat() is called to determine the pattern to be used.

Parameters:
name - the column name
Returns:
the pattern used to format datetime values

isColumnDateTimeFormatNone

boolean isColumnDateTimeFormatNone(String name)
Returns true if formatting datetime values is not desired for the column identified by the specified name.

Parameters:
name - the column name
Returns:
true if formatting datetime values is not desired

setColumnTimeFormat

void setColumnTimeFormat(String name,
                         String pattern)
                         throws Exception
Sets the time format pattern for the column identified by the specified name.

Parameters:
name - the column name
pattern - the format pattern
Throws:
Exception - if the specified name is null or the specified pattern is invalid

setColumnTimeFormatDefault

void setColumnTimeFormatDefault(String name)
Sets the time format pattern for the column identified by the specified name to system's default, i.e. the pattern returned by getTimeFormat().

Parameters:
name - the column name

setColumnTimeFormatNone

void setColumnTimeFormatNone(String name)
Requests to not formatting time values for the column identified by the specified name.

Parameters:
name - the column name

getColumnTimeFormat

String getColumnTimeFormat(String name)
Returns the time format pattern for the column identified by the specified name. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnTimeFormatNone(String name) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getTimeFormat() is called to determine the pattern to be used.

Parameters:
name - the column name
Returns:
the pattern used to format time values

isColumnTimeFormatNone

boolean isColumnTimeFormatNone(String name)
Returns true if formatting time values is not desired for the column identified by the specified name.

Parameters:
name - the column name
Returns:
true if formatting time values is not desired

setColumnNumericFormat

void setColumnNumericFormat(int index,
                            String pattern)
                            throws Exception
Sets the numeric format pattern for the column identified by the specified index.

Parameters:
index - the column index
pattern - the format pattern
Throws:
Exception - if the specified pattern is invalid

setColumnNumericFormatDefault

void setColumnNumericFormatDefault(int index)
Sets the numeric format pattern for the column identified by the specified index to system's default, i.e. the pattern returned by getNumericFormat().

Parameters:
index - the column index

setColumnNumericFormatNone

void setColumnNumericFormatNone(int index)
Requests to not formatting numeric values for the column identified by the specified index.

Parameters:
index - the column index

getColumnNumericFormat

String getColumnNumericFormat(int index)
Returns the numeric format pattern for the column identified by the specified index. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnNumericFormatNone(int index) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getNumericFormat() is called to determine the pattern to be used.

Parameters:
index - the column index
Returns:
the pattern used to format numeric values

isColumnNumericFormatNone

boolean isColumnNumericFormatNone(int index)
Returns true if formatting numeric values is not desired for the column identified by the specified index.

Parameters:
index - the column index
Returns:
true if formatting numeric values is not desired

setColumnDateFormat

void setColumnDateFormat(int index,
                         String pattern)
                         throws Exception
Sets the date format pattern for the column identified by the specified index.

Parameters:
index - the column index
pattern - the format pattern
Throws:
Exception - if the specified pattern is invalid

setColumnDateFormatDefault

void setColumnDateFormatDefault(int index)
Sets the date format pattern for the column identified by the specified index to system's default, i.e. the pattern returned by getDateFormat().

Parameters:
index - the column index

setColumnDateFormatNone

void setColumnDateFormatNone(int index)
Requests to not formatting date values for the column identified by the specified index.

Parameters:
index - the column index

getColumnDateFormat

String getColumnDateFormat(int index)
Returns the date format pattern for the column identified by the specified index. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnDateFormatNone(int index) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getDateFormat() is called to determine the pattern to be used.

Parameters:
index - the column index
Returns:
the pattern used to format date values

isColumnDateFormatNone

boolean isColumnDateFormatNone(int index)
Returns true if formatting date values is not desired for the column identified by the specified index.

Parameters:
index - the column index
Returns:
true if formatting date values is not desired

setColumnDateTimeFormat

void setColumnDateTimeFormat(int index,
                             String pattern)
                             throws Exception
Sets the datetime format pattern for the column identified by the specified index.

Parameters:
index - the column index
pattern - the format pattern
Throws:
Exception - if the specified pattern is invalid

setColumnDateTimeFormatDefault

void setColumnDateTimeFormatDefault(int index)
Sets the datetime format pattern for the column identified by the specified index to system's default, i.e. the pattern returned by getDateTimeFormat().

Parameters:
index - the column index

setColumnDateTimeFormatNone

void setColumnDateTimeFormatNone(int index)
Requests to not formatting datetime values for the column identified by the specified index.

Parameters:
index - the column index

getColumnDateTimeFormat

String getColumnDateTimeFormat(int index)
Returns the datetime format pattern for the column identified by the specified index. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnDateTimeFormatNone(int index) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getDateTimeFormat() is called to determine the pattern to be used.

Parameters:
index - the column index
Returns:
the pattern used to format datetime values

isColumnDateTimeFormatNone

boolean isColumnDateTimeFormatNone(int index)
Returns true if formatting datetime values is not desired for the column identified by the specified index.

Parameters:
index - the column index
Returns:
true if formatting datetime values is not desired

setColumnTimeFormat

void setColumnTimeFormat(int index,
                         String pattern)
                         throws Exception
Sets the time format pattern for the column identified by the specified index.

Parameters:
index - the column index
pattern - the format pattern
Throws:
Exception - if the specified pattern is invalid

setColumnTimeFormatDefault

void setColumnTimeFormatDefault(int index)
Sets the time format pattern for the column identified by the specified index to system's default, i.e. the pattern returned by getTimeFormat().

Parameters:
index - the column index

setColumnTimeFormatNone

void setColumnTimeFormatNone(int index)
Requests to not formatting time values for the column identified by the specified index.

Parameters:
index - the column index

getColumnTimeFormat

String getColumnTimeFormat(int index)
Returns the time format pattern for the column identified by the specified index. Null is returned if either custom pattern is not set or formatting is not desired; in such a case, isColumnTimeFormatNone(int index) should be consulted for further clarification. If custom pattern is not set and formatting is desired, getTimeFormat() is called to determine the pattern to be used.

Parameters:
index - the column index
Returns:
the pattern used to format time values

isColumnTimeFormatNone

boolean isColumnTimeFormatNone(int index)
Returns true if formatting time values is not desired for the column identified by the specified index.

Parameters:
index - the column index
Returns:
true if formatting time values is not desired

clearHtmlHeaderLinks

void clearHtmlHeaderLinks()
Clears all of URL links associated with column headers, including both created by column indexes and by column names.

clearHtmlHeaderLinkIndexes

void clearHtmlHeaderLinkIndexes()
Clears all of URL links associated with column headers created by using column indexes.

Links created via addHtmlHeaderLink(int columnIndex, String url) and addHtmlHeaderLinkByIndexes(int[] columnIndexes, String[] urlList) are cleared by this method.

addHtmlHeaderLink

void addHtmlHeaderLink(int columnIndex,
                       String url)
Sets the URL link for the header cell identified by the specified column index.

Link created by this method will be overridden by addHtmlHeaderLink(String columnName, String url) or addHtmlHeaderLinkByNames(String[] columnNames, String[] urlList) if they point to the same column.

Parameters:
columnIndex - the index to identify the column of interest
url - the URL

addHtmlHeaderLinkByIndexes

void addHtmlHeaderLinkByIndexes(int[] columnIndexes,
                                String[] urlList)
Sets the URL links for a list header cells. The elements contained in columnIndexes array and urlList array should have a one-to-one mapping relationship. For each paired index and URL, addHtmlHeaderLink(index, URL) is called to set up the desired header link.

Links created by this method will be overridden by addHtmlHeaderLink(String columnName, String url) or addHtmlHeaderLinkByNames(String[] columnNames, String[] urlList) if they point to the same columns.

Parameters:
columnIndexes - the list of column indexes
urlList - the list of URL links

removeHtmlHeaderLink

void removeHtmlHeaderLink(int columnIndex)
Removes the URL link associated with the header cell identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest

getHtmlHeaderLink

String getHtmlHeaderLink(int columnIndex)
Returns the URL associated with the header cell identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest
Returns:
the URL, or null if header link is not defined

clearHtmlHeaderLinkNames

void clearHtmlHeaderLinkNames()
Clears all of URL links associated with column headers created by using column names.

Links created via addHtmlHeaderLink(String columnName, String url) and addHtmlHeaderLinkByNames(String[] columnNames, String[] urlList) are cleared by this method.

addHtmlHeaderLink

void addHtmlHeaderLink(String columnName,
                       String url)
Sets the URL link for the header cell identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
url - the URL

addHtmlHeaderLinkByNames

void addHtmlHeaderLinkByNames(String[] columnNames,
                              String[] urlList)
Sets the URL links for a list header cells. The elements contained in columnNames array and urlList array should have a one-to-one mapping relationship. For each paired name and URL, addHtmlHeaderLink(name, URL) is called to set up the desired header link.

Parameters:
columnNames - the list of column names
urlList - the list of URL links

removeHtmlHeaderLink

void removeHtmlHeaderLink(String columnName)
Removes the URL link associated with the header cell identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest

getHtmlHeaderLink

String getHtmlHeaderLink(String columnName)
Returns the URL associated with the header cell identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
Returns:
the URL, or null if header link is not defined

clearHtmlDataLinks

void clearHtmlDataLinks()
Clears all of URL links associated with column data cells, including both created by column indexes and by column names.

clearHtmlDataLinkIndexes

void clearHtmlDataLinkIndexes()
Clears all of URL links associated with column data cells created by using column indexes. *

Links created via addHtmlDataLink(int columnIndex, String url) and addHtmlDataLinkByIndexes(int[] columnIndexes, String[] urlList) are cleared by this method.

addHtmlDataLink

void addHtmlDataLink(int columnIndex,
                     String url)
Sets the URL link for the column data cells identified by the specified column index.

Link created by this method will be overridden by addHtmlDataLink(String columnName, String url) or addHtmlDataLinkByNames(String[] columnNames, String[] urlList) if they point to the same column.

Parameters:
columnIndex - the index to identify the column of interest
url - the URL

addHtmlDataLinkByIndexes

void addHtmlDataLinkByIndexes(int[] columnIndexes,
                              String[] urlList)
Sets the URL links for a list column data cells. The elements contained in columnIndexes array and urlList array should have a one-to-one mapping relationship. For each paired index and URL, addHtmlDataLink(index, URL) is called to set up the desired data cell link.

Links created by this method will be overridden by addHtmlDataLink(String columnName, String url) or addHtmlDataLinkByNames(String[] columnNames, String[] urlList) if they point to the same columns.

Parameters:
columnIndexes - the list of column indexes
urlList - the list of URL links

removeHtmlDataLink

void removeHtmlDataLink(int columnIndex)
Removes the URL link associated with the column data cells identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest

getHtmlDataLink

String getHtmlDataLink(int columnIndex)
Returns the URL associated with the column data cells identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest
Returns:
the URL, or null if data link is not defined

clearHtmlDataLinkNames

void clearHtmlDataLinkNames()
Clears all of URL links associated with column data cells created by using column names.

Links created via addHtmlDataLink(String columnName, String url) and addHtmlDataLinkByNames(String[] columnNames, String[] urlList) are cleared by this method.

addHtmlDataLink

void addHtmlDataLink(String columnName,
                     String url)
Sets the URL link for the column data cells identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
url - the URL

addHtmlDataLinkByNames

void addHtmlDataLinkByNames(String[] columnNames,
                            String[] urlList)
Sets the URL links for a list column data cells. The elements contained in columnNames array and urlList array should have a one-to-one mapping relationship. For each paired name and URL, addHtmlDataLink(name, URL) is called to set up the desired data cell link.

Parameters:
columnNames - the list of column names
urlList - the list of URL links

removeHtmlDataLink

void removeHtmlDataLink(String columnName)
Removes the URL link associated with the column data cells identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest

getHtmlDataLink

String getHtmlDataLink(String columnName)
Returns the URL associated with the column data cells identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
Returns:
the URL, or null if data link is not defined

clearHtmlHeaderSortLinks

void clearHtmlHeaderSortLinks()
Clears all of sorting URL links associated with column headers, including both created by column indexes and by column names.

clearHtmlHeaderSortLinkIndexes

void clearHtmlHeaderSortLinkIndexes()
Clears all of sorting URL links associated with column headers created by using column indexes.

Links created via addHtmlHeaderSortLink(int columnIndex, String url) and addHtmlHeaderSortLinkByIndexes(int[] columnIndexes, String[] urlList) are cleared by this method.

addHtmlHeaderSortLink

void addHtmlHeaderSortLink(int columnIndex,
                           String url)
Sets the sorting URL link for the header cell identified by the specified column index. Note that this method only affects the data set generated from the AQPivotDataSet.

Link created by this method will be overridden by addHtmlHeaderSortLink(String columnName, String url) or addHtmlHeaderSortLinkByNames(String[] columnNames, String[] urlList) if they point to the same column.

Parameters:
columnIndex - the index to identify the column of interest
url - the URL

addHtmlHeaderSortLinkByIndexes

void addHtmlHeaderSortLinkByIndexes(int[] columnIndexes,
                                    String[] urlList)
Sets the sorting URL links for a list header cells. The elements contained in columnIndexes array and urlList array should have a one-to-one mapping relationship. For each paired index and URL, addHtmlHeaderSortLink(index, URL) is called to set up the desired header link. Note that this method only affects the data set generated from the AQPivotDataSet.

Links created by this method will be overridden by addHtmlHeaderSortLink(String columnName, String url) or addHtmlHeaderSortLinkByNames(String[] columnNames, String[] urlList) if they point to the same columns.

Parameters:
columnIndexes - the list of column indexes
urlList - the list of URL links

removeHtmlHeaderSortLink

void removeHtmlHeaderSortLink(int columnIndex)
Removes the sorting URL link associated with the header cell identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest

getHtmlHeaderSortLink

String getHtmlHeaderSortLink(int columnIndex)
Returns the URL associated with the header cell identified by the specified column index.

Parameters:
columnIndex - the index to identify the column of interest
Returns:
the URL, or null if header link is not defined

clearHtmlHeaderSortLinkNames

void clearHtmlHeaderSortLinkNames()
Clears all of sorting URL links associated with column headers created by using column names.

Links created via addHtmlHeaderSortLink(String columnName, String url) and addHtmlHeaderSortLinkByNames(String[] columnNames, String[] urlList) are cleared by this method.

addHtmlHeaderSortLink

void addHtmlHeaderSortLink(String columnName,
                           String url)
Sets the sorting URL link for the header cell identified by the specified column name. Note that this method only affects the data set generated from the AQPivotDataSet.

Parameters:
columnName - the name to identify the column of interest
url - the URL

addHtmlHeaderSortLinkByNames

void addHtmlHeaderSortLinkByNames(String[] columnNames,
                                  String[] urlList)
Sets the sorting URL links for a list header cells. The elements contained in columnNames array and urlList array should have a one-to-one mapping relationship. For each paired name and URL, addHtmlHeaderSortLink(name, URL) is called to set up the desired header link. Note that this method only affects the data set generated from the AQPivotDataSet.

Parameters:
columnNames - the list of column names
urlList - the list of URL links

removeHtmlHeaderSortLink

void removeHtmlHeaderSortLink(String columnName)
Removes the sorting URL link associated with the header cell identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest

getHtmlHeaderSortLink

String getHtmlHeaderSortLink(String columnName)
Returns the URL associated with the header cell identified by the specified column name.

Parameters:
columnName - the name to identify the column of interest
Returns:
the URL, or null if header link is not defined

setHtmlDataColumnSortLink

void setHtmlDataColumnSortLink(String url)
Sets the sorting URL link for data column; this method is only applied to the data set derived from a pivot table.

Parameters:
url - the URL

getHtmlDataColumnSortLink

String getHtmlDataColumnSortLink()
Returns the sorting URL link associated with data column; this method is only applied to the data set derived from a pivot table.

Returns:
the sorting URL, or null if link is not defined

clearHtmlDataColumnSortLink

void clearHtmlDataColumnSortLink()
Clears the sorting URL link associated with data column; this method is only applied to the data set derived from a pivot table.

clearHtmlDataCellStyles

void clearHtmlDataCellStyles()
Clears custom CSS style settings for all of data cells.

setHtmlDataCellStyle

void setHtmlDataCellStyle(int rowIndex,
                          int columnIndex,
                          String cssStyle)
Sets the custom CSS style for the specified data cell.

Parameters:
rowIndex - the row index of the data cell
columnIndex - the column index of the data cell
cssStyle - the column CSS style

getHtmlDataCellStyle

String getHtmlDataCellStyle(int rowIndex,
                            int columnIndex)
Returns the custom CSS style associated with the specified data cell.

Parameters:
rowIndex - the row index of the data cell
columnIndex - the column index of the data cell
Returns:
the CSS style, or null if the custom style is not defined

setShowRowTrendChart

void setShowRowTrendChart(boolean flag)
Shows or hides trend charts for rows; a row based trend chart is a chart created using data values retrieved from the same row on a grid. This method only takes effect on rendering data set in HTML created from pivot table.

Parameters:
flag - shows trend charts for rows if set to true

isShowRowTrendChart

boolean isShowRowTrendChart()
Returns true if to show trend charts for rows.

Returns:
true if to show trend charts for rows.

setRowTrendChartCacheTime

void setRowTrendChartCacheTime(int cacheTime)
                               throws Exception
Sets the time period, in seconds, that the generated trend chart images for rows should be kept; defaults to the value returned from getChartCacheTime(). When row based trend chart is enabled, the generated chart images will be stored in an image cache for access. These images will be removed from the cache after the specified time has passed, and hence are no longer accessible.

Parameters:
cacheTime - the time period, in seconds, that images should be kept
Throws:
Exception - if the specified time period is less than or equal to zero

getRowTrendChartCacheTime

int getRowTrendChartCacheTime()
Returns the time period, in seconds, that the generated trend chart images for rows will be kept.

setChartCacheTime

void setChartCacheTime(int cacheTime)
                       throws Exception
Sets the time period, in seconds, that the generated chart images should be kept; default is 300 seconds. When chart is enabled, the generated chart images will be stored in an image cache for access. These images will be removed from the cache after the specified time has passed, and hence are no longer accessible.

Parameters:
cacheTime - the time period, in seconds, that images should be kept
Throws:
Exception - if the specified time period is less than or equal to zero

getChartCacheTime

int getChartCacheTime()
Returns the time period, in seconds, that the generated trend chart images for rows will be kept.

setShowCellPercentageByRow

void setShowCellPercentageByRow(boolean flag)
Shows or hides percentage value of each cell in the same row to the total value of the row. This method only takes effect on rendering data set in HTML created from pivot table. The percentage value is displayed as tooltip when mouse-over the cell contents. Row based percentage value has a ">" prefix when displayed.

Parameters:
flag - shows percentage value for cells if set to true, default is set to true

isShowCellPercentageByRow

boolean isShowCellPercentageByRow()
Returns true if to show percentage value of each cell in the same row to the total value of the row. This method only takes effect on rendering data set in HTML created from pivot table. Please see setShowCellPercentageByRow(boolean flag) for more information.

Returns:
true if to show percentage value of each cell in the same row to the total value of the row.

setShowCellPercentageByColumn

void setShowCellPercentageByColumn(boolean flag)
Shows or hides percentage value of each cell in the same column to the total value of the column. This method only takes effect on rendering data set in HTML created from pivot table. The percentage value is displayed as tooltip when mouse-over the cell contents. Column based percentage value has a "^" prefix when displayed.

Parameters:
flag - shows percentage value for cells if set to true, default is set to true

isShowCellPercentageByColumn

boolean isShowCellPercentageByColumn()
Returns true if to show percentage value of each cell in the same column to the total value of the column. This method only takes effect on rendering data set in HTML created from pivot table. Please see setShowCellPercentageByColumn(boolean flag) for more information.

Returns:
true if to show percentage value of each cell in the same column to the total value of the column.

setShowAltRowColor

void setShowAltRowColor(boolean flag)
Displays rows in alternate colors if set to true. This method only takes effect on rendering data set in HTML or saving data set to an Excel file.

Parameters:
flag - displays rows in alternate colors if true, default is set to true

isShowAltRowColor

boolean isShowAltRowColor()
Returns true if rows are to be displayed in alternate colors.

Returns:
true if rows are to be displayed in alternate colors.

setAltRowBackgroundColor

void setAltRowBackgroundColor(int red,
                              int green,
                              int blue)
Sets alternate row background color with the specified red, green and blue values in the range (0 - 255). The default background color is set to (238, 238, 238). This method only takes effect on rendering data set in HTML or saving data set to an Excel file.

Parameters:
red - the red component
green - the green component
blue - the blue component

setAltRowBackgroundColor

void setAltRowBackgroundColor(String hexCode)
Sets alternate row background color with the specified hexadecimal color code. A hexadecimal color code is a six-digit, three-byte hexadecimal number with each byte represents a number in the range 00 to FF; an optional hash (#) character can be placed in front of the color code. This method only takes effect on rendering data set in HTML or saving data set to an Excel file.

Parameters:
hexCode - the background color in hexadecimal notation, default is set to EEEEEE

getAltRowBackgroundColorRGB

int getAltRowBackgroundColorRGB()
Returns an integer value representing the alternate row background color; bits 16-23 are red, 8-15 are green, 0-7 are blue.

Returns:
an integer value representing the alternate row background color

getAltRowBackgroundColorHexCode

String getAltRowBackgroundColorHexCode()
Returns a hexadecimal color code representing the alternate row background color; see setAltRowBackgroundColor(String hexCode) for more information about hexadecimal color code.

Returns:
a hexadecimal color code representing the alternate row background color, a hash (#) is always placed in front of the returned color code

setAltRowForegroundColor

void setAltRowForegroundColor(int red,
                              int green,
                              int blue)
Sets alternate row foreground color with the specified red, green and blue values in the range (0 - 255). The default foreground color is black, i.e. (0, 0, 0). This method only takes effect on rendering data set in HTML.

Parameters:
red - the red component
green - the green component
blue - the blue component

setAltRowForegroundColor

void setAltRowForegroundColor(String hexCode)
Sets alternate row foreground color with the specified hexadecimal color code. A hexadecimal color code is a six-digit, three-byte hexadecimal number with each byte represents a number in the range 00 to FF; an optional hash (#) character can be placed in front of the color code. This method only takes effect on rendering data set in HTML.

Parameters:
hexCode - the foreground color in hexadecimal notation, default is set to 000000.

getAltRowForegroundColorRGB

int getAltRowForegroundColorRGB()
Returns an integer value representing the alternate row foreground color; bits 16-23 are red, 8-15 are green, 0-7 are blue.

Returns:
an integer value representing the alternate row foreground color

getAltRowForegroundColorHexCode

String getAltRowForegroundColorHexCode()
Returns a hexadecimal color code representing the alternate row foreground color; see setAltRowForegroundColor(String hexCode) for more information about hexadecimal color code.

Returns:
a hexadecimal color code representing the alternate row foreground color, a hash (#) is always placed in front of the returned color code

setPageSize

void setPageSize(int size)
Sets the preferred page size; this setting is only applied to saving AQDataSet grid to a Microsoft Excel file. The page size indicates how many rows to put on each Excel worksheet. If a data set contains 95 rows, then saving it to Excel with page size set to 10 will create an Excel file with 10 worksheets, with 10 rows on each of the first 9 worksheets and 5 rows on the last worksheet.

The default page size is set to the maximum number of rows a Excel worksheet can display. Note that when saving a AQPivotDataSet to Excel, the worksheet representing the AQDataSet from which the pivot table is derived will be affected by this method but the worksheet representing the pivot table is not; the pivot table is always displayed in one and only one worksheet in the current implementation.

Parameters:
size - the preferred page size, the default value is used if size is less than or equal to zero

getPageSize

int getPageSize()
Returns the preferred page size.

Returns:
the preferred page size

setMaxColumnWidth

void setMaxColumnWidth(float width)
Sets the maximum column width, in unit of characters using default font; this setting is only applied to saving grid to a Microsoft Excel file.

When saving grid to Excel, the width of column is set to display data entirely by default. Application can use this method to set the limit of the width on all columns.

Parameters:
width - the maximum column width, the default setting is used if width is less than or equal to zero

getMaxColumnWidth

float getMaxColumnWidth()
Returns the maximum column width, in unit of characters using default font.

Returns:
the maximum column width
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
OpenAPI 1.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.