|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface TableElement
Table is the most common element on a report. It can be used to present a dataset in a tabular grid. Tables can span across pages, and can be wrapped horizontally if the table is wider than a page. Table presentation attributes are retrieved from table lenses, or through a table style. Built-in table styles are in inetsoft.report.style package.
| Field Summary |
|---|
| Fields inherited from interface inetsoft.report.ReportElement |
|---|
AGGREGATE, AUTOSIZE, GROW, LOCAL_QUERY, QUERY, XNODEPATH |
| Method Summary | |
|---|---|
void |
addFormat(Class type,
Format format)
Add a format to a data type. |
void |
addPresenter(Class type,
Presenter presenter)
Add a presenter to a data type. |
Enumeration |
getAllHyperlinks()
Deprecated. |
ColumnMatching |
getColumnMatching()
Get the column matching definition, which contains the target element ID and the column mappings. |
float |
getColWidth(int col)
Get the column width in pixels. |
int[] |
getFixedWidths()
Get the fixed column widths in pixels. |
Format |
getFormat(Class type)
Get the format object registered for this class or one of it's super classes. |
Hyperlink.Ref |
getHyperlink(int row,
int col)
Get the hyperlink assigned to a cell. |
Hyperlink |
getHyperlink(String colname)
Deprecated. |
int |
getLayout()
Get the table layout policy. |
float |
getMaxColWidth()
Get the maximum column width. |
int |
getMultiColumn()
Check if the table is to be printed as multiple columns. |
Point[] |
getOnClickRange()
Get the range of cells the onClick handler is interested in. |
Insets |
getPadding()
Get cell padding space. |
Presenter |
getPresenter(Class type)
Get the presenter object registered for this class or one of it's super classes. |
inetsoft.report.style.TableStyle |
getStyle()
Get the table style. |
TableLens |
getTable()
Get the table lens. |
int |
getTableAdvance()
Get the advance amount after a table element. |
TableLayout |
getTableLayout()
Get the table layout of the table. |
TableLayout |
getTableLayout(boolean createIfEmpty)
Get the table layout of the table. |
double |
getTableWidth()
Get the table width in inches. |
String |
getTextID(String colname)
Get the textID, which is used for i18n support, for each column. |
String[] |
getTextIDs()
Get the textIDs, which is used for i18n support. |
boolean |
isAdhocEnabled()
Check if adhoc query is enabled on this element. |
boolean |
isFillPage()
Check whether to stretch the table to fill the page height. |
boolean |
isKeepGroupTogether()
Check if group rows/columns should be kept together. |
boolean |
isKeepSpanTogether()
Check if span rows/columns should be kept together for horizontal wrapping. |
boolean |
isOrphanControl()
Check the current widow/orphan control setting. |
void |
removeAllHyperlinks()
Deprecated. |
void |
setAdhocEnabled(boolean enabled)
Set whether adhoc query is enabled on this element. |
void |
setColumnMatching(ColumnMatching mapping)
Set the column matching definition, which contains the target element ID and the column mappings. |
void |
setFillPage(boolean fill)
Set the option to stretch the table to fill the page height. |
void |
setFixedWidths(int[] ws)
Set the fixed column widths in pixels. |
void |
setHyperlink(int row,
int col,
Hyperlink.Ref link)
Set a hyperlink on a cell. |
void |
setHyperlink(String colname,
Hyperlink link)
Deprecated. |
void |
setKeepGroupTogether(boolean keep)
Set if group rows/columns should be kept together. |
void |
setKeepSpanTogether(boolean keep)
Set if span rows/columns should be kept together for horizontal wrapping. |
void |
setLayout(int layout)
Set the table layout policy. |
void |
setMaxColWidth(float w)
Set the maximum column width. |
void |
setMultiColumn(int multiColumn)
Set whether to print the table as multiple columns. |
void |
setOnClickRange(Point[] range)
Set the range of cells the onClick handler is interested in. |
void |
setOrphanControl(boolean orphan)
Set the table widow/orphan control option. |
void |
setPadding(Insets padding)
Set cell padding space. |
void |
setStyle(inetsoft.report.style.TableStyle style)
Set the table style. |
void |
setTable(TableLens table)
Set the table lens. |
void |
setTableAdvance(int tableadv)
Set the advance amount after a table element. |
void |
setTableLayout(TableLayout tlayout)
Set table layout. |
void |
setTableWidth(double w)
Set the table width in inches. |
void |
setTextID(String colname,
String textID)
Set the textID, which is used for i18n support, for each column. |
void |
setTextIDs(String[] textIDs)
Set the textIDs, which is used for i18n support. |
| Methods inherited from interface inetsoft.report.ReportElement |
|---|
clone, getAlignment, getBackground, getCSSClass, getFont, getForeground, getFullName, getID, getIndent, getOnClick, getPreferredSize, getProperty, getPropertyNames, getScript, getSpacing, getTarget, getType, getUserObject, isHideOnPrint, isKeepWithNext, isVisible, setAlignment, setBackground, setContext, setCSSClass, setFont, setForeground, setFullName, setHideOnPrint, setID, setIndent, setKeepWithNext, setOnClick, setProperty, setScript, setSpacing, setTarget, setUserObject, setVisible |
| Method Detail |
|---|
Presenter getPresenter(Class type)
type - class to search for.
void addPresenter(Class type,
Presenter presenter)
type - data type the presenter is for.presenter - presenter for the data type.Format getFormat(Class type)
type - class to search for.
void addFormat(Class type,
Format format)
type - data type the format is for.format - format for the data type.double getTableWidth()
void setTableWidth(double w)
int[] getFixedWidths()
void setFixedWidths(int[] ws)
int getLayout()
void setLayout(int layout)
Insets getPadding()
void setPadding(Insets padding)
int getTableAdvance()
void setTableAdvance(int tableadv)
float getMaxColWidth()
void setMaxColWidth(float w)
w - maximum column width. If the value is 0, the width is not
limited.boolean isKeepSpanTogether()
void setKeepSpanTogether(boolean keep)
boolean isKeepGroupTogether()
void setKeepGroupTogether(boolean keep)
ColumnMatching getColumnMatching()
void setColumnMatching(ColumnMatching mapping)
TableLayout getTableLayout()
TableLayout getTableLayout(boolean createIfEmpty)
createIfEmpty - when layout is null, need to create a new one,
default is true.void setTableLayout(TableLayout tlayout)
int getMultiColumn()
void setMultiColumn(int multiColumn)
TableLens getTable()
void setTable(TableLens table)
float getColWidth(int col)
void setOrphanControl(boolean orphan)
orphan - true to eliminate widow/orphan rows.boolean isOrphanControl()
void setOnClickRange(Point[] range)
Point[] getOnClickRange()
String getTextID(String colname)
void setTextID(String colname,
String textID)
String[] getTextIDs()
void setTextIDs(String[] textIDs)
Enumeration getAllHyperlinks()
Hyperlink getHyperlink(String colname)
void setHyperlink(String colname,
Hyperlink link)
colname - name of the column to attach hyperlink to.link - hyperlink definition.void removeAllHyperlinks()
void setHyperlink(int row,
int col,
Hyperlink.Ref link)
row - table row index.col - table column index.link - hyperlink instance.
Hyperlink.Ref getHyperlink(int row,
int col)
row - table row index.col - table column index.
boolean isAdhocEnabled()
void setAdhocEnabled(boolean enabled)
void setFillPage(boolean fill)
boolean isFillPage()
void setStyle(inetsoft.report.style.TableStyle style)
inetsoft.report.style.TableStyle getStyle()
|
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 | ||||||||