|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.asset.AbstractAssetEngine
inetsoft.report.internal.StyleCore
inetsoft.report.ReportSheet
inetsoft.report.CompositeSheet
public class CompositeSheet
A composite sheet object groups multiple ReportSheet objects into one report. Reports are printed as one single report. Page numbers are contiguous across reports by default.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class inetsoft.report.internal.StyleCore |
|---|
inetsoft.report.internal.StyleCore.ActionScriptable |
| Nested classes/interfaces inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
AbstractAssetEngine.ReportSheetDependencyFinder, AbstractAssetEngine.SheetTransformListener, AbstractAssetEngine.StorageChangeListener |
| Field Summary |
|---|
| Fields inherited from class inetsoft.report.ReportSheet |
|---|
BODY, DEFAULT_FOOTER, DEFAULT_HEADER, DOWN, EVEN_PAGE_FOOTER, EVEN_PAGE_HEADER, FIRST_PAGE_FOOTER, FIRST_PAGE_HEADER, ODD_PAGE_FOOTER, ODD_PAGE_HEADER, PAINTER_BREAKABLE, PAINTER_NON_BREAK, TABLE_EQUAL_WIDTH, TABLE_FIT_CONTENT, TABLE_FIT_CONTENT_1PP, TABLE_FIT_CONTENT_PAGE, TABLE_FIT_PAGE, UP, WRAP_BOTH, WRAP_LEFT, WRAP_NONE, WRAP_RIGHT, WRAP_TOP_BOTTOM |
| Fields inherited from class inetsoft.report.internal.StyleCore |
|---|
advanceLine, alignment, anchor, autosize, background, bg, bgimage, bglayout, bgsize, burstInfo, chartinfo, cmargin, COMPLETED, contexts, current, currFooter, currFrame, currHeader, DESIGN_MODE, elemFooter, elemHeader, evenFooter, evenHeader, firstFooter, firstHeader, font, footerElements, footerFromEdge, foreground, formatmap, frames, g_pmargin, header, headerElements, headerFromEdge, headingCnt, headingMap, hfFmt, hindent, horFlow, idmap, indent, initCalled, initCmd, initScript, justify, lastHead, lineH, LIVE_MODE, loadCmd, loadScript, locale, margin, MORE_ELEM, MORE_FLOW, nextOrient, npframes, nplayout, numHeadingMap, oddFooter, oddHeader, orphan, overrideFooter, overrideFooterContinue, overrideHeader, overrideHeaderContinue, padding, pageBox, pagebreakCmd, pagebreakScript, painterLayout, painterMargin, parameters, parentElem, pglayout, pgStart, pgTotal, pmargin, presentermap, printBox, printCmd, printHead, printMode, printScript, prop, psheet, queries, reportmode, rewinded, RUN_MODE, runningScript, runningTotals, scriptenv, secHeadingMap, secNumHeadingMap, sepadv, spacing, tableadv, tableorphan, tableW, tabStops, textadv, wrapping |
| Fields inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
admin, catalog, editing, istore, LOCAL, parent, scopes |
| Fields inherited from interface inetsoft.uql.XQueryRepository |
|---|
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY |
| Fields inherited from interface inetsoft.report.internal.ParameterSheetRepository |
|---|
EMBED_PARAMETER_SHEET, EMBED_SECTION |
| Fields inherited from interface inetsoft.uql.asset.AssetRepository |
|---|
ASSET_ERRORS, COMPONENT_SCOPE, GLOBAL_SCOPE, IGNORE_PERM, LOCAL_QUERY, QUERY_SCOPE, REPORT_SCOPE, REPORT_WORKSHEET, REPOSITORY_SCOPE, TEMPORARY_SCOPE, USER_SCOPE |
| Constructor Summary | |
|---|---|
CompositeSheet(ReportSheet[] sheets)
Create a composite report. |
|
CompositeSheet(ReportSheet[] sheets,
boolean contiguous)
Create a composite report, specifying if contiguous page numbers. |
|
| Method Summary | |
|---|---|
String |
addFooterBreak()
Add a break to the document footer. |
String |
addFooterElement(ReportElement e)
Add an element to the document footer. |
String |
addFooterImage(Image image)
Add an image to the document footer. |
String |
addFooterImage(Image image,
double winch,
double hinch)
This is same as addFooterImage() exception an explicit size of the painter area is specified. |
String |
addFooterImage(URL image)
Add an image to the document footer. |
String |
addFooterNewline(int n)
Add one or more newline to the document footer. |
String |
addFooterObject(Object obj)
Add an object to the document footer. |
String |
addFooterPainter(Painter area)
Add a pinter element to the document footer. |
String |
addFooterPainter(Painter area,
double winch,
double hinch)
This is same as addFooterPainter() exception an explicit size of the painter area is specified. |
String |
addFooterSeparator(int style)
Add a separator to footer. |
String |
addFooterSpace(int pixels)
Add horizontal space to the document footer. |
String |
addFooterTab(int fill)
Add a tab. |
String |
addFooterTable(TableLens table)
Add a table to the document footer. |
String |
addFooterText(String text)
Add a text string to the document footer. |
String |
addFooterText(TextLens text)
Add a text element to the document footer. |
String |
addFooterTextBox(TextLens text)
Add a text box to the document footer. |
String |
addFooterTextBox(TextLens text,
int border,
double winch,
double hinch,
int talign)
Add a text box to the document footer. |
void |
addFormat(Class type,
Format p)
Register a format for the specified class. |
String |
addHeaderBreak()
Add a break to the document header. |
String |
addHeaderElement(ReportElement e)
Add an element to the document header. |
String |
addHeaderImage(Image image)
Add an image to the document header. |
String |
addHeaderImage(Image image,
double winch,
double hinch)
This is same as addHeaderImage() exception an explicit size of the painter area is specified. |
String |
addHeaderImage(URL image)
Add an image to the document header. |
String |
addHeaderNewline(int n)
Add one or more newline to the document header. |
String |
addHeaderObject(Object obj)
Add an object to the document header. |
String |
addHeaderPainter(Painter area)
Add a pinter element to the document header. |
String |
addHeaderPainter(Painter area,
double winch,
double hinch)
This is same as addHeaderPainter() exception an explicit size of the painter area is specified. |
String |
addHeaderSeparator(int style)
Add a separator to header. |
String |
addHeaderSpace(int pixels)
Add horizontal space to the document header. |
String |
addHeaderTab(int fill)
Add a tab. |
String |
addHeaderTable(TableLens table)
Add a table to the document header. |
String |
addHeaderText(String text)
Add a text string to the document header. |
String |
addHeaderText(TextLens text)
Add a text element to the document header. |
String |
addHeaderTextBox(TextLens text)
Add a text box to the document header. |
String |
addHeaderTextBox(TextLens text,
int border,
double winch,
double hinch,
int talign)
Add a text box to the document header. |
void |
addPageBreakListener(PageBreakListener l)
Add a pagebreak listener. |
void |
addParameter(UserVariable param)
Add a new parameter to the report. |
void |
addPresenter(Class type,
Presenter p)
Register a presenter for the specified class. |
void |
addScriptObject(String name,
Object obj)
Add a script object. |
void |
clear()
Remove all report elements. |
void |
clearFormat()
Clear the format registry. |
void |
clearPresenter()
Clear the presenter registry. |
void |
deleteScriptEnv()
Destroy the script env. |
Vector |
getAllElements()
Get all elements in the report, including body, and non-flow area elements. |
Vector |
getAllFooterElements()
Get all footer elements in the report, including footers, element associated footers. |
Vector |
getAllHeaderElements()
Get all header elements in the report, including headers, element associated headers. |
int |
getCurrentAlignment()
Get the current setting of the alignment. |
Color |
getCurrentBackground()
Get the current document background color. |
Insets |
getCurrentCellPadding()
Get the current table cell padding. |
Font |
getCurrentFont()
Get the current font setting. |
Color |
getCurrentForeground()
Get the current document foreground color. |
double |
getCurrentIndent()
Get the current indentation in inches. |
int |
getCurrentLineSpacing()
Get the current line spacing setting. |
int |
getCurrentPainterLayout()
Get the current painter layout policy. |
Insets |
getCurrentPainterMargin()
Get the fixed size element external space. |
int |
getCurrentTableAdvance()
Get the advance of table elements. |
int |
getCurrentTableLayout()
Get the current table layout mode. |
double |
getCurrentTableWidth()
Get the current table width setting. |
double[] |
getCurrentTabStops()
Return the current tab stop setting. |
int |
getCurrentTextAdvance()
Get the advance of text elements. |
int |
getCurrentWrapping()
Get the current wrapping style. |
ReportElement |
getElement(String id)
Find the index of the specified element. |
Vector |
getElements(int type)
Get the elements of the specified type. |
Rectangle |
getFooterBounds(Dimension pgsize)
Get the page footer bounds. |
ReportElement |
getFooterElement(int idx)
Get the specified element in the footer. |
int |
getFooterElementCount()
Return the number of elements in the document footer. |
int |
getFooterElementIndex(ReportElement e)
Get the index of the specified element. |
double |
getFooterFromEdge()
Get the page footer position from the bottom of the page. |
Format |
getFormat(Class type)
Get the format object registered for this class or one of it's super classes. |
Rectangle |
getHeaderBounds(Dimension pgsize)
Get the page header bounds. |
ReportElement |
getHeaderElement(int idx)
Get the specified element in the header. |
int |
getHeaderElementCount()
Return the number of elements in the document header. |
int |
getHeaderElementIndex(ReportElement e)
Get the index of the specified element. |
double |
getHeaderFromEdge()
Get the page header position from the top of the page. |
Margin |
getMargin()
Get the page margin in inches. |
Integer |
getNextOrientation()
Get the page orientation for the next page. |
Size |
getPageSize()
Get the page size for the next report. |
UserVariable |
getParameter(int idx)
Get a report parameter definition. |
int |
getParameterCount()
Get the number of parameters defined in this report. |
String[] |
getParameterSheets()
Get the parameter sheets for this parameter. |
Presenter |
getPresenter(Class type)
Get the presenter object registered for this class or one of it's super classes. |
String |
getProperty(String name)
Get a property value. |
ReportSheet |
getReport(int idx)
Get the specified report in this composite report. |
int |
getReportCount()
Get the number of reports in this composite report. |
void |
insertFooterElement(int idx,
ReportElement e)
Insert the element at specified position (before). |
void |
insertHeaderElement(int idx,
ReportElement e)
Insert the element at specified position (before). |
boolean |
isCurrentJustify()
Check if text is justified. |
boolean |
isCurrentOrphanControl()
Check the current widow/orphan control setting. |
boolean |
isCurrentTableOrphanControl()
Check the current table widow/orphan control setting. |
void |
moveAnchor(Position anchor)
Move the anchor to the new position. |
void |
moveElement(String id,
int direction)
Move element up or down. |
protected void |
printHeaderFooter(StylePage pg)
Print the header and footer of the page. |
boolean |
printNext(StylePage pg)
Print one page. |
boolean |
printNextPage(StylePage pg)
Print the next page. |
void |
removeAllParameters()
Removes all the parameters from the report parameter list. |
protected void |
removeContents()
Remove all elements from the contents area. |
void |
removeElement(String id)
Remove the specified element. |
void |
removeFooterElement(int idx)
Remove the specified element. |
void |
removeFormat(Class type)
Remove the specified format from the registry. |
void |
removeHeaderElement(int idx)
Remove the specified element. |
void |
removePageBreakListener(PageBreakListener l)
Remove a pagebreak listener. |
void |
removeParameter(int idx)
Remove a parameter from the report parameter list. |
void |
removePresenter(Class type)
Remove the specified presenter from the registry. |
void |
replaceElement(String id,
ReportElement e)
Replace the specified element. |
void |
reset()
Reset the printing. |
protected void |
resetContents()
Reset all elemnts in the contents. |
void |
resetOnLoad()
Reset onLoad so that the next call to runOnLoad will execute the onLoad script. |
void |
resetScriptEnv()
Re-create the script runtime environment from elements. |
void |
runOnInit()
Run the onInit script. |
void |
runOnLoad()
Run the onLoad script. |
void |
runOnPrint()
Run the onPrint script. |
void |
setCurrentAlignment(int align)
Set the current alignment of the report elements. |
void |
setCurrentBackground(Color bg)
Set the current document background color. |
void |
setCurrentCellPadding(Insets padding)
Set the cell padding space around the cell contents. |
void |
setCurrentFont(Font font)
Set the current font of the document. |
void |
setCurrentFooter(int hflag)
Set the currently worked on footer. |
void |
setCurrentFooter(String eid)
Set the currently worked on footer. |
void |
setCurrentForeground(Color fg)
Set the current document foreground color. |
void |
setCurrentHeader(int hflag)
Set the currently worked on header. |
void |
setCurrentHeader(String eid)
Set the currently worked on header. |
void |
setCurrentIndent(double inch)
Set the current indentation level. |
void |
setCurrentJustify(boolean justify)
If justify is set to true, text lines are fully justified. |
void |
setCurrentLineSpacing(int spacing)
Set the current line spacing in pixels. |
void |
setCurrentOrphanControl(boolean orphan)
Set the widow/orphan line control option. |
void |
setCurrentPainterLayout(int policy)
Set the layout policy for painter. |
void |
setCurrentPainterMargin(Insets margin)
Set the space around the painter elements. |
void |
setCurrentTableAdvance(int tableadv)
Set the amount to advance following each table element. |
void |
setCurrentTableLayout(int autosize)
Set the current table layout mode. |
void |
setCurrentTableOrphanControl(boolean orphan)
Set the table widow/orphan control option. |
void |
setCurrentTableWidth(double inch)
Set the width of the table in inches. |
void |
setCurrentTabStops(double[] pos)
Set the tab stops. |
void |
setCurrentTextAdvance(int textadv)
Set the amount to advance following each text element. |
void |
setCurrentWrapping(int wrapping)
Set the current wrapping style. |
void |
setFooterFromEdge(double inch)
Set the page footer position from the bottom of the page. |
void |
setHeaderFromEdge(double inch)
Set the page header position from the top of the page. |
void |
setMargin(Margin margin)
Set the page margin. |
void |
setPageNumberingStart(int idx)
Set the page index where the page numbering starts. |
void |
setParameterSheets(String[] sheets)
Set the parameter sheets for prompting parameter values. |
void |
setPrintMode(boolean printMode)
Turn on or off the print mode. |
void |
setProperty(String name,
String val)
Set a property. |
void |
setReportMode(int mode)
Set the mode of the report. |
void |
setScriptEnv(inetsoft.report.internal.ReportScriptEnv scriptenv)
Set the script runtime. |
void |
setVariableTable(VariableTable vars)
Set the report parameters. |
void |
setVisible(String id,
boolean vis)
Set the visibility of an element. |
| Methods inherited from class inetsoft.report.internal.StyleCore |
|---|
addChangeListener, addr, advance, alignLine, append, append, calcGrid, checkDataSourceFolderPermission, checkDataSourcePermission, checkQueryFolderPermission, checkQueryPermission, cloneElements, cloneElements, complete, completeElement, copyQueries, copyStyleCore, createFinder, createFormatMap, createPresenterMap, fireEvent, format, format, getActionScriptable, getBackgroundImageLocation, getBuildNumber, getBurstInfo, getCompositeElement, getDefaultFooter, getDefaultHeader, getDependencyFile, getDependencyFileName, getElementFooters, getElementHeaders, getElementWidth, getElemInfoBoundsMap, getElemInfoMap, getFinder, getFormat, getFormats, getFrames, getHeadingNumberArray, getHFTextFormatter, getLocalQueryRepository, getNextHeadingNumberArray, getNextID, getNumHeadingMap, getOnLoadResult, getOutputType, getPageTotalStart, getPagingLock, getParameterSheet, getParentScope, getPresenter, getProperties, getQueryManager, getReportManager, getReportMode, getScriptEnv, getScriptObject, getSecNumHeadingMap, getSheet, getTextSize, getTopReport, getVariableTable, hasOnPrint, isDesignTime, isLimited, isPrintMode, isReusePages, isRunTime, isSubreport, parseAssetRepository, printFixedContainer, printFixedContainer, processHF, processHF, putElemWarnings, removeChangeListener, renameQuery, renameQuery, resetCache, resetHeadingNumberArray, restoreHeadingNumberArray, setBackgroundImageLocation, setBurstInfo, setDesignTime, setElemInfoBoundsMap, setFooterContinue, setHeaderContinue, setHeadingNumberArray, setHFTextFormatter, setHindent, setOverrideFooter, setOverrideHeader, setPageTotalStart, setParentScope, setReportMode, setReusePages, setSubreport, setValue, skip, toString, updateParameterSheet, writeAssetRepository |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public CompositeSheet(ReportSheet[] sheets)
public CompositeSheet(ReportSheet[] sheets,
boolean contiguous)
| Method Detail |
|---|
public int getReportCount()
public ReportSheet getReport(int idx)
protected void removeContents()
removeContents in class ReportSheetprotected void resetContents()
resetContents in class ReportSheetpublic Vector getAllElements()
getAllElements in class inetsoft.report.internal.StyleCorepublic Vector getAllHeaderElements()
getAllHeaderElements in class inetsoft.report.internal.StyleCorepublic Vector getAllFooterElements()
getAllFooterElements in class inetsoft.report.internal.StyleCorepublic void setMargin(Margin margin)
setMargin in class ReportSheetmargin - page margin.public Margin getMargin()
getMargin in class ReportSheetpublic void setHeaderFromEdge(double inch)
setHeaderFromEdge in class ReportSheetinch - header position.public double getHeaderFromEdge()
getHeaderFromEdge in class ReportSheetpublic void setFooterFromEdge(double inch)
setFooterFromEdge in class ReportSheetinch - footer position.public double getFooterFromEdge()
getFooterFromEdge in class ReportSheetpublic Rectangle getHeaderBounds(Dimension pgsize)
getHeaderBounds in class ReportSheetpgsize - page size in pixels.
public Rectangle getFooterBounds(Dimension pgsize)
getFooterBounds in class ReportSheetpgsize - page size in pixels.
public void setCurrentAlignment(int align)
setCurrentAlignment in class ReportSheetalign - alignment flag, a bitwise OR of the H_LEFT, H_CENTER,
H_RIGHT, and V_TOP, V_CENTER, V_BOTTOM.public int getCurrentAlignment()
getCurrentAlignment in class ReportSheetpublic void setCurrentIndent(double inch)
setCurrentIndent in class ReportSheetinch - indentation size.public double getCurrentIndent()
getCurrentIndent in class ReportSheetpublic void setCurrentTabStops(double[] pos)
setCurrentTabStops in class ReportSheetpos - tab stops in inches.public double[] getCurrentTabStops()
getCurrentTabStops in class ReportSheetpublic void setCurrentWrapping(int wrapping)
setCurrentWrapping in class ReportSheetwrapping - one of the WRAP_NONE, WRAP_LEFT, WRAP_RIGHT,
WRAP_BOTH, and WRAP_TOP_BOTTOM.public int getCurrentWrapping()
getCurrentWrapping in class ReportSheetpublic void moveAnchor(Position anchor)
moveAnchor in class ReportSheetanchor - anchor position.public void setCurrentLineSpacing(int spacing)
setCurrentLineSpacing in class ReportSheetspacing - line spacing.public int getCurrentLineSpacing()
getCurrentLineSpacing in class ReportSheetpublic void setCurrentFont(Font font)
setCurrentFont in class ReportSheetfont - current document font.public Font getCurrentFont()
getCurrentFont in class ReportSheetpublic void setCurrentForeground(Color fg)
setCurrentForeground in class ReportSheetfg - foreground color.public Color getCurrentForeground()
getCurrentForeground in class ReportSheetpublic void setCurrentBackground(Color bg)
setCurrentBackground in class ReportSheetbg - background color.public Color getCurrentBackground()
getCurrentBackground in class ReportSheetpublic void setCurrentTableLayout(int autosize)
If the layout is set to TABLE_FIT_PAGE, the width of the table is set to the width of the page, or to the table width explicitly set by the user. The space is distributed to the columns proportional to the preferred width of the columns. The preferred width of a column is returned by the TableLens, or if it's -1, calculated by the ReportSheet based on the contents in the column cells.
If the layout is set to TABLE_EQUAL_WIDTH, the width of the table is set to the width of the page, or to the table width explicitly set by the user. All columns are set to equal width.
If the layout is set to TABLE_FIT_CONTENT, the widht of the columns are determined by the TableLens.getColWidth() return value, or if it's -1, calculated by the ReportSheet based on the contents in the column cells. If a row is wider than the page width, the rows are wrapped. When rows are wrapped, the header columns (determined by TableLens' getHeaderColCount() function) are always drawn at each table segment. When table is wrapped, the ReportSheet tries to fit as many table regions on a page as possible. It can be forced to print one table region per page by using TABLE_FIT_CONTENT_1PP as the table layout.
setCurrentTableLayout in class ReportSheetautosize - layout mode.public int getCurrentTableLayout()
getCurrentTableLayout in class ReportSheetpublic void setCurrentPainterLayout(int policy)
setCurrentPainterLayout in class ReportSheetpolicy - painter layout policy.public int getCurrentPainterLayout()
getCurrentPainterLayout in class ReportSheetpublic void setCurrentPainterMargin(Insets margin)
setCurrentPainterMargin in class ReportSheetmargin - painter external space.public Insets getCurrentPainterMargin()
getCurrentPainterMargin in class ReportSheetpublic void setCurrentCellPadding(Insets padding)
setCurrentCellPadding in class ReportSheetpadding - cell padding space.public Insets getCurrentCellPadding()
getCurrentCellPadding in class ReportSheetpublic void setCurrentTableWidth(double inch)
setCurrentTableWidth in class ReportSheetinch - table width.public double getCurrentTableWidth()
getCurrentTableWidth in class ReportSheet
public void addPresenter(Class type,
Presenter p)
addPresenter in class ReportSheettype - type of the values to present.p - presenter object.public Presenter getPresenter(Class type)
getPresenter in class ReportSheettype - class to search for.
public void removePresenter(Class type)
removePresenter in class ReportSheettype - object type.public void clearPresenter()
clearPresenter in class ReportSheet
public void addFormat(Class type,
Format p)
addFormat in class ReportSheettype - type of the values to present.p - format object.public Format getFormat(Class type)
getFormat in class ReportSheettype - class to search for.
public void removeFormat(Class type)
removeFormat in class ReportSheettype - object type.public void clearFormat()
clearFormat in class ReportSheetpublic void setCurrentHeader(int hflag)
setCurrentHeader in class ReportSheethflag - header flag.public void setCurrentHeader(String eid)
setCurrentHeader in class ReportSheeteid - element ID.public void setCurrentFooter(int hflag)
setCurrentFooter in class ReportSheethflag - footer flag.public void setCurrentFooter(String eid)
setCurrentFooter in class ReportSheeteid - element ID.public void setCurrentJustify(boolean justify)
setCurrentJustify in class ReportSheetjustify - text justification.public boolean isCurrentJustify()
isCurrentJustify in class ReportSheetpublic void setCurrentTextAdvance(int textadv)
setCurrentTextAdvance in class ReportSheettextadv - text element advance pixels.public int getCurrentTextAdvance()
getCurrentTextAdvance in class ReportSheetpublic void setCurrentTableAdvance(int tableadv)
setCurrentTableAdvance in class ReportSheettableadv - table element advance pixels.public int getCurrentTableAdvance()
getCurrentTableAdvance in class ReportSheetpublic void setCurrentTableOrphanControl(boolean orphan)
setCurrentTableOrphanControl in class ReportSheetorphan - true to eliminate widow/orphan lines.public boolean isCurrentTableOrphanControl()
isCurrentTableOrphanControl in class ReportSheetpublic void setCurrentOrphanControl(boolean orphan)
setCurrentOrphanControl in class ReportSheetorphan - true to eliminate widow/orphan lines.public boolean isCurrentOrphanControl()
isCurrentOrphanControl in class ReportSheetpublic String addHeaderObject(Object obj)
If there is no presenter registered at the document for this type of object, the ReportSheet then check if a Format is register for this class. If there is a Format, it's used to format the object into string and treated as a regular text.
If there is no format registered for this object type, the object is converted to a string (toString()). The string is process in the same way as the addHeaderText() string.
addHeaderObject in class ReportSheetobj - object value.
public String addHeaderText(String text)
addHeaderText in class ReportSheettext - text string.
public String addHeaderText(TextLens text)
addHeaderText in class ReportSheettext - text content lens.
public String addHeaderTextBox(TextLens text)
addHeaderTextBox in class ReportSheettext - text content.
public String addHeaderTextBox(TextLens text,
int border,
double winch,
double hinch,
int talign)
addHeaderTextBox in class ReportSheettext - text content.border - border line style. One of the line styles defined in
the StyleConstants class.winch - area width in inches.hinch - area height in inches.talign - text alignment
public String addHeaderPainter(Painter area)
addHeaderPainter in class ReportSheetarea - the painter element.
public String addHeaderPainter(Painter area,
double winch,
double hinch)
addHeaderPainter in class ReportSheetarea - the painter element.winch - area width in inches.hinch - area height in inches.
public String addHeaderImage(Image image)
addHeaderImage in class ReportSheetimage - image object.
public String addHeaderImage(Image image,
double winch,
double hinch)
addHeaderImage in class ReportSheetimage - image to paint.winch - area width in inches.hinch - area height in inches.
public String addHeaderImage(URL image)
addHeaderImage in class ReportSheetimage - image URL.
public String addHeaderSpace(int pixels)
addHeaderSpace in class ReportSheetpixels - space in pixels.
public String addHeaderNewline(int n)
addHeaderNewline in class ReportSheetn - number of newline.
public String addHeaderBreak()
addHeaderBreak in class ReportSheetpublic String addHeaderSeparator(int style)
addHeaderSeparator in class ReportSheetstyle - the line style (defined in StyleConstants).
public String addHeaderTab(int fill)
addHeaderTab in class ReportSheetfill - a line style defined in StyleConstants.
public String addHeaderTable(TableLens table)
addHeaderTable in class ReportSheettable - table lens.
public String addFooterObject(Object obj)
If there is no presenter registered at the document for this type of object, the ReportSheet then check if a Format is register for this class. If there is a Format, it's used to format the object into string and treated as a regular text.
If there is no format registered for this object type, the object is converted to a string (toString()). The string is process in the same way as the addFooterText() string.
addFooterObject in class ReportSheetobj - object value.
public String addFooterText(String text)
addFooterText in class ReportSheettext - text string.
public String addFooterText(TextLens text)
addFooterText in class ReportSheettext - text content lens.
public String addFooterTextBox(TextLens text)
addFooterTextBox in class ReportSheettext - text content.
public String addFooterTextBox(TextLens text,
int border,
double winch,
double hinch,
int talign)
addFooterTextBox in class ReportSheettext - text content.border - border line style. One of the line styles defined in
the StyleConstants class.winch - area width in inches.hinch - area height in inches.talign - text alignment.
public String addFooterPainter(Painter area)
addFooterPainter in class ReportSheetarea - the painter element.
public String addFooterPainter(Painter area,
double winch,
double hinch)
addFooterPainter in class ReportSheetarea - the painter element.winch - area width in inches.hinch - area height in inches.
public String addFooterImage(Image image)
addFooterImage in class ReportSheetimage - image object.
public String addFooterImage(Image image,
double winch,
double hinch)
addFooterImage in class ReportSheetimage - image to paint.winch - area width in inches.hinch - area height in inches.
public String addFooterImage(URL image)
addFooterImage in class ReportSheetimage - image URL.
public String addFooterSpace(int pixels)
addFooterSpace in class ReportSheetpixels - space in pixels.
public String addFooterNewline(int n)
addFooterNewline in class ReportSheetn - number of newline.
public String addFooterBreak()
addFooterBreak in class ReportSheetpublic String addFooterSeparator(int style)
addFooterSeparator in class ReportSheetstyle - the line style (defined in StyleConstants).
public String addFooterTab(int fill)
addFooterTab in class ReportSheetfill - a line style defined in StyleConstants.
public String addFooterTable(TableLens table)
addFooterTable in class ReportSheettable - table lens.
public ReportElement getElement(String id)
getElement in class ReportSheetid - element ID.
public String addHeaderElement(ReportElement e)
addHeaderElement in class ReportSheete - document element.
public int getHeaderElementCount()
getHeaderElementCount in class ReportSheetpublic ReportElement getHeaderElement(int idx)
getHeaderElement in class ReportSheetidx - element index.
public int getHeaderElementIndex(ReportElement e)
getHeaderElementIndex in class ReportSheete - element.
public void removeHeaderElement(int idx)
removeHeaderElement in class ReportSheetidx - element index.
public void insertHeaderElement(int idx,
ReportElement e)
insertHeaderElement in class ReportSheetidx - position to insert.e - element.public String addFooterElement(ReportElement e)
addFooterElement in class ReportSheete - document element.
public int getFooterElementCount()
getFooterElementCount in class ReportSheetpublic ReportElement getFooterElement(int idx)
getFooterElement in class ReportSheetidx - element index.
public int getFooterElementIndex(ReportElement e)
getFooterElementIndex in class ReportSheete - element.
public void removeFooterElement(int idx)
removeFooterElement in class ReportSheetidx - element index.
public void insertFooterElement(int idx,
ReportElement e)
insertFooterElement in class ReportSheetidx - position to insert.e - element.public Vector getElements(int type)
getElements in class ReportSheettype - element type.
public boolean printNext(StylePage pg)
A StylePage contains information on how to print a particular page. Its print() method can be used to perform the actual printing of the page contents to a printer graphics.
printNext in class ReportSheetpg - style page.public boolean printNextPage(StylePage pg)
printNextPage in class ReportSheetpublic Integer getNextOrientation()
getNextOrientation in class ReportSheetpublic Size getPageSize()
getPageSize in class ReportSheetpublic void addPageBreakListener(PageBreakListener l)
addPageBreakListener in class ReportSheetpublic void removePageBreakListener(PageBreakListener l)
removePageBreakListener in class ReportSheetprotected void printHeaderFooter(StylePage pg)
printHeaderFooter in class ReportSheetpg - a style page.public UserVariable getParameter(int idx)
getParameter in class ReportSheetidx - parameter index.
public int getParameterCount()
getParameterCount in class ReportSheetpublic void addParameter(UserVariable param)
addParameter in class ReportSheetpublic void removeAllParameters()
removeAllParameters in class ReportSheetpublic void removeParameter(int idx)
removeParameter in class ReportSheetpublic void setParameterSheets(String[] sheets)
setParameterSheets in class ReportSheetpublic String[] getParameterSheets()
getParameterSheets in class ReportSheetpublic void setPrintMode(boolean printMode)
setPrintMode in class inetsoft.report.internal.StyleCoreprintMode - true to turn on print mode,
false to turn it off.public void setReportMode(int mode)
setReportMode in class inetsoft.report.internal.StyleCoremode - the following value defined in StyleConstants is legal:
RUN_MODE, PREVIEW_MODE, DESIGN_MODEpublic void setScriptEnv(inetsoft.report.internal.ReportScriptEnv scriptenv)
setScriptEnv in class inetsoft.report.internal.StyleCorepublic void resetScriptEnv()
resetScriptEnv in class inetsoft.report.internal.StyleCorepublic void deleteScriptEnv()
deleteScriptEnv in class inetsoft.report.internal.StyleCore
public void addScriptObject(String name,
Object obj)
addScriptObject in class inetsoft.report.internal.StyleCorepublic void resetOnLoad()
resetOnLoad in class inetsoft.report.internal.StyleCorepublic void runOnLoad()
runOnLoad in class inetsoft.report.internal.StyleCorepublic void runOnInit()
runOnInit in class inetsoft.report.internal.StyleCorepublic void runOnPrint()
runOnPrint in class inetsoft.report.internal.StyleCorepublic void setVariableTable(VariableTable vars)
setVariableTable in class inetsoft.report.internal.StyleCorepublic void clear()
clear in class ReportSheetpublic void reset()
reset in class ReportSheet
public void setVisible(String id,
boolean vis)
setVisible in class ReportSheetid - element id.vis - true to show element and false to hide it.public String getProperty(String name)
getProperty in class ReportSheetname - property name.
public void setProperty(String name,
String val)
PageSize - a string in the form of: WIDTHxHEIGHT, e.g. 8.5x11. Or a string value of a Size object or constant. Orientation - a string of either 'Landscape', 'Portrait', or the string value of the orientation option.The hints may or may not be honored depending on the platform. For example, page size and orientation can not be changed programmatically on JDK1.1, so the hints are ignored and the user has to set those options on the printer dialog.
setProperty in class ReportSheetname - property name.val - property value.public void setPageNumberingStart(int idx)
setPageNumberingStart in class ReportSheetidx - the page index where the page numbering starts. The
page would be page one.public void removeElement(String id)
removeElement in class ReportSheetid - element id in string format.
public void replaceElement(String id,
ReportElement e)
replaceElement in class ReportSheetid - element id in string format.
public void moveElement(String id,
int direction)
moveElement in class ReportSheetid - element id in string format.direction - move direction, can be one of ReportSheet.UP or
ReportSheet.DOWN.
|
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 | ||||||||