public interface AQDataSetSettings
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:
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):
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:
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
Modifier and Type | Method and Description |
---|---|
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,
java.lang.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,
java.lang.String url)
Sets the URL link for the column data cells identified by the specified column index.
|
void |
addHtmlDataLink(java.lang.String columnName,
java.lang.String url)
Sets the URL link for the column data cells identified by the specified column name.
|
void |
addHtmlDataLinkByIndexes(int[] columnIndexes,
java.lang.String[] urlList)
Sets the URL links for a list column data cells.
|
void |
addHtmlDataLinkByNames(java.lang.String[] columnNames,
java.lang.String[] urlList)
Sets the URL links for a list column data cells.
|
void |
addHtmlHeaderLink(int columnIndex,
java.lang.String url)
Sets the URL link for the header cell identified by the specified column index.
|
void |
addHtmlHeaderLink(java.lang.String columnName,
java.lang.String url)
Sets the URL link for the header cell identified by the specified column name.
|
void |
addHtmlHeaderLinkByIndexes(int[] columnIndexes,
java.lang.String[] urlList)
Sets the URL links for a list header cells.
|
void |
addHtmlHeaderLinkByNames(java.lang.String[] columnNames,
java.lang.String[] urlList)
Sets the URL links for a list header cells.
|
void |
addHtmlHeaderSortLink(int columnIndex,
java.lang.String url)
Sets the sorting URL link for the header cell identified by the specified column index.
|
void |
addHtmlHeaderSortLink(java.lang.String columnName,
java.lang.String url)
Sets the sorting URL link for the header cell identified by the specified column name.
|
void |
addHtmlHeaderSortLinkByIndexes(int[] columnIndexes,
java.lang.String[] urlList)
Sets the sorting URL links for a list header cells.
|
void |
addHtmlHeaderSortLinkByNames(java.lang.String[] columnNames,
java.lang.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.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getColumnBackgroundColorHexCode(int index)
Returns a hexadecimal color code representing the background color for the column identified by the specified index
|
java.lang.String |
getColumnBackgroundColorHexCode(java.lang.String name)
Returns a hexadecimal color code representing the background color for the column identified by the specified name
|
int |
getColumnBackgroundColorRGB(int index)
Returns an integer value representing the background color for the column identified by the specified index;
bits 16-23 are red, 8-15 are green, 0-7 are blue.
|
int |
getColumnBackgroundColorRGB(java.lang.String name)
Returns an integer value representing the background color for the column identified by the specified name;
bits 16-23 are red, 8-15 are green, 0-7 are blue.
|
java.lang.String |
getColumnDateFormat(int index)
Returns the date format pattern for the column identified by the specified index.
|
java.lang.String |
getColumnDateFormat(java.lang.String name)
Returns the date format pattern for the column identified by the specified name.
|
java.lang.String |
getColumnDateTimeFormat(int index)
Returns the datetime format pattern for the column identified by the specified index.
|
java.lang.String |
getColumnDateTimeFormat(java.lang.String name)
Returns the datetime format pattern for the column identified by the specified name.
|
java.lang.String |
getColumnDivider()
Returns the String representation of the character used to represent the column divider.
|
java.lang.String |
getColumnForegroundColorHexCode(int index)
Returns a hexadecimal color code representing the foreground color for the column identified by the specified index
|
java.lang.String |
getColumnForegroundColorHexCode(java.lang.String name)
Returns a hexadecimal color code representing the foreground color for the column identified by the specified name
|
int |
getColumnForegroundColorRGB(int index)
Returns an integer value representing the foreground color for the column identified by the specified index;
bits 16-23 are red, 8-15 are green, 0-7 are blue.
|
int |
getColumnForegroundColorRGB(java.lang.String name)
Returns an integer value representing the foreground color for the column identified by the specified name;
bits 16-23 are red, 8-15 are green, 0-7 are blue.
|
int |
getColumnGap()
Returns the width of the column gap divider.
|
java.lang.String |
getColumnGapDivider()
Returns the String representation of the character used to represent the column gap divider.
|
java.lang.String |
getColumnHeader(int columnIndex)
Returns the header of the column identified by the specified column index.
|
java.lang.String |
getColumnHeader(java.lang.String columnName)
Returns the header of the column identified by the specified column name.
|
java.lang.String |
getColumnNumericFormat(int index)
Returns the numeric format pattern for the column identified by the specified index.
|
java.lang.String |
getColumnNumericFormat(java.lang.String name)
Returns the numeric format pattern for the column identified by the specified name.
|
java.lang.String |
getColumnTimeFormat(int index)
Returns the time format pattern for the column identified by the specified index.
|
java.lang.String |
getColumnTimeFormat(java.lang.String name)
Returns the time format pattern for the column identified by the specified name.
|
java.lang.String |
getCustomRowDivider(int rowIndex)
Returns the String representation of the character used to compose a row divider at the specified row.
|
java.lang.String |
getDateFormat()
Returns the pattern used to format date values.
|
java.lang.String |
getDateTimeFormat()
Returns the pattern used to format datetime values.
|
java.lang.String |
getFooter()
Returns the footer text.
|
java.lang.String |
getFooterDivider()
Returns the String representation of the character used to represent the footer divider.
|
java.lang.String |
getHeaderDivider()
Returns the String representation of the character used to represent the header divider.
|
java.util.List<java.lang.Integer> |
getHiddenColumnIndexes()
Returns the list of indexes tracked as hidden column indexes.
|
java.util.List<java.lang.String> |
getHiddenColumnNames()
Returns the list of names tracked as hidden column names.
|
java.lang.String |
getHtmlDataCellStyle(int rowIndex,
int columnIndex)
Returns the custom CSS style associated with the specified data cell.
|
java.lang.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.
|
java.lang.String |
getHtmlDataLink(int columnIndex)
Returns the URL associated with the column data cells identified by the specified column index.
|
java.lang.String |
getHtmlDataLink(java.lang.String columnName)
Returns the URL associated with the column data cells identified by the specified column name.
|
java.lang.String |
getHtmlHeaderLink(int columnIndex)
Returns the URL associated with the header cell identified by the specified column index.
|
java.lang.String |
getHtmlHeaderLink(java.lang.String columnName)
Returns the URL associated with the header cell identified by the specified column name.
|
java.lang.String |
getHtmlHeaderSortLink(int columnIndex)
Returns the URL associated with the header cell identified by the specified column index.
|
java.lang.String |
getHtmlHeaderSortLink(java.lang.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.
|
java.lang.String |
getNumericFormat()
Returns the pattern used to format numeric values.
|
int |
getPageSize()
Returns the preferred page size.
|
java.lang.String |
getPercentFormat()
Returns the pattern used to format percentage values displayed in data cells.
|
java.lang.String |
getRowDivider()
Returns the String representation of the character used to represent the row divider.
|
java.lang.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.
|
java.lang.String |
getTimeFormat()
Returns the pattern used to format time values.
|
java.lang.String |
getTitle()
Returns the title text.
|
java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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 |
setColumnBackgroundColor(int index,
int red,
int green,
int blue)
Sets the background color for the column identified by the specified index.
|
void |
setColumnBackgroundColor(int index,
java.lang.String hexCode)
Sets the background hexadecimal color code for the column identified by the specified index.
|
void |
setColumnBackgroundColor(java.lang.String name,
int red,
int green,
int blue)
Sets the background color for the column identified by the specified name.
|
void |
setColumnBackgroundColor(java.lang.String name,
java.lang.String hexCode)
Sets the background hexadecimal color code for the column identified by the specified name.
|
void |
setColumnDateFormat(int index,
java.lang.String pattern)
Sets the date format pattern for the column identified by the specified index.
|
void |
setColumnDateFormat(java.lang.String name,
java.lang.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(java.lang.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(java.lang.String name)
Requests to not formatting date values for the column identified by the specified name.
|
void |
setColumnDateTimeFormat(int index,
java.lang.String pattern)
Sets the datetime format pattern for the column identified by the specified index.
|
void |
setColumnDateTimeFormat(java.lang.String name,
java.lang.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(java.lang.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(java.lang.String name)
Requests to not formatting datetime values for the column identified by the specified name.
|
void |
setColumnDivider(java.lang.String divider)
Sets the character used to represent the column divider; vertical bar, '|', is used as default.
|
void |
setColumnForegroundColor(int index,
int red,
int green,
int blue)
Sets the foreground color for the column identified by the specified index.
|
void |
setColumnForegroundColor(int index,
java.lang.String hexCode)
Sets the foreground hexadecimal color code for the column identified by the specified index.
|
void |
setColumnForegroundColor(java.lang.String name,
int red,
int green,
int blue)
Sets the foreground color for the column identified by the specified name.
|
void |
setColumnForegroundColor(java.lang.String name,
java.lang.String hexCode)
Sets the foreground hexadecimal color code for the column identified by the specified name.
|
void |
setColumnGap(int gap)
Sets the width of the column gap divider, the default width is 2.
|
void |
setColumnGapDivider(java.lang.String divider)
Sets the character used to represent the gap between columns; space character, ' ', is used as default.
|
void |
setColumnHeader(int columnIndex,
java.lang.String columnHeader)
Sets the header for the column identified by the specified column index.
|
void |
setColumnHeader(java.lang.String columnName,
java.lang.String columnHeader)
Sets the header for the column identified by the specified column name.
|
void |
setColumnHeaders(java.lang.String[] columnHeaders)
Sets the headers for a list of columns.
|
void |
setColumnHeaders(java.lang.String[] columnNames,
java.lang.String[] columnHeaders)
Sets the headers for a list of columns.
|
void |
setColumnNumericFormat(int index,
java.lang.String pattern)
Sets the numeric format pattern for the column identified by the specified index.
|
void |
setColumnNumericFormat(java.lang.String name,
java.lang.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(java.lang.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(java.lang.String name)
Requests to not formatting numeric values for the column identified by the specified name.
|
void |
setColumnTimeFormat(int index,
java.lang.String pattern)
Sets the time format pattern for the column identified by the specified index.
|
void |
setColumnTimeFormat(java.lang.String name,
java.lang.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(java.lang.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(java.lang.String name)
Requests to not formatting time values for the column identified by the specified name.
|
void |
setDateFormat(java.lang.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(java.lang.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(java.lang.String footer)
Sets footer text.
|
void |
setFooterDivider(java.lang.String divider)
Sets the character used to represent the footer divider; equals sign, '=', is used as default.
|
void |
setHeaderDivider(java.lang.String divider)
Sets the character used to represent the header divider; equals sign, '=', is used as default.
|
void |
setHtmlDataCellStyle(int rowIndex,
int columnIndex,
java.lang.String cssStyle)
Sets the custom CSS style for the specified data cell.
|
void |
setHtmlDataColumnSortLink(java.lang.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(java.lang.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(java.lang.String pattern)
Sets the pattern for formatting percentage values displayed in data cells, '#,##0.##%' is used as default.
|
void |
setRowDivider(java.lang.String divider)
Sets the character used to represent the row divider; hyphen, '-', is used as default.
|
void |
setRowNumberHeader(java.lang.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(java.lang.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(java.lang.String title)
Sets title text.
|
void |
setTitleDivider(java.lang.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(java.lang.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(java.lang.String[] names)
Sets the columns identified by the specified column names as non-hidden columns.
|
void setTitleDivider(java.lang.String divider)
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
zerojava.lang.String getTitleDivider()
void setHeaderDivider(java.lang.String divider)
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
zerojava.lang.String getHeaderDivider()
void setRowDivider(java.lang.String divider)
addCustomRowDividerLocation(int location)
or
addCustomRowDividerLocations(int[] locations)
.
Note that the row divider is only applicable to a plain text grid.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
zerojava.lang.String getRowDivider()
void setColumnDivider(java.lang.String divider)
addCustomColumnDividerLocation(int location)
or
addCustomColumnDividerLocations(int[] locations)
.
Note that the column divider is only applicable to a plain text grid.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
zerojava.lang.String getColumnDivider()
void setFooterDivider(java.lang.String divider)
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
zerojava.lang.String getFooterDivider()
void setColumnGapDivider(java.lang.String divider)
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
zerojava.lang.String getColumnGapDivider()
void setColumnGap(int gap)
setColumnGapDivider(String divider)
for more information about column gap divider.gap
- the desired width, the width of the column gap is reset to default if the specified gap
is less than zeroint getColumnGap()
setColumnGapDivider(String divider)
for more information about column gap divider.void setShowTitle(boolean showTitle)
showTitle
- shows title text if set to trueboolean isShowTitle()
void setShowTitleDivider(boolean showTitleDivider)
showTitleDivider
- shows title divider if set to trueboolean isShowTitleDivider()
void setShowReportTime(boolean showReportTime)
showReportTime
- shows report time if set to trueboolean isShowReportTime()
void setShowHeader(boolean showHeader)
showHeader
- shows header row if set to trueboolean isShowHeader()
void setShowHeaderDivider(boolean showHeaderDivider)
showHeaderDivider
- shows header divider if set to trueboolean isShowHeaderDivider()
void setShowFooter(boolean showFooter)
showFooter
- shows footer text if set to trueboolean isShowFooter()
void setShowFooterDivider(boolean showFooterDivider)
showFooterDivider
- shows footer divider if set to trueboolean isShowFooterDivider()
void setShowRowNumber(boolean showRowNumber)
showRowNumber
- shows row number column if set to trueboolean isShowRowNumber()
void setTitle(java.lang.String title)
title
- the title textjava.lang.String getTitle()
void setFooter(java.lang.String footer)
footer
- the footer textjava.lang.String getFooter()
void setLineCount(int lineCount)
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.lineCount
- the maximum number of rows to displayint getLineCount()
void setRowNumberHeader(java.lang.String header)
header
- the header textjava.lang.String getRowNumberHeader()
void setRowNumberStartRowIndex(int index)
index
- the row index from where the row number calculation to be
started; note that index is zero-based.int getRowNumberStartRowIndex()
void setShowAdjustedRowNumberHeader(boolean flag)
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.flag
- shows row number header at the adjusted location if set to trueboolean isShowAdjustedRowNumberHeader()
void clearColumnHeaders()
void clearColumnHeaderIndexes()
Custom headers created via setColumnHeader(int columnIndex, String columnHeader)
and setColumnHeaders(String[] columnHeaders)
are cleared by this method.
void setColumnHeader(int columnIndex, java.lang.String columnHeader)
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.
columnIndex
- the index to identify the column of interestcolumnHeader
- the custom column headervoid setColumnHeaders(java.lang.String[] columnHeaders)
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.
columnHeaders
- the list of column headersjava.lang.String getColumnHeader(int columnIndex)
columnIndex
- the index to identify the column of interestvoid clearColumnHeaderNames()
Custom headers created via setColumnHeader(String columnName, String columnHeader)
and setColumnHeaders(String[] columnNames, String[] columnHeaders)
are cleared by this method.
void setColumnHeader(java.lang.String columnName, java.lang.String columnHeader)
columnName
- the name to identify the column of interestcolumnHeader
- the custom column headervoid setColumnHeaders(java.lang.String[] columnNames, java.lang.String[] columnHeaders)
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.columnNames
- the list of column namescolumnHeaders
- the list of column headersjava.lang.String getColumnHeader(java.lang.String columnName)
columnName
- the name to identify the column of interestvoid clearCustomRowDividers()
void addCustomRowDivider(int rowIndex, java.lang.String divider)
addCustomRowDividerLocation(int location)
needs to be called.rowIndex
- the row indexdivider
- the String representation of the divider, only the first character is used as the divider; default divider is used if null or length is
zerojava.lang.String getCustomRowDivider(int rowIndex)
rowIndex
- the row indexvoid removeCustomRowDivider(int rowIndex)
rowIndex
- the row indexvoid clearCustomRowDividerLocations()
boolean isCustomRowDividerLocation(int location)
location
- the row indexvoid addCustomRowDividerLocation(int location)
addCustomRowDivider(int rowIndex, String divider)
,
the default divider is used if no custom divider being set.location
- the row indexvoid addCustomRowDividerLocations(int[] locations)
addCustomRowDivider(int rowIndex, String divider)
,
the default divider is used if no custom divider being set.locations
- the list of row indexesvoid removeCustomRowDividerLocation(int location)
location
- the row indexvoid removeCustomRowDividerLocations(int[] locations)
locations
- the list of row indexesvoid clearCustomColumnDividerLocations()
boolean isCustomColumnDividerLocation(int location)
location
- the column indexvoid addCustomColumnDividerLocation(int location)
setColumnDivider(String divider)
,
the default divider is used if no custom divider being set.location
- the column indexvoid addCustomColumnDividerLocations(int[] locations)
setColumnDivider(String divider)
,
the default divider is used if no custom divider being set.locations
- the list of column indexesvoid removeCustomColumnDividerLocation(int location)
location
- the column indexvoid removeCustomColumnDividerLocations(int[] locations)
locations
- the list of column indexesvoid clearHiddenColumns()
void clearHiddenColumnIndexes()
Hidden columns created via hideColumn(int index)
and hideColumnsByIndex(int[] indexes)
are cleared by this method.
boolean isHiddenColumn(int index)
index
- the column indexvoid hideColumn(int index)
index
- the column indexvoid hideColumnsByIndex(int[] indexes)
indexes
- the list of column indexesvoid showColumn(int index)
index
- the column indexvoid showColumnsByIndex(int[] indexes)
indexes
- the list of column indexesjava.util.List<java.lang.Integer> getHiddenColumnIndexes()
void clearHiddenColumnNames()
Hidden columns created via hideColumn(String name)
and hideColumnsByName(String[] names)
are cleared by this method.
boolean isHiddenColumn(java.lang.String name)
name
- the column namevoid hideColumn(java.lang.String name)
name
- the column namevoid hideColumnsByName(java.lang.String[] names)
names
- the list of column namesvoid showColumn(java.lang.String name)
name
- the column namevoid showColumnsByName(java.lang.String[] names)
names
- the list of column namesjava.util.List<java.lang.String> getHiddenColumnNames()
void setNumericFormat(java.lang.String pattern) throws java.lang.Exception
pattern
- the format patternjava.lang.Exception
- if the specified pattern is not a valid format patternvoid setNumericFormatDefault()
void setNumericFormatNone()
java.lang.String getNumericFormat()
isNumericFormatNone()
should be consulted for further clarification.boolean isNumericFormatNone()
void setDateFormat(java.lang.String pattern) throws java.lang.Exception
pattern
- the format patternjava.lang.Exception
- if the specified pattern is not a valid format patternvoid setDateFormatDefault()
void setDateFormatNone()
java.lang.String getDateFormat()
isDateFormatNone()
should be consulted for further clarification.boolean isDateFormatNone()
void setDateTimeFormat(java.lang.String pattern) throws java.lang.Exception
pattern
- the format patternjava.lang.Exception
- if the specified pattern is not a valid format patternvoid setDateTimeFormatDefault()
void setDateTimeFormatNone()
java.lang.String getDateTimeFormat()
isDateTimeFormatNone()
should be consulted for further clarification.boolean isDateTimeFormatNone()
void setTimeFormat(java.lang.String pattern) throws java.lang.Exception
pattern
- the format patternjava.lang.Exception
- if the specified pattern is not a valid format patternvoid setTimeFormatDefault()
void setTimeFormatNone()
java.lang.String getTimeFormat()
isTimeFormatNone()
should be consulted for further clarification.boolean isTimeFormatNone()
void setPercentFormat(java.lang.String pattern) throws java.lang.Exception
setShowCellPercentageByColumn(boolean flag)
and setShowCellPercentageByRow(boolean flag)
provide control on displaying percentage values in data cells.pattern
- the format patternjava.lang.Exception
- if the specified pattern is not a valid format patternjava.lang.String getPercentFormat()
void setColumnNumericFormat(java.lang.String name, java.lang.String pattern) throws java.lang.Exception
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.name
- the column namepattern
- the format patternjava.lang.Exception
- if the specified name is null or the specified pattern is invalidvoid setColumnNumericFormatDefault(java.lang.String name)
getNumericFormat()
.
Please note that column name which is an empty string has special meaning,
see setColumnNumericFormat(String name, String pattern)
for details.name
- the column namevoid setColumnNumericFormatNone(java.lang.String name)
setColumnNumericFormat(String name, String pattern)
for details.name
- the column namejava.lang.String getColumnNumericFormat(java.lang.String name)
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.name
- the column nameboolean isColumnNumericFormatNone(java.lang.String name)
setColumnNumericFormat(String name, String pattern)
for details.name
- the column namevoid setColumnDateFormat(java.lang.String name, java.lang.String pattern) throws java.lang.Exception
name
- the column namepattern
- the format patternjava.lang.Exception
- if the specified name is null or the specified pattern is invalidvoid setColumnDateFormatDefault(java.lang.String name)
getDateFormat()
.name
- the column namevoid setColumnDateFormatNone(java.lang.String name)
name
- the column namejava.lang.String getColumnDateFormat(java.lang.String name)
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.name
- the column nameboolean isColumnDateFormatNone(java.lang.String name)
name
- the column namevoid setColumnDateTimeFormat(java.lang.String name, java.lang.String pattern) throws java.lang.Exception
name
- the column namepattern
- the format patternjava.lang.Exception
- if the specified name is null or the specified pattern is invalidvoid setColumnDateTimeFormatDefault(java.lang.String name)
getDateTimeFormat()
.name
- the column namevoid setColumnDateTimeFormatNone(java.lang.String name)
name
- the column namejava.lang.String getColumnDateTimeFormat(java.lang.String name)
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.name
- the column nameboolean isColumnDateTimeFormatNone(java.lang.String name)
name
- the column namevoid setColumnTimeFormat(java.lang.String name, java.lang.String pattern) throws java.lang.Exception
name
- the column namepattern
- the format patternjava.lang.Exception
- if the specified name is null or the specified pattern is invalidvoid setColumnTimeFormatDefault(java.lang.String name)
getTimeFormat()
.name
- the column namevoid setColumnTimeFormatNone(java.lang.String name)
name
- the column namejava.lang.String getColumnTimeFormat(java.lang.String name)
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.name
- the column nameboolean isColumnTimeFormatNone(java.lang.String name)
name
- the column namevoid setColumnNumericFormat(int index, java.lang.String pattern) throws java.lang.Exception
index
- the column indexpattern
- the format patternjava.lang.Exception
- if the specified pattern is invalidvoid setColumnNumericFormatDefault(int index)
getNumericFormat()
.index
- the column indexvoid setColumnNumericFormatNone(int index)
index
- the column indexjava.lang.String getColumnNumericFormat(int index)
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.index
- the column indexboolean isColumnNumericFormatNone(int index)
index
- the column indexvoid setColumnDateFormat(int index, java.lang.String pattern) throws java.lang.Exception
index
- the column indexpattern
- the format patternjava.lang.Exception
- if the specified pattern is invalidvoid setColumnDateFormatDefault(int index)
getDateFormat()
.index
- the column indexvoid setColumnDateFormatNone(int index)
index
- the column indexjava.lang.String getColumnDateFormat(int index)
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.index
- the column indexboolean isColumnDateFormatNone(int index)
index
- the column indexvoid setColumnDateTimeFormat(int index, java.lang.String pattern) throws java.lang.Exception
index
- the column indexpattern
- the format patternjava.lang.Exception
- if the specified pattern is invalidvoid setColumnDateTimeFormatDefault(int index)
getDateTimeFormat()
.index
- the column indexvoid setColumnDateTimeFormatNone(int index)
index
- the column indexjava.lang.String getColumnDateTimeFormat(int index)
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.index
- the column indexboolean isColumnDateTimeFormatNone(int index)
index
- the column indexvoid setColumnTimeFormat(int index, java.lang.String pattern) throws java.lang.Exception
index
- the column indexpattern
- the format patternjava.lang.Exception
- if the specified pattern is invalidvoid setColumnTimeFormatDefault(int index)
getTimeFormat()
.index
- the column indexvoid setColumnTimeFormatNone(int index)
index
- the column indexjava.lang.String getColumnTimeFormat(int index)
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.index
- the column indexboolean isColumnTimeFormatNone(int index)
index
- the column indexvoid setColumnForegroundColor(java.lang.String name, int red, int green, int blue) throws java.lang.Exception
name
- the column namered
- the red componentgreen
- the green componentblue
- the blue componentjava.lang.Exception
- if the specified red, green and blue cannot be converted to a color.void setColumnForegroundColor(int index, int red, int green, int blue) throws java.lang.Exception
index
- the column indexred
- the red componentgreen
- the green componentblue
- the blue componentjava.lang.Exception
- if the specified red, green and blue cannot be converted to a color.void setColumnForegroundColor(java.lang.String name, java.lang.String hexCode) throws java.lang.Exception
name
- the column namehexCode
- the foreground color in hexadecimal notation, default is set to 000000.java.lang.Exception
- if the specified hexCode cannot be converted to a color.void setColumnForegroundColor(int index, java.lang.String hexCode) throws java.lang.Exception
index
- the column indexhexCode
- the foreground color in hexadecimal notation, default is set to 000000.java.lang.Exception
- if the specified hexCode cannot be converted to a color.int getColumnForegroundColorRGB(java.lang.String name)
name
- the column nameint getColumnForegroundColorRGB(int index)
index
- the column indexjava.lang.String getColumnForegroundColorHexCode(java.lang.String name)
name
- the column namejava.lang.String getColumnForegroundColorHexCode(int index)
index
- the column indexvoid setColumnBackgroundColor(java.lang.String name, int red, int green, int blue) throws java.lang.Exception
name
- the column namered
- the red componentgreen
- the green componentblue
- the blue componentjava.lang.Exception
- if the specified red, green and blue cannot be converted to a color.void setColumnBackgroundColor(int index, int red, int green, int blue) throws java.lang.Exception
index
- the column indexred
- the red componentgreen
- the green componentblue
- the blue componentjava.lang.Exception
- if the specified red, green and blue cannot be converted to a color.void setColumnBackgroundColor(java.lang.String name, java.lang.String hexCode) throws java.lang.Exception
name
- the column namehexCode
- the background color in hexadecimal notation, default is set to FFFFFF.java.lang.Exception
- if the specified hexCode cannot be converted to a color.void setColumnBackgroundColor(int index, java.lang.String hexCode) throws java.lang.Exception
index
- the column indexhexCode
- the background color in hexadecimal notation, default is set to FFFFFF.java.lang.Exception
- if the specified hexCode cannot be converted to a color.int getColumnBackgroundColorRGB(java.lang.String name)
name
- the column nameint getColumnBackgroundColorRGB(int index)
index
- the column indexjava.lang.String getColumnBackgroundColorHexCode(java.lang.String name)
name
- the column namejava.lang.String getColumnBackgroundColorHexCode(int index)
index
- the column indexvoid clearHtmlHeaderLinks()
void clearHtmlHeaderLinkIndexes()
Links created via addHtmlHeaderLink(int columnIndex, String url)
and addHtmlHeaderLinkByIndexes(int[] columnIndexes, String[] urlList)
are cleared by this method.
void addHtmlHeaderLink(int columnIndex, java.lang.String url)
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.
columnIndex
- the index to identify the column of interesturl
- the URLvoid addHtmlHeaderLinkByIndexes(int[] columnIndexes, java.lang.String[] urlList)
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.
columnIndexes
- the list of column indexesurlList
- the list of URL linksvoid removeHtmlHeaderLink(int columnIndex)
columnIndex
- the index to identify the column of interestjava.lang.String getHtmlHeaderLink(int columnIndex)
columnIndex
- the index to identify the column of interestvoid clearHtmlHeaderLinkNames()
Links created via addHtmlHeaderLink(String columnName, String url)
and addHtmlHeaderLinkByNames(String[] columnNames, String[] urlList)
are cleared by this method.
void addHtmlHeaderLink(java.lang.String columnName, java.lang.String url)
columnName
- the name to identify the column of interesturl
- the URLvoid addHtmlHeaderLinkByNames(java.lang.String[] columnNames, java.lang.String[] urlList)
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.columnNames
- the list of column namesurlList
- the list of URL linksvoid removeHtmlHeaderLink(java.lang.String columnName)
columnName
- the name to identify the column of interestjava.lang.String getHtmlHeaderLink(java.lang.String columnName)
columnName
- the name to identify the column of interestvoid clearHtmlDataLinks()
void clearHtmlDataLinkIndexes()
Links created via addHtmlDataLink(int columnIndex, String url)
and addHtmlDataLinkByIndexes(int[] columnIndexes, String[] urlList)
are cleared by this method.
void addHtmlDataLink(int columnIndex, java.lang.String url)
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.
columnIndex
- the index to identify the column of interesturl
- the URLvoid addHtmlDataLinkByIndexes(int[] columnIndexes, java.lang.String[] urlList)
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.
columnIndexes
- the list of column indexesurlList
- the list of URL linksvoid removeHtmlDataLink(int columnIndex)
columnIndex
- the index to identify the column of interestjava.lang.String getHtmlDataLink(int columnIndex)
columnIndex
- the index to identify the column of interestvoid clearHtmlDataLinkNames()
Links created via addHtmlDataLink(String columnName, String url)
and addHtmlDataLinkByNames(String[] columnNames, String[] urlList)
are cleared by this method.
void addHtmlDataLink(java.lang.String columnName, java.lang.String url)
columnName
- the name to identify the column of interesturl
- the URLvoid addHtmlDataLinkByNames(java.lang.String[] columnNames, java.lang.String[] urlList)
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.columnNames
- the list of column namesurlList
- the list of URL linksvoid removeHtmlDataLink(java.lang.String columnName)
columnName
- the name to identify the column of interestjava.lang.String getHtmlDataLink(java.lang.String columnName)
columnName
- the name to identify the column of interestvoid clearHtmlHeaderSortLinks()
void clearHtmlHeaderSortLinkIndexes()
Links created via addHtmlHeaderSortLink(int columnIndex, String url)
and addHtmlHeaderSortLinkByIndexes(int[] columnIndexes, String[] urlList)
are cleared by this method.
void addHtmlHeaderSortLink(int columnIndex, java.lang.String url)
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.
columnIndex
- the index to identify the column of interesturl
- the URLvoid addHtmlHeaderSortLinkByIndexes(int[] columnIndexes, java.lang.String[] urlList)
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.
columnIndexes
- the list of column indexesurlList
- the list of URL linksvoid removeHtmlHeaderSortLink(int columnIndex)
columnIndex
- the index to identify the column of interestjava.lang.String getHtmlHeaderSortLink(int columnIndex)
columnIndex
- the index to identify the column of interestvoid clearHtmlHeaderSortLinkNames()
Links created via addHtmlHeaderSortLink(String columnName, String url)
and addHtmlHeaderSortLinkByNames(String[] columnNames, String[] urlList)
are cleared by this method.
void addHtmlHeaderSortLink(java.lang.String columnName, java.lang.String url)
AQPivotDataSet
.columnName
- the name to identify the column of interesturl
- the URLvoid addHtmlHeaderSortLinkByNames(java.lang.String[] columnNames, java.lang.String[] urlList)
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
.columnNames
- the list of column namesurlList
- the list of URL linksvoid removeHtmlHeaderSortLink(java.lang.String columnName)
columnName
- the name to identify the column of interestjava.lang.String getHtmlHeaderSortLink(java.lang.String columnName)
columnName
- the name to identify the column of interestvoid setHtmlDataColumnSortLink(java.lang.String url)
url
- the URLjava.lang.String getHtmlDataColumnSortLink()
void clearHtmlDataColumnSortLink()
void clearHtmlDataCellStyles()
void setHtmlDataCellStyle(int rowIndex, int columnIndex, java.lang.String cssStyle)
rowIndex
- the row index of the data cellcolumnIndex
- the column index of the data cellcssStyle
- the column CSS stylejava.lang.String getHtmlDataCellStyle(int rowIndex, int columnIndex)
rowIndex
- the row index of the data cellcolumnIndex
- the column index of the data cellvoid setShowRowTrendChart(boolean flag)
flag
- shows trend charts for rows if set to trueboolean isShowRowTrendChart()
void setRowTrendChartCacheTime(int cacheTime) throws java.lang.Exception
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.cacheTime
- the time period, in seconds, that images should be keptjava.lang.Exception
- if the specified time period is less than or equal to zeroint getRowTrendChartCacheTime()
void setChartCacheTime(int cacheTime) throws java.lang.Exception
cacheTime
- the time period, in seconds, that images should be keptjava.lang.Exception
- if the specified time period is less than or equal to zeroint getChartCacheTime()
void setShowCellPercentageByRow(boolean flag)
flag
- shows percentage value for cells if set to true, default is set to trueboolean isShowCellPercentageByRow()
setShowCellPercentageByRow(boolean flag)
for more information.void setShowCellPercentageByColumn(boolean flag)
flag
- shows percentage value for cells if set to true, default is set to trueboolean isShowCellPercentageByColumn()
setShowCellPercentageByColumn(boolean flag)
for more information.void setShowAltRowColor(boolean flag)
flag
- displays rows in alternate colors if true, default is set to trueboolean isShowAltRowColor()
void setAltRowBackgroundColor(int red, int green, int blue)
red
- the red componentgreen
- the green componentblue
- the blue componentvoid setAltRowBackgroundColor(java.lang.String hexCode)
hexCode
- the background color in hexadecimal notation, default is set to EEEEEEint getAltRowBackgroundColorRGB()
java.lang.String getAltRowBackgroundColorHexCode()
setAltRowBackgroundColor(String hexCode)
for more information about hexadecimal color code.void setAltRowForegroundColor(int red, int green, int blue)
red
- the red componentgreen
- the green componentblue
- the blue componentvoid setAltRowForegroundColor(java.lang.String hexCode)
hexCode
- the foreground color in hexadecimal notation, default is set to 000000.int getAltRowForegroundColorRGB()
java.lang.String getAltRowForegroundColorHexCode()
setAltRowForegroundColor(String hexCode)
for more information about hexadecimal color code.void setPageSize(int size)
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.
size
- the preferred page size,
the default value is used if size
is less than or equal to zeroint getPageSize()
void setMaxColumnWidth(float width)
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.
width
- the maximum column width,
the default setting is used if width
is less than or equal to zerofloat getMaxColumnWidth()
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.