|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.lens.AbstractTableLens
inetsoft.report.filter.AbstractGroupedTable
inetsoft.report.filter.GroupedSortFilter
public class GroupedSortFilter
This filter sorts a grouped table by any columns.
If the sort column is a group column, the sort action will be performed in the group level the group column belongs to. If the sort column is a detail column, the sort action will be performed in the detail level.
For every level(group level or detail level), the sort action means rearranging the elements of the higher level. For a group level, "elements" is the sections, and for a detail level, "elements" is the rows.
If a group level has more than one group columns and more than one group columns of the group level are specified as the sort columns, the latter has a lower priority than the former, and if a detail level has more than one columns and more than one columns are specified as the sort columns, the latter has a lower priority than the former.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class inetsoft.report.filter.AbstractGroupedTable |
|---|
AbstractGroupedTable.BooleanObject |
| Field Summary |
|---|
| Fields inherited from class inetsoft.report.lens.AbstractTableLens |
|---|
descriptor, isLeftAlign |
| Fields inherited from interface inetsoft.report.TableLens |
|---|
BREAK_BORDER, NULL |
| Fields inherited from interface inetsoft.uql.XTable |
|---|
EOT |
| Fields inherited from interface inetsoft.report.filter.GroupedTable |
|---|
GROUP_HEADER_FULL, GROUP_HEADER_IN_PLACE, GROUP_HEADER_ROWS |
| Constructor Summary | |
|---|---|
GroupedSortFilter(GroupedTable table)
Construct a GroupedSortFilter instance. |
|
| Method Summary | |
|---|---|
void |
clearPageBreaks()
Clear page breaks. |
void |
dispose()
Dispose the table to clear up temporary resources. |
int |
getAlignment(int r,
int c)
Return the per cell alignment. |
Color |
getBackground(int r,
int c)
Return the per cell background color. |
int |
getBaseColIndex(int col)
Get the base table column index corresponding to the filtered table. |
int |
getBaseRowIndex(int row)
Get the base table row index corresponding to the filtered table. |
int |
getColBorder(int r,
int c)
Return the style for right border of the specified row. |
Color |
getColBorderColor(int r,
int c)
Return the color for drawing the column border lines. |
int |
getColCount()
Return the number of columns in the table. |
int |
getColWidth(int col)
Get the current column width setting. |
Comparer |
getComparer(int col)
Get the comparer for a column. |
TableDataDescriptor |
getDescriptor()
Get internal table data descriptor which contains table structural infos. |
Font |
getFont(int r,
int c)
Return the per cell font. |
Color |
getForeground(int r,
int c)
Return the per cell foreground color. |
Formula |
getGrandFormula(int col)
Get the grand total formula of the column. |
int |
getGroupColCount()
Return the number of grouping columns. |
int |
getGroupColLevel(int col)
Get a group col's group level. |
int |
getGroupColumns(int level)
Get the number of columns used in the specified grouping level. |
Formula |
getGroupFormula(int col)
Get the group formula of the column. |
int |
getGroupHeaderStyle()
Get the group header style. |
int |
getGroupLevel(int r)
Get the grouping level of this group header. |
int |
getGroupLevel0(int r)
Get the internal keep row level for the first row of a group. |
int |
getHeaderColCount()
Return the number of columns on the left of the table to be treated as header columns. |
int |
getHeaderRowCount()
Return the number of rows on the top of the table to be treated as header rows. |
Insets |
getInsets(int r,
int c)
Return the cell gap space. |
Object |
getObject(int r,
int c)
Return the value at the specified cell. |
BitSet |
getPageBreakLevels()
Get page break levels. |
int |
getRowBorder(int r,
int c)
Return the style for bottom border of the specified cell. |
Color |
getRowBorderColor(int r,
int c)
Return the color for drawing the row border lines. |
int |
getRowCount()
Return the number of rows in the table. |
int |
getRowHeight(int row)
Get the current row heights setting. |
boolean |
getSortInfo(int col)
Get the sort info of a column. |
int |
getSummaryLevel(int row)
Get the grouping level of a summary row. |
TableLens |
getTable()
Get the original table of this filter. |
int |
getTrailerRowCount()
Return the number of rows on the bottom of the table to be treated as trailer rows. |
boolean |
hasGrandSummary()
Check if this table contains grand total row. |
void |
invalidate()
Invalidate the table filter forcely, and the table filter will perform filtering calculation to validate itself. |
boolean |
isAddGroupHeader()
Check if group header is to be added to the grouped data. |
boolean |
isGroupHeaderCell(int r,
int c)
Check if a cell is displaying group header. |
boolean |
isGroupHeaderRow(int r)
Check if a row is displaying group header. |
boolean |
isLineWrap(int r,
int c)
Return the per cell line wrap mode. |
boolean |
isShowGroupColumns()
Check if the group column contents are shown. |
boolean |
isSortInfoExisting(int col)
Test if the sort info of a column exists. |
boolean |
isSummaryCol(int col)
Check if a column is a summary column. |
boolean |
isSummaryRow(int row)
Check if a row is a summary row. |
void |
removeAllSortInfos()
Remove all sort infos of all the columns. |
void |
removeSortInfo(int col)
Remove the sort info of a column. |
void |
setAddGroupHeader(boolean h)
Set whether group headers are added to the table. |
void |
setComparer(int col,
Comparer comp)
Set the comparer for a column. |
void |
setGroupHeaderStyle(int headerS)
Set the group header style. |
void |
setObject(int r,
int c,
Object v)
Set the cell value. |
void |
setShowGroupColumns(boolean grp)
Set the show group column contents option. |
void |
setSortInfo(int col,
boolean asc)
Set a sort info to the GroupedSortFilter instance. |
void |
setTable(TableLens table)
Set the base table of this filter. |
| Methods inherited from class inetsoft.report.filter.AbstractGroupedTable |
|---|
clearCache, firstSummaryColumn, getAvailableLevels, getColumnIdentifier, getGroupFirstRow, getGroupFirstRow, getGroupFirstRow0, getGroupLastRow, getGroupLastRow, getGroupLastRow0, getHeader2, getMergedGroup, getOriginalPath, getRealGroupColCount, getSpan, isMergedGroup, isMergeGroupCells, setMergedGroup, setMergeGroupCells |
| Methods inherited from class inetsoft.report.lens.AbstractTableLens |
|---|
addChangeListener, clone, containsDrill, containsFormat, findColumnByIdentifier, fireChangeEvent, getBoolean, getByte, getColType, getDefaultFormat, getDouble, getFloat, getInt, getLong, getShort, getTrailerColCount, getXDrillInfo, isNull, isPrimitive, moreRows, removeChangeListener, setColumnIdentifier, setLeftAlign, setLocal |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface inetsoft.report.internal.table.CachedTableLens |
|---|
clearCache |
| Methods inherited from interface inetsoft.report.TableLens |
|---|
addChangeListener, containsDrill, containsFormat, getDefaultFormat, getSpan, getXDrillInfo, removeChangeListener |
| Methods inherited from interface inetsoft.uql.XTable |
|---|
getBoolean, getByte, getColType, getColumnIdentifier, getDouble, getFloat, getInt, getLong, getShort, getTrailerColCount, isNull, isPrimitive, moreRows, setColumnIdentifier |
| Constructor Detail |
|---|
public GroupedSortFilter(GroupedTable table)
GroupedSortFilter instance.
table - the grouped table.| Method Detail |
|---|
public void setSortInfo(int col,
boolean asc)
GroupedSortFilter instance.
col - the column to sort.asc - true means ascending, false means
descending.public boolean isSortInfoExisting(int col)
col - the column.
true if exists, false otherwise.public boolean getSortInfo(int col)
col - the column.
true if is ascending, false is
decending or not existing. To see if the sort of the column info exists,
call isSortInfoExisting(int).public void removeSortInfo(int col)
col - the column.public void removeAllSortInfos()
public void setComparer(int col,
Comparer comp)
col - the columncomp - the comparerpublic Comparer getComparer(int col)
col - the column.
null if out of range.public void setTable(TableLens table)
setTable in interface TableFilterpublic TableLens getTable()
getTable in interface TableFilterpublic int getGroupColCount()
getGroupColCount in interface GroupedTablegetGroupColCount in class AbstractGroupedTablepublic int getGroupColumns(int level)
1 unless multiple columns are combined into
one group.
getGroupColumns in interface GroupedTablegetGroupColumns in class AbstractGroupedTablelevel - the group level.
public int getGroupLevel(int r)
getGroupLevel in interface GroupedTablegetGroupLevel in interface RegionTablegetGroupLevel in class AbstractGroupedTabler - the row.
0.
Returns -1 if the row is not a header row.public int getGroupLevel0(int r)
getGroupLevel0 in class AbstractGroupedTablepublic int getGroupColLevel(int col)
getGroupColLevel in interface GroupedTablegetGroupColLevel in class AbstractGroupedTablecol - the group col
-1 means not a group colpublic boolean isGroupHeaderRow(int r)
isGroupHeaderRow in interface GroupedTableisGroupHeaderRow in class AbstractGroupedTabler - the row number.
true if is displaying group header,
false otherwise.
public boolean isGroupHeaderCell(int r,
int c)
isGroupHeaderCell in interface GroupedTableisGroupHeaderCell in interface RegionTableisGroupHeaderCell in class AbstractGroupedTabler - row number.c - column number.
true if the cell is a displaying group header.public boolean isShowGroupColumns()
isShowGroupColumns in interface GroupedTableisShowGroupColumns in class AbstractGroupedTablepublic void setShowGroupColumns(boolean grp)
setShowGroupColumns in interface GroupedTablesetShowGroupColumns in class AbstractGroupedTablegrp - show group column contents.public boolean isAddGroupHeader()
isAddGroupHeader in interface GroupedTableisAddGroupHeader in class AbstractGroupedTablepublic void setAddGroupHeader(boolean h)
setAddGroupHeader in interface GroupedTablesetAddGroupHeader in class AbstractGroupedTablepublic int getGroupHeaderStyle()
getGroupHeaderStyle in interface GroupedTablegetGroupHeaderStyle in class AbstractGroupedTablepublic void setGroupHeaderStyle(int headerS)
setGroupHeaderStyle in interface GroupedTablesetGroupHeaderStyle in class AbstractGroupedTableheaderS - one of GROUP_HEADER_IN_PLACE, GROUP_HEADER_ROWS (default).public boolean isSummaryRow(int row)
isSummaryRow in interface GroupedTableisSummaryRow in interface RegionTableisSummaryRow in class AbstractGroupedTablerow - the row number.
true if the row is a summary row.public boolean isSummaryCol(int col)
isSummaryCol in interface GroupedTableisSummaryCol in class AbstractGroupedTablecol - the column number.
true if the column is a summary column.public int getSummaryLevel(int row)
getSummaryLevel in interface GroupedTablegetSummaryLevel in interface RegionTablegetSummaryLevel in class AbstractGroupedTable0. Returns -1 if the row is not a summary row.public boolean hasGrandSummary()
hasGrandSummary in interface GroupedTablehasGrandSummary in class AbstractGroupedTabletrue if grand total row exists.public void invalidate()
invalidate in interface TableFilterpublic BitSet getPageBreakLevels()
getPageBreakLevels in class AbstractGroupedTablepublic int getBaseRowIndex(int row)
getBaseRowIndex in interface GroupedTablegetBaseRowIndex in interface TableFiltergetBaseRowIndex in class AbstractGroupedTablerow - row index in the filtered table.
public int getBaseColIndex(int col)
getBaseColIndex in interface TableFiltercol - column index in the filtered table.
public int getRowCount()
getRowCount in interface XTablepublic int getColCount()
getColCount in interface XTablepublic int getHeaderRowCount()
getHeaderRowCount in interface XTablegetHeaderRowCount in class AbstractTableLenspublic int getTrailerRowCount()
getTrailerRowCount in interface XTablegetTrailerRowCount in class AbstractTableLenspublic int getHeaderColCount()
getHeaderColCount in interface XTablegetHeaderColCount in class AbstractTableLenspublic int getRowHeight(int row)
getRowHeight in interface TableLensgetRowHeight in class AbstractTableLensrow - the row.
public int getColWidth(int col)
getColWidth in interface TableLensgetColWidth in class AbstractTableLenscol - the column.
public Color getRowBorderColor(int r,
int c)
getRowBorderColor in interface TableLensgetRowBorderColor in class AbstractTableLensr - row number.c - column number.
public Color getColBorderColor(int r,
int c)
getColBorderColor in interface TableLensgetColBorderColor in class AbstractTableLensr - row number.c - column number.
public int getRowBorder(int r,
int c)
getRowBorder in interface TableLensgetRowBorder in class AbstractTableLensr - row number.c - column number.
public int getColBorder(int r,
int c)
getColBorder in interface TableLensgetColBorder in class AbstractTableLensr - row number.c - column number.
public Insets getInsets(int r,
int c)
getInsets in interface TableLensgetInsets in class AbstractTableLensr - row number.c - column number.
public int getAlignment(int r,
int c)
getAlignment in interface TableLensgetAlignment in class AbstractTableLensr - row number.c - column number.
public Font getFont(int r,
int c)
getFont in interface TableLensgetFont in class AbstractTableLensr - row number.c - column number.
public boolean isLineWrap(int r,
int c)
isLineWrap in interface TableLensisLineWrap in class AbstractTableLensr - row number.c - column number.
public Color getForeground(int r,
int c)
getForeground in interface TableLensgetForeground in class AbstractTableLensr - row number.c - column number.
public Color getBackground(int r,
int c)
getBackground in interface TableLensgetBackground in class AbstractTableLensr - row number.c - column number.
public Object getObject(int r,
int c)
getObject in interface XTabler - row number.c - column number.
public void setObject(int r,
int c,
Object v)
setObject in interface XTablesetObject in class AbstractTableLensr - row number.c - column number.v - cell value.public Formula getGroupFormula(int col)
getGroupFormula in interface GroupedTablegetGroupFormula in class AbstractGroupedTablecol - column index in the grouped table.
public Formula getGrandFormula(int col)
getGrandFormula in interface GroupedTablegetGrandFormula in class AbstractGroupedTablecol - column index in the grouped table.
public void dispose()
dispose in interface XTabledispose in class AbstractTableLenspublic void clearPageBreaks()
clearPageBreaks in class AbstractGroupedTablepublic TableDataDescriptor getDescriptor()
getDescriptor in interface TableLensgetDescriptor in interface XTablegetDescriptor in class AbstractTableLens
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||