Style Intelligence v12.0

inetsoft.report
Class CompositeSheet

java.lang.Object
  extended by inetsoft.uql.asset.AbstractAssetEngine
      extended by inetsoft.report.internal.StyleCore
          extended by inetsoft.report.ReportSheet
              extended by inetsoft.report.CompositeSheet
All Implemented Interfaces:
inetsoft.report.internal.ParameterSheetRepository, StyleConstants, AssetRepository, XConstants, XFormulaRepository, XLocalQueryRepository, XQueryRepository, Serializable, Cloneable

public class CompositeSheet
extends ReportSheet

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.

See Also:
Serialized Form

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.StyleConstants
ARROW_LINE_1, ARROW_LINE_2, ARROW_LINE_3, BACKGROUND_CENTER, BACKGROUND_TILED, BOX_RECTANGLE, BOX_ROUNDED_RECTANGLE, CENTER, CHART_3D_BAR, CHART_3D_BAR_3D, CHART_3D_PIE, CHART_3D_STACK_BAR, CHART_AREA, CHART_BAR, CHART_BUBBLE, CHART_CANDLE, CHART_CURVE, CHART_FILL_RADAR, CHART_GANTT, CHART_INV_BAR, CHART_INV_CURVE, CHART_INV_LINE, CHART_INV_POINT, CHART_INV_STACK_BAR, CHART_LINE, CHART_MAX_USER, CHART_PARETO, CHART_PIE, CHART_PIE_EXPLODED_ALL, CHART_PIE_EXPLODED_FIRST, CHART_PIE_EXPLODED_NONE, CHART_POINT, CHART_RADAR, CHART_RIBBON, CHART_SCATTER, CHART_SPEEDOMETER, CHART_STACK_AREA, CHART_STACK_BAR, CHART_STICK, CHART_STOCK, CHART_SURFACE, CHART_USER, CHART_VOLUME, CHART_WATERFALL, CHART_XY_LINE, CIRCLE, CROSS, CURRENCY, DASH_LINE, DASH_MASK, DEFAULT_PAGE_SIZE, DIAMOND, DOT_LINE, DOUBLE_3D_LOWERED, DOUBLE_3D_RAISED, DOUBLE_LINE, DOUBLE_MASK, FILL, FILLED_CIRCLE, FILLED_DIAMOND, FILLED_SQUARE, FILLED_TRIANGLE, FRACTION_WIDTH_MASK, H_ALIGN_MASK, H_CENTER, H_CURRENCY, H_LEFT, H_LINE, H_RIGHT, LANDSCAPE, LARGE_DASH, LEFT, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE, LINEJOIN_BEVEL, LINEJOIN_MITER, LINEJOIN_ROUND, LOWERED_3D, LOWERED_MASK, LT_ANGLE, MEDIUM_DASH, MEDIUM_LINE, NIL, NO_BORDER, NONE, PAPER_10X11, PAPER_10X14, PAPER_11X17, PAPER_15X11, PAPER_9X11, PAPER_A_PLUS, PAPER_A2, PAPER_A3, PAPER_A3_EXTRA, PAPER_A3_EXTRA_TRANSVERSE, PAPER_A3_TRANSVERSE, PAPER_A4, PAPER_A4_EXTRA, PAPER_A4_PLUS, PAPER_A4_TRANSVERSE, PAPER_A4SMALL, PAPER_A5, PAPER_A5_EXTRA, PAPER_A5_TRANSVERSE, PAPER_B_PLUS, PAPER_B4, PAPER_B5, PAPER_B5_EXTRA, PAPER_B5_TRANSVERSE, PAPER_CSHEET, PAPER_DSHEET, PAPER_ENV_10, PAPER_ENV_11, PAPER_ENV_12, PAPER_ENV_14, PAPER_ENV_9, PAPER_ENV_B4, PAPER_ENV_B5, PAPER_ENV_B6, PAPER_ENV_C3, PAPER_ENV_C4, PAPER_ENV_C5, PAPER_ENV_C6, PAPER_ENV_C65, PAPER_ENV_DL, PAPER_ENV_INVITE, PAPER_ENV_ITALY, PAPER_ENV_MONARCH, PAPER_ENV_PERSONAL, PAPER_ESHEET, PAPER_EXECUTIVE, PAPER_FANFOLD_LGL_GERMAN, PAPER_FANFOLD_STD_GERMAN, PAPER_FANFOLD_US, PAPER_FOLIO, PAPER_ISO_B4, PAPER_JAPANESE_POSTCARD, PAPER_LEDGER, PAPER_LEGAL, PAPER_LEGAL_EXTRA, PAPER_LETTER, PAPER_LETTER_EXTRA, PAPER_LETTER_EXTRA_TRANSVERSE, PAPER_LETTER_PLUS, PAPER_LETTER_TRANSVERSE, PAPER_LETTERSMALL, PAPER_NOTE, PAPER_QUARTO, PAPER_STATEMENT, PAPER_TABLOID, PAPER_TABLOID_EXTRA, PATTERN_0, PATTERN_1, PATTERN_10, PATTERN_11, PATTERN_12, PATTERN_13, PATTERN_14, PATTERN_15, PATTERN_16, PATTERN_17, PATTERN_18, PATTERN_19, PATTERN_2, PATTERN_3, PATTERN_4, PATTERN_5, PATTERN_6, PATTERN_7, PATTERN_8, PATTERN_9, PATTERN_NONE, PORTRAIT, RAISED_3D, RAISED_MASK, REMAINDER, RIGHT, RIGHT_ANGLE, SOLID_MASK, SQUARE, STAR, THICK_LINE, THIN_LINE, THIN_THIN_LINE, TRAY_AUTO, TRAY_CASSETTE, TRAY_ENVELOPE, TRAY_ENVMANUAL, TRAY_FORMSOURCE, TRAY_LARGECAPACITY, TRAY_LARGEFMT, TRAY_LOWER, TRAY_MANUAL, TRAY_MIDDLE, TRAY_ONLYONE, TRAY_SMALLFMT, TRAY_TRACTOR, TRAY_UPPER, TRIANGLE, ULTRA_THIN_LINE, V_ALIGN_MASK, V_ANGLE, V_BASELINE, V_BOTTOM, V_CENTER, V_LINE, V_TOP, WIDTH_MASK, X
 
Fields inherited from interface inetsoft.uql.XConstants
AM_PM_DATE_GROUP, AM_PM_OF_DAY_DATE_GROUP, AVERAGE_FORMULA, CALC_FORMULA, COLUMN, CONCAT_FORMULA, CONDITION_EMPTY_STRING, CONDITION_NULL_STRING, CONDITION_NULL_VALUE, CONDITION_REAL_NULL, CORRELATION_FORMULA, COUNT_FORMULA, COVARIANCE_FORMULA, CURRENCY_FORMAT, CURRENT_REP_CHANGED, CURRENT_REP_WILL_CHANGE, DATE_FORMAT, DAY_DATE_GROUP, DAY_OF_MONTH_DATE_GROUP, DAY_OF_WEEK_DATE_GROUP, DAY_OF_YEAR_DATE_GROUP, DECIMAL_FORMAT, DISTINCTCOUNT_FORMULA, FIRST_FORMULA, FULL_JOIN, GREATER_EQUAL_JOIN, GREATER_JOIN, GROUP_OTHERS, HOUR_DATE_GROUP, HOUR_OF_DAY_DATE_GROUP, INNER_JOIN, JOIN, LAST_FORMULA, LEAVE_OTHERS, LEFT_JOIN, LESS_EQUAL_JOIN, LESS_JOIN, MAX_FORMULA, MEDIAN_FORMULA, MESSAGE_FORMAT, MILLISECOND_DATE_GROUP, MIN_FORMULA, MINUTE_DATE_GROUP, MODE_FORMULA, MONTH_DATE_GROUP, MONTH_OF_YEAR_DATE_GROUP, NONE_DATE_GROUP, NONE_FORMULA, NOT_EQUAL_JOIN, NTHLARGEST_FORMULA, NTHMOSTFREQUENT_FORMULA, NTHSMALLEST_FORMULA, PARAM_PREFIX, PART_DATE_GROUP, PERCENT_FORMAT, PERCENTAGE_BY_COL, PERCENTAGE_BY_ROW, PERCENTAGE_NONE, PERCENTAGE_OF_COL_GRANDTOTAL, PERCENTAGE_OF_COL_GROUP, PERCENTAGE_OF_GRANDTOTAL, PERCENTAGE_OF_GROUP, PERCENTAGE_OF_ROW_GRANDTOTAL, PERCENTAGE_OF_ROW_GROUP, POPULATIONSTANDARDDEVIATION_FORMULA, POPULATIONVARIANCE_FORMULA, PRODUCT_FORMULA, PTHPERCENTILE_FORMULA, QUARTER_DATE_GROUP, QUARTER_OF_YEAR_DATE_GROUP, RIGHT_JOIN, SECOND_DATE_GROUP, SET_FORMULA, SORT_ASC, SORT_DESC, SORT_NONE, SORT_ORIGINAL, SORT_SPECIFIC, SORT_VALUE_ASC, SORT_VALUE_DESC, STANDARDDEVIATION_FORMULA, SUB_QUERY_PARAM, SUM_FORMULA, SUMSQ_FORMULA, SUMWT_FORMULA, VARIANCE_FORMULA, WEEK_DATE_GROUP, WEEK_OF_MONTH_DATE_GROUP, WEEK_OF_YEAR_DATE_GROUP, WEIGHTEDAVERAGE_FORMULA, YEAR_DATE_GROUP
 
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.ReportSheet
addExecuteListener, addFooterRightTab, addFooterSection, addFooterSection, addFormat, addFormula, addHeaderRightTab, addHeaderSection, addHeaderSection, addParameter, addPresenter, addRefreshListener, addRunningTotal, clone, clone, containsFormula, copyFormulas, copyReportSheet, copyReportSheet, exportQueries, fireExecuteEvent, firePageBreakEvent, getAllFooterElementCount, getAllHeaderElementCount, getBackground, getBackgroundLayout, getBackgroundSize, getContextName, getCSSLocation, getCurrentLineId, getCurrentMargin, getCurrentSeparatorAdvance, getDataSet, getDirectory, getExecuteListeners, getExportInfo, getForm, getFormula, getFormulas, getFormulas, getImportInfo, getLocale, getMaxPages, getMaxPages, getMetaTemplate, getOnInit, getOnLoad, getOnPageBreak, getOnPrint, getOrientation, getPageNumberingStart, getParameters, getParameterSheetFlow, getParentReport, getPrinterMargin, getQueries, getQuery, getQueryNames, getQueryType, getRunningTotal, getRunningTotalCount, getSharedFilter, getTable, getTableStyle, getText, getVersion, importQueries, isExportSinglePage, isFromMetaTemplate, isHorizontalWrap, isLandscape, isParameterPrompting, isSinglePageForTopReport, isVisible, keepWithNext, mergeInto, moveHeaderFooterElement, print, print, printNextArea, printNextLine, printNonFlowAreas, refreshFormats, removeContext, removeElementHeaderFooter, removeExecuteListener, removeExecuteListeners, removeFormula, removeHeaderFooterElement, removeQuery, removeRunningTotal, replaceFooterElement, replaceFormulaInfo, replaceHeaderElement, replaceHeaderFooterElement, resetPageNumbering, saveContext, selectContext, setBackground, setBackgroundLayout, setBackgroundSize, setBackgroundSize, setContextName, setCSSLocation, setCurrentLineId, setCurrentSeparatorAdvance, setDirectory, setElement, setFormulaInfos, setHorizontalWrap, setLocale, setMaxPages, setMetaTemplate, setOnInit, setOnLoad, setOnPageBreak, setOnPrint, setOrientation, setPageSize, setParameterPrompting, setParameterSheet, setParameterSheetFlow, setParentReport, setPrinterMargin, setQuery, setSharedFilter, setTableStyle, setVersion, syncSourceInfo, syncSourceInfo, updateQuery
 
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 inetsoft.uql.asset.AbstractAssetEngine
addAssetChangeListener, addFolder, allowsFolderScopeChange, allowsSheetScopeChange, changeFolder, changeFolder0, changeSheet, changeSheet0, checkAssetPermission, checkDependencyValidity, checkFolderRemoveable, checkPermission, clearCache, clearVSBookmark, closeStorages, containsEntry, createPhysicalEntry, dispose, finalize, fireEvent, getAssetPrefix, getDependencyFileKey, getDesignView, getEntries, getEntries, getEntryIdentifier, getParent, getParentFolder, getQueryEntries, getQuotaManager, getReportSheetDependencies, getReportStorage, getSession, getSheetDependencies, getStorage, getStorage, getStorages, getVSBookmark, getWorksheetEntries, initFinder, isEntryAvailable, removeAssetChangeListener, removeFolder, removeFolder0, removeSheet, removeSheet0, removeUser, renameUser, setParent, setSheet, setSheet, setVSBookmark, supportsScope
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompositeSheet

public CompositeSheet(ReportSheet[] sheets)
Create a composite report.


CompositeSheet

public CompositeSheet(ReportSheet[] sheets,
                      boolean contiguous)
Create a composite report, specifying if contiguous page numbers.

Method Detail

getReportCount

public int getReportCount()
Get the number of reports in this composite report.


getReport

public ReportSheet getReport(int idx)
Get the specified report in this composite report.


removeContents

protected void removeContents()
Remove all elements from the contents area.

Specified by:
removeContents in class ReportSheet

resetContents

protected void resetContents()
Reset all elemnts in the contents.

Specified by:
resetContents in class ReportSheet

getAllElements

public Vector getAllElements()
Get all elements in the report, including body, and non-flow area elements.

Specified by:
getAllElements in class inetsoft.report.internal.StyleCore
Returns:
vector of all elements.

getAllHeaderElements

public Vector getAllHeaderElements()
Get all header elements in the report, including headers, element associated headers.

Overrides:
getAllHeaderElements in class inetsoft.report.internal.StyleCore
Returns:
vector of all header elements.

getAllFooterElements

public Vector getAllFooterElements()
Get all footer elements in the report, including footers, element associated footers.

Overrides:
getAllFooterElements in class inetsoft.report.internal.StyleCore
Returns:
vector of of all footer elements.

setMargin

public void setMargin(Margin margin)
Set the page margin. The unit is in inches.

Overrides:
setMargin in class ReportSheet
Parameters:
margin - page margin.

getMargin

public Margin getMargin()
Get the page margin in inches.

Overrides:
getMargin in class ReportSheet
Returns:
page margin.

setHeaderFromEdge

public void setHeaderFromEdge(double inch)
Set the page header position from the top of the page. The unit is in inches. HeaderFromEdge and top page margin determine the location and size of page headers.

Overrides:
setHeaderFromEdge in class ReportSheet
Parameters:
inch - header position.

getHeaderFromEdge

public double getHeaderFromEdge()
Get the page header position from the top of the page. The unit is in inches.

Overrides:
getHeaderFromEdge in class ReportSheet
Returns:
header position.

setFooterFromEdge

public void setFooterFromEdge(double inch)
Set the page footer position from the bottom of the page. The unit is in inches. The FooterFromEdge and bottom page margin determine the position and size of page footers.

Overrides:
setFooterFromEdge in class ReportSheet
Parameters:
inch - footer position.

getFooterFromEdge

public double getFooterFromEdge()
Get the page footer position from the bottom of the page. The unit is in inches.

Overrides:
getFooterFromEdge in class ReportSheet
Returns:
footer position.

getHeaderBounds

public Rectangle getHeaderBounds(Dimension pgsize)
Get the page header bounds.

Overrides:
getHeaderBounds in class ReportSheet
Parameters:
pgsize - page size in pixels.
Returns:
header region.

getFooterBounds

public Rectangle getFooterBounds(Dimension pgsize)
Get the page footer bounds.

Overrides:
getFooterBounds in class ReportSheet
Parameters:
pgsize - page size in pixels.
Returns:
footer region.

setCurrentAlignment

public void setCurrentAlignment(int align)
Set the current alignment of the report elements. The alignment is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentAlignment in class ReportSheet
Parameters:
align - alignment flag, a bitwise OR of the H_LEFT, H_CENTER, H_RIGHT, and V_TOP, V_CENTER, V_BOTTOM.

getCurrentAlignment

public int getCurrentAlignment()
Get the current setting of the alignment.

Overrides:
getCurrentAlignment in class ReportSheet
Returns:
alignment flag.

setCurrentIndent

public void setCurrentIndent(double inch)
Set the current indentation level. The value is in inches. The indent is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentIndent in class ReportSheet
Parameters:
inch - indentation size.

getCurrentIndent

public double getCurrentIndent()
Get the current indentation in inches.

Overrides:
getCurrentIndent in class ReportSheet
Returns:
indentation.

setCurrentTabStops

public void setCurrentTabStops(double[] pos)
Set the tab stops.

Overrides:
setCurrentTabStops in class ReportSheet
Parameters:
pos - tab stops in inches.

getCurrentTabStops

public double[] getCurrentTabStops()
Return the current tab stop setting.

Overrides:
getCurrentTabStops in class ReportSheet
Returns:
tab stop positions in inches.

setCurrentWrapping

public void setCurrentWrapping(int wrapping)
Set the current wrapping style. This affects how the text around a Painter/Image/TextBox is wrapped.

Overrides:
setCurrentWrapping in class ReportSheet
Parameters:
wrapping - one of the WRAP_NONE, WRAP_LEFT, WRAP_RIGHT, WRAP_BOTH, and WRAP_TOP_BOTTOM.

getCurrentWrapping

public int getCurrentWrapping()
Get the current wrapping style.

Overrides:
getCurrentWrapping in class ReportSheet
Returns:
wrapping option.

moveAnchor

public void moveAnchor(Position anchor)
Move the anchor to the new position. The anchor is relative to the bottom of the last element, and the left paintable edge of the page. If the anchor Y is negative, it's treated as the distance from the top of the last element. If the anchor X is positive, it's the distance from the left edge of the page area, otherwise, it's the distance from the right edge of the page area. The next element is placed at the new anchor position. This only affects fixed size elements, Painter, Chart, Component, and Image.

Overrides:
moveAnchor in class ReportSheet
Parameters:
anchor - anchor position.

setCurrentLineSpacing

public void setCurrentLineSpacing(int spacing)
Set the current line spacing in pixels. The line spacing is the space between the two lines. The line spacing parameter is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentLineSpacing in class ReportSheet
Parameters:
spacing - line spacing.

getCurrentLineSpacing

public int getCurrentLineSpacing()
Get the current line spacing setting.

Overrides:
getCurrentLineSpacing in class ReportSheet
Returns:
line spacing.

setCurrentFont

public void setCurrentFont(Font font)
Set the current font of the document. The font will be used by the text elements and possibly table elements. In the case of table, if a font is returned from the TableLens, it's always used. Otherwise, the current font is used. The font is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentFont in class ReportSheet
Parameters:
font - current document font.

getCurrentFont

public Font getCurrentFont()
Get the current font setting.

Overrides:
getCurrentFont in class ReportSheet
Returns:
current document font.

setCurrentForeground

public void setCurrentForeground(Color fg)
Set the current document foreground color. The foreground color is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentForeground in class ReportSheet
Parameters:
fg - foreground color.

getCurrentForeground

public Color getCurrentForeground()
Get the current document foreground color.

Overrides:
getCurrentForeground in class ReportSheet
Returns:
foreground color.

setCurrentBackground

public void setCurrentBackground(Color bg)
Set the current document background color. The background color is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentBackground in class ReportSheet
Parameters:
bg - background color.

getCurrentBackground

public Color getCurrentBackground()
Get the current document background color.

Overrides:
getCurrentBackground in class ReportSheet
Returns:
background color.

setCurrentTableLayout

public void setCurrentTableLayout(int autosize)
Set the current table layout mode. The available modes are: TABLE_FIT_PAGE, TABLE_FIT_CONTENT, TABLE_EQUAL_WIDTH, and TABLE_FIT_CONTENT_1PP. The table layout mode is effective after the call, and will be used by all elements added after the call upto the next call of this method.

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.

Overrides:
setCurrentTableLayout in class ReportSheet
Parameters:
autosize - layout mode.

getCurrentTableLayout

public int getCurrentTableLayout()
Get the current table layout mode.

Overrides:
getCurrentTableLayout in class ReportSheet
Returns:
layout mode.

setCurrentPainterLayout

public void setCurrentPainterLayout(int policy)
Set the layout policy for painter. If the layout is set to the PAINTER_NON_BREAK, the painter is always printed in one area. If the painter's preferred size is greater than the space left in the current page, the painter is printed on the top of the next page. If the layout is set to the PAINTER_BREAKABLE, the painter is printed with whatever space in the page, and may possibly span across multiple pages.

Overrides:
setCurrentPainterLayout in class ReportSheet
Parameters:
policy - painter layout policy.

getCurrentPainterLayout

public int getCurrentPainterLayout()
Get the current painter layout policy.

Overrides:
getCurrentPainterLayout in class ReportSheet
Returns:
painter layout policy.

setCurrentPainterMargin

public void setCurrentPainterMargin(Insets margin)
Set the space around the painter elements. This controls the painter, text box, and chart elements' external spacing.

Overrides:
setCurrentPainterMargin in class ReportSheet
Parameters:
margin - painter external space.

getCurrentPainterMargin

public Insets getCurrentPainterMargin()
Get the fixed size element external space.

Overrides:
getCurrentPainterMargin in class ReportSheet
Returns:
space around painter elements.

setCurrentCellPadding

public void setCurrentCellPadding(Insets padding)
Set the cell padding space around the cell contents. The default is 1 pixel on top and bottom, and 2 pixel at each side. Padding is only applied to cells where the content is presented as string text. If the content of the cell is other types, such as Image, or if the content has registered presenters, the padding is ignored. In this case the space around the cell content is controlled by the getInsets() in the TableLens only. The padding is effective after the call, and will be used by all elements added after the call upto the next call of this method.

Overrides:
setCurrentCellPadding in class ReportSheet
Parameters:
padding - cell padding space.

getCurrentCellPadding

public Insets getCurrentCellPadding()
Get the current table cell padding.

Overrides:
getCurrentCellPadding in class ReportSheet
Returns:
cell padding setting.

setCurrentTableWidth

public void setCurrentTableWidth(double inch)
Set the width of the table in inches. This parameter is only used if the table layout is set to TABLE_FIT_PAGE or TABLE_EQUAL_WIDTH.

Overrides:
setCurrentTableWidth in class ReportSheet
Parameters:
inch - table width.

getCurrentTableWidth

public double getCurrentTableWidth()
Get the current table width setting.

Overrides:
getCurrentTableWidth in class ReportSheet
Returns:
table width.

addPresenter

public void addPresenter(Class type,
                         Presenter p)
Register a presenter for the specified class. The presenter is used to paint the visual representation of all values of the specified type.

Overrides:
addPresenter in class ReportSheet
Parameters:
type - type of the values to present.
p - presenter object.

getPresenter

public Presenter getPresenter(Class type)
Get the presenter object registered for this class or one of it's super classes.

Overrides:
getPresenter in class ReportSheet
Parameters:
type - class to search for.
Returns:
the presenter for this object.

removePresenter

public void removePresenter(Class type)
Remove the specified presenter from the registry. Objects added before the call are not affected.

Overrides:
removePresenter in class ReportSheet
Parameters:
type - object type.

clearPresenter

public void clearPresenter()
Clear the presenter registry.

Overrides:
clearPresenter in class ReportSheet

addFormat

public void addFormat(Class type,
                      Format p)
Register a format for the specified class. The format is used to convert an object to a string for all values of the specified type.

Overrides:
addFormat in class ReportSheet
Parameters:
type - type of the values to present.
p - format object.

getFormat

public Format getFormat(Class type)
Get the format object registered for this class or one of it's super classes.

Overrides:
getFormat in class ReportSheet
Parameters:
type - class to search for.
Returns:
the format for this object.

removeFormat

public void removeFormat(Class type)
Remove the specified format from the registry. Objects added before the call are not affected.

Overrides:
removeFormat in class ReportSheet
Parameters:
type - object type.

clearFormat

public void clearFormat()
Clear the format registry.

Overrides:
clearFormat in class ReportSheet

setCurrentHeader

public void setCurrentHeader(int hflag)
Set the currently worked on header. All subsequent calls to addHeader???() methods will add the element to the current header. The headers can be either DEFAULT_HEADER, FIRST_PAGE_HEADER, EVEN_PAGE_HEADER, or ODD_PAGE_HEADER.

Overrides:
setCurrentHeader in class ReportSheet
Parameters:
hflag - header flag.

setCurrentHeader

public void setCurrentHeader(String eid)
Set the currently worked on header. The new header is associated with the specified element. The header is used on all pages where this element is printed. If a page contains more than one element with associated header, the header of the last element on the page is used.

Overrides:
setCurrentHeader in class ReportSheet
Parameters:
eid - element ID.

setCurrentFooter

public void setCurrentFooter(int hflag)
Set the currently worked on footer. All subsequent calls to addFooter???() methods will add the element to the current footer. The footers can be either DEFAULT_FOOTER, FIRST_PAGE_FOOTER, EVEN_PAGE_FOOTER, or ODD_PAGE_FOOTER.

Overrides:
setCurrentFooter in class ReportSheet
Parameters:
hflag - footer flag.

setCurrentFooter

public void setCurrentFooter(String eid)
Set the currently worked on footer. The new footer is associated with the specified element. The footer is used on all pages where this element is printed. If a page contains more than one element with associated footer, the footer of the last element on the page is used.

Overrides:
setCurrentFooter in class ReportSheet
Parameters:
eid - element ID.

setCurrentJustify

public void setCurrentJustify(boolean justify)
If justify is set to true, text lines are fully justified.

Overrides:
setCurrentJustify in class ReportSheet
Parameters:
justify - text justification.

isCurrentJustify

public boolean isCurrentJustify()
Check if text is justified.

Overrides:
isCurrentJustify in class ReportSheet
Returns:
justification setting.

setCurrentTextAdvance

public void setCurrentTextAdvance(int textadv)
Set the amount to advance following each text element. The default advance is 3 pixels.

Overrides:
setCurrentTextAdvance in class ReportSheet
Parameters:
textadv - text element advance pixels.

getCurrentTextAdvance

public int getCurrentTextAdvance()
Get the advance of text elements.

Overrides:
getCurrentTextAdvance in class ReportSheet
Returns:
text advance in pixels.

setCurrentTableAdvance

public void setCurrentTableAdvance(int tableadv)
Set the amount to advance following each table element. The default advance is 3 pixels.

Overrides:
setCurrentTableAdvance in class ReportSheet
Parameters:
tableadv - table element advance pixels.

getCurrentTableAdvance

public int getCurrentTableAdvance()
Get the advance of table elements.

Overrides:
getCurrentTableAdvance in class ReportSheet
Returns:
table advance in pixels.

setCurrentTableOrphanControl

public void setCurrentTableOrphanControl(boolean orphan)
Set the table widow/orphan control option.

Overrides:
setCurrentTableOrphanControl in class ReportSheet
Parameters:
orphan - true to eliminate widow/orphan lines.

isCurrentTableOrphanControl

public boolean isCurrentTableOrphanControl()
Check the current table widow/orphan control setting.

Overrides:
isCurrentTableOrphanControl in class ReportSheet
Returns:
widow/orphan control option.

setCurrentOrphanControl

public void setCurrentOrphanControl(boolean orphan)
Set the widow/orphan line control option.

Overrides:
setCurrentOrphanControl in class ReportSheet
Parameters:
orphan - true to eliminate widow/orphan lines.

isCurrentOrphanControl

public boolean isCurrentOrphanControl()
Check the current widow/orphan control setting.

Overrides:
isCurrentOrphanControl in class ReportSheet
Returns:
widow/orphan control option.

addHeaderObject

public String addHeaderObject(Object obj)
Add an object to the document header. First the ReportSheet checks if a presenter is register for this type of object. If there is a presenter, a PresenterPainter is created to paint the object using the presenter.

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.

Overrides:
addHeaderObject in class ReportSheet
Parameters:
obj - object value.
Returns:
element id.

addHeaderText

public String addHeaderText(String text)
Add a text string to the document header. The header string could be a plain text string, or a text format string similar to the format used by the java.text.MessageFormat class. If a plain string is used, it's printed as the header. Variables can be inserted into the string to construct a message format. The following variables are supported:

Overrides:
addHeaderText in class ReportSheet
Parameters:
text - text string.
Returns:
element id.

addHeaderText

public String addHeaderText(TextLens text)
Add a text element to the document header. The contents of the TextLens is processed in the same way as the addHeaderText(String) parameter.

Overrides:
addHeaderText in class ReportSheet
Parameters:
text - text content lens.
Returns:
element id.

addHeaderTextBox

public String addHeaderTextBox(TextLens text)
Add a text box to the document header. A text box is a standalone area on the document that contains a text string. It has a border around by default. The text box element is similar to the painter elements in that they both use the painter layout and wrapping options. The current setting of the painter layout and wrapping are used by the text box elements as well. The text is not translated as the plain text elements.

Overrides:
addHeaderTextBox in class ReportSheet
Parameters:
text - text content.
Returns:
element id.

addHeaderTextBox

public String addHeaderTextBox(TextLens text,
                               int border,
                               double winch,
                               double hinch,
                               int talign)
Add a text box to the document header. A text box is a standalone area on the document that contains a text string. It has a border around by default. The text box element is similar to the painter elements in that they both use the painter layout and wrapping options. The current setting of the painter layout and wrapping are used by the text box elements as well. The text is not translated as the plain text elements.

Overrides:
addHeaderTextBox in class ReportSheet
Parameters:
text - 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
Returns:
element id.

addHeaderPainter

public String addHeaderPainter(Painter area)
Add a pinter element to the document header. A painter is a self contained object that can paint a document area. It can be used to add any content to the document, through which the program has full control on exact presentation on the document. Painter is the general mechanism used to support some of the more common data types. For example, Component and Image are handled internally by a painter object. The program is free to define its own painter.

Overrides:
addHeaderPainter in class ReportSheet
Parameters:
area - the painter element.
Returns:
element id.

addHeaderPainter

public String addHeaderPainter(Painter area,
                               double winch,
                               double hinch)
This is same as addHeaderPainter() exception an explicit size of the painter area is specified. The specified size (in inches) is the preferred size of this painter on paper, where as the preferred size of the Painter object is treated as the preferred pixels of the area. The pixels in the specified area may be different depending on the resolution of the output media. The image is scaled from the pixel size (returned by Painter.getPreferredSize) to the area defined.

Overrides:
addHeaderPainter in class ReportSheet
Parameters:
area - the painter element.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addHeaderImage

public String addHeaderImage(Image image)
Add an image to the document header.

Overrides:
addHeaderImage in class ReportSheet
Parameters:
image - image object.
Returns:
element id.

addHeaderImage

public String addHeaderImage(Image image,
                             double winch,
                             double hinch)
This is same as addHeaderImage() exception an explicit size of the painter area is specified. The specified size (in inches) is the preferred size of this painter on paper, where as the preferred size of the Painter object is treated as the preferred pixels of the area. The pixels in the specified area may be different depending on the resolution of the output media. The image is scaled from the pixel size (returned by Painter.getPreferredSize) to the area defined.

Overrides:
addHeaderImage in class ReportSheet
Parameters:
image - image to paint.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addHeaderImage

public String addHeaderImage(URL image)
Add an image to the document header.

Overrides:
addHeaderImage in class ReportSheet
Parameters:
image - image URL.
Returns:
element id.

addHeaderSpace

public String addHeaderSpace(int pixels)
Add horizontal space to the document header. The space is added after the current element.

Overrides:
addHeaderSpace in class ReportSheet
Parameters:
pixels - space in pixels.
Returns:
element id.

addHeaderNewline

public String addHeaderNewline(int n)
Add one or more newline to the document header.

Overrides:
addHeaderNewline in class ReportSheet
Parameters:
n - number of newline.
Returns:
element id.

addHeaderBreak

public String addHeaderBreak()
Add a break to the document header.

Overrides:
addHeaderBreak in class ReportSheet
Returns:
element id.

addHeaderSeparator

public String addHeaderSeparator(int style)
Add a separator to header. A separator is a horizontal line in either 3D or plain mode.

Overrides:
addHeaderSeparator in class ReportSheet
Parameters:
style - the line style (defined in StyleConstants).
Returns:
element id.

addHeaderTab

public String addHeaderTab(int fill)
Add a tab. The fill specifies a line style to fill the tab space.

Overrides:
addHeaderTab in class ReportSheet
Parameters:
fill - a line style defined in StyleConstants.
Returns:
element id.

addHeaderTable

public String addHeaderTable(TableLens table)
Add a table to the document header. Because the header contents do not wrap, make sure the table is fairly small and fits into one header area.

Overrides:
addHeaderTable in class ReportSheet
Parameters:
table - table lens.
Returns:
element id.

addFooterObject

public String addFooterObject(Object obj)
Add an object to the document footer. First the ReportSheet checks if a presenter is register for this type of object. If there is a presenter, a PresenterPainter is created to paint the object using the presenter.

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.

Overrides:
addFooterObject in class ReportSheet
Parameters:
obj - object value.
Returns:
element id.

addFooterText

public String addFooterText(String text)
Add a text string to the document footer. The footer string could be a plain text string, or a text format string similar to the format used by the java.text.MessageFormat class. If a plain string is used, it's printed as the footer. Variables can be inserted into the string to construct a message format. The following variables are supported:

Overrides:
addFooterText in class ReportSheet
Parameters:
text - text string.
Returns:
element id.

addFooterText

public String addFooterText(TextLens text)
Add a text element to the document footer. The contents of the TextLens is processed in the same way as the addFooterText(String) parameter.

Overrides:
addFooterText in class ReportSheet
Parameters:
text - text content lens.
Returns:
element id.

addFooterTextBox

public String addFooterTextBox(TextLens text)
Add a text box to the document footer. A text box is a standalone area on the document that contains a text string. It has a border around by default. The text box element is similar to the painter elements in that they both use the painter layout and wrapping options. The current setting of the painter layout and wrapping are used by the text box elements as well. The text is not translated as the plain text elements.

Overrides:
addFooterTextBox in class ReportSheet
Parameters:
text - text content.
Returns:
element id.

addFooterTextBox

public String addFooterTextBox(TextLens text,
                               int border,
                               double winch,
                               double hinch,
                               int talign)
Add a text box to the document footer. A text box is a standalone area on the document that contains a text string. It has a border around by default. The text box element is similar to the painter elements in that they both use the painter layout and wrapping options. The current setting of the painter layout and wrapping are used by the text box elements as well. The text is not translated as the plain text elements.

Overrides:
addFooterTextBox in class ReportSheet
Parameters:
text - 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.
Returns:
element id.

addFooterPainter

public String addFooterPainter(Painter area)
Add a pinter element to the document footer. A painter is a self contained object that can paint a document area. It can be used to add any content to the document, through which the program has full control on exact presentation on the document. Painter is the general mechanism used to support some of the more common data types. For example, Component and Image are handled internally by a painter object. The program is free to define its own painter.

Overrides:
addFooterPainter in class ReportSheet
Parameters:
area - the painter element.
Returns:
element id.

addFooterPainter

public String addFooterPainter(Painter area,
                               double winch,
                               double hinch)
This is same as addFooterPainter() exception an explicit size of the painter area is specified. The specified size (in inches) is the preferred size of this painter on paper, where as the preferred size of the Painter object is treated as the preferred pixels of the area. The pixels in the specified area may be different depending on the resolution of the output media. The image is scaled from the pixel size (returned by Painter.getPreferredSize) to the area defined.

Overrides:
addFooterPainter in class ReportSheet
Parameters:
area - the painter element.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addFooterImage

public String addFooterImage(Image image)
Add an image to the document footer.

Overrides:
addFooterImage in class ReportSheet
Parameters:
image - image object.
Returns:
element id.

addFooterImage

public String addFooterImage(Image image,
                             double winch,
                             double hinch)
This is same as addFooterImage() exception an explicit size of the painter area is specified. The specified size (in inches) is the preferred size of this painter on paper, where as the preferred size of the Painter object is treated as the preferred pixels of the area. The pixels in the specified area may be different depending on the resolution of the output media. The image is scaled from the pixel size (returned by Painter.getPreferredSize) to the area defined.

Overrides:
addFooterImage in class ReportSheet
Parameters:
image - image to paint.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addFooterImage

public String addFooterImage(URL image)
Add an image to the document footer.

Overrides:
addFooterImage in class ReportSheet
Parameters:
image - image URL.
Returns:
element id.

addFooterSpace

public String addFooterSpace(int pixels)
Add horizontal space to the document footer. The space is added after the current element.

Overrides:
addFooterSpace in class ReportSheet
Parameters:
pixels - space in pixels.
Returns:
element id.

addFooterNewline

public String addFooterNewline(int n)
Add one or more newline to the document footer.

Overrides:
addFooterNewline in class ReportSheet
Parameters:
n - number of newline.
Returns:
element id.

addFooterBreak

public String addFooterBreak()
Add a break to the document footer.

Overrides:
addFooterBreak in class ReportSheet
Returns:
element id.

addFooterSeparator

public String addFooterSeparator(int style)
Add a separator to footer. A separator is a horizontal line in either 3D or plain mode.

Overrides:
addFooterSeparator in class ReportSheet
Parameters:
style - the line style (defined in StyleConstants).
Returns:
element id.

addFooterTab

public String addFooterTab(int fill)
Add a tab. The fill specifies a line style to fill the tab space.

Overrides:
addFooterTab in class ReportSheet
Parameters:
fill - a line style defined in StyleConstants.
Returns:
element id.

addFooterTable

public String addFooterTable(TableLens table)
Add a table to the document footer. Because the footer contents do not wrap, make sure the table is fairly small and fits into one footer area.

Overrides:
addFooterTable in class ReportSheet
Parameters:
table - table lens.
Returns:
element id.

getElement

public ReportElement getElement(String id)
Find the index of the specified element. An element is identified by an unique ID. Null IDs are ignored.

Overrides:
getElement in class ReportSheet
Parameters:
id - element ID.
Returns:
element index or -1 if not found.

addHeaderElement

public String addHeaderElement(ReportElement e)
Add an element to the document header. Classes extending the ReportSheet can extend element classes from the Element, and use this method for adding the element to the document.

Overrides:
addHeaderElement in class ReportSheet
Parameters:
e - document element.
Returns:
element id.

getHeaderElementCount

public int getHeaderElementCount()
Return the number of elements in the document header.

Overrides:
getHeaderElementCount in class ReportSheet
Returns:
number of elements.

getHeaderElement

public ReportElement getHeaderElement(int idx)
Get the specified element in the header.

Overrides:
getHeaderElement in class ReportSheet
Parameters:
idx - element index.
Returns:
document header element.

getHeaderElementIndex

public int getHeaderElementIndex(ReportElement e)
Get the index of the specified element.

Overrides:
getHeaderElementIndex in class ReportSheet
Parameters:
e - element.
Returns:
element index.

removeHeaderElement

public void removeHeaderElement(int idx)
Remove the specified element.

Overrides:
removeHeaderElement in class ReportSheet
Parameters:
idx - element index.

insertHeaderElement

public void insertHeaderElement(int idx,
                                ReportElement e)
Insert the element at specified position (before).

Overrides:
insertHeaderElement in class ReportSheet
Parameters:
idx - position to insert.
e - element.

addFooterElement

public String addFooterElement(ReportElement e)
Add an element to the document footer. Classes extending the ReportSheet can extend element classes from the Element, and use this method for adding the element to the document.

Overrides:
addFooterElement in class ReportSheet
Parameters:
e - document element.
Returns:
element id.

getFooterElementCount

public int getFooterElementCount()
Return the number of elements in the document footer.

Overrides:
getFooterElementCount in class ReportSheet
Returns:
number of elements.

getFooterElement

public ReportElement getFooterElement(int idx)
Get the specified element in the footer.

Overrides:
getFooterElement in class ReportSheet
Parameters:
idx - element index.
Returns:
document footer element.

getFooterElementIndex

public int getFooterElementIndex(ReportElement e)
Get the index of the specified element.

Overrides:
getFooterElementIndex in class ReportSheet
Parameters:
e - element.
Returns:
element index.

removeFooterElement

public void removeFooterElement(int idx)
Remove the specified element.

Overrides:
removeFooterElement in class ReportSheet
Parameters:
idx - element index.

insertFooterElement

public void insertFooterElement(int idx,
                                ReportElement e)
Insert the element at specified position (before).

Overrides:
insertFooterElement in class ReportSheet
Parameters:
idx - position to insert.
e - element.

getElements

public Vector getElements(int type)
Get the elements of the specified type. The type is one of the header or footer types, or zero for the body.

Overrides:
getElements in class ReportSheet
Parameters:
type - element type.
Returns:
elements of specified type.

printNext

public boolean printNext(StylePage pg)
Print one page. Return true if more contents need to be printed. Normally print(PrintJob) should be used for printing. This function is used by print() to print individual pages.

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.

Specified by:
printNext in class ReportSheet
Parameters:
pg - style page.

printNextPage

public boolean printNextPage(StylePage pg)
Print the next page. It may be called to print from a middle of of page provided the printBox is set up correctly before the call.

Specified by:
printNextPage in class ReportSheet

getNextOrientation

public Integer getNextOrientation()
Get the page orientation for the next page. The page orientation can be changed in middle of a report by setting it in PageLayout for StyleSheet, or setting the row orientation in a TabularSheet.

Overrides:
getNextOrientation in class ReportSheet
Returns:
the next page orientation. Null if using default orientation.

getPageSize

public Size getPageSize()
Get the page size for the next report.

Overrides:
getPageSize in class ReportSheet
Returns:
report page size.

addPageBreakListener

public void addPageBreakListener(PageBreakListener l)
Add a pagebreak listener. The listener is notified at end of each page.

Overrides:
addPageBreakListener in class ReportSheet

removePageBreakListener

public void removePageBreakListener(PageBreakListener l)
Remove a pagebreak listener.

Overrides:
removePageBreakListener in class ReportSheet

printHeaderFooter

protected void printHeaderFooter(StylePage pg)
Print the header and footer of the page. The header and footer can not be printed until all pages have been generated because we won't know the total number of pages.

Overrides:
printHeaderFooter in class ReportSheet
Parameters:
pg - a style page.

getParameter

public UserVariable getParameter(int idx)
Get a report parameter definition.

Overrides:
getParameter in class ReportSheet
Parameters:
idx - parameter index.
Returns:
parameter definition.

getParameterCount

public int getParameterCount()
Get the number of parameters defined in this report. The runtime parameters of a report is the union of the parameters defined in the report, and the parameters defined in the queries used in the report. If a parameter is defined in both places, the definition in the report is used.

Overrides:
getParameterCount in class ReportSheet
Returns:
number of parameters defined in the report.

addParameter

public void addParameter(UserVariable param)
Add a new parameter to the report. If a parameter with the same name already exists, the existing definition is replaced by the name parameter definition.

Overrides:
addParameter in class ReportSheet

removeAllParameters

public void removeAllParameters()
Removes all the parameters from the report parameter list.

Overrides:
removeAllParameters in class ReportSheet

removeParameter

public void removeParameter(int idx)
Remove a parameter from the report parameter list.

Overrides:
removeParameter in class ReportSheet

setParameterSheets

public void setParameterSheets(String[] sheets)
Set the parameter sheets for prompting parameter values. One or more parameter sheets (defined in LibManager) can be specified. The parameter sheets are used to prompt for parameter values when a report is opened. If more than one parameter sheets are specified, they are chained and the parameter values are accumulated.

Overrides:
setParameterSheets in class ReportSheet

getParameterSheets

public String[] getParameterSheets()
Get the parameter sheets for this parameter. If no parameter sheet is specified, a default parameter prompting dialog is generated from the report parameter definition.

Overrides:
getParameterSheets in class ReportSheet

setPrintMode

public void setPrintMode(boolean printMode)
Turn on or off the print mode. When a report is in print mode, the onPrint event will be executed.

Overrides:
setPrintMode in class inetsoft.report.internal.StyleCore
Parameters:
printMode - true to turn on print mode, false to turn it off.

setReportMode

public void setReportMode(int mode)
Set the mode of the report.

Overrides:
setReportMode in class inetsoft.report.internal.StyleCore
Parameters:
mode - the following value defined in StyleConstants is legal: RUN_MODE, PREVIEW_MODE, DESIGN_MODE

setScriptEnv

public void setScriptEnv(inetsoft.report.internal.ReportScriptEnv scriptenv)
Set the script runtime.

Overrides:
setScriptEnv in class inetsoft.report.internal.StyleCore

resetScriptEnv

public void resetScriptEnv()
Re-create the script runtime environment from elements.

Overrides:
resetScriptEnv in class inetsoft.report.internal.StyleCore

deleteScriptEnv

public void deleteScriptEnv()
Destroy the script env.

Overrides:
deleteScriptEnv in class inetsoft.report.internal.StyleCore

addScriptObject

public void addScriptObject(String name,
                            Object obj)
Add a script object.

Overrides:
addScriptObject in class inetsoft.report.internal.StyleCore

resetOnLoad

public void resetOnLoad()
Reset onLoad so that the next call to runOnLoad will execute the onLoad script. This is separate from the report reset method so that the onLoad script will not be called multiple times in the process of replet generation, for example, but only when needed.

Overrides:
resetOnLoad in class inetsoft.report.internal.StyleCore

runOnLoad

public void runOnLoad()
Run the onLoad script. This function can be called multiple times, and it will only execute the onLoad script once for each report run.

Overrides:
runOnLoad in class inetsoft.report.internal.StyleCore

runOnInit

public void runOnInit()
Run the onInit script. This function can be called multiple times, and it will only execute the onLoad script for each report run.

Overrides:
runOnInit in class inetsoft.report.internal.StyleCore

runOnPrint

public void runOnPrint()
Run the onPrint script.

Overrides:
runOnPrint in class inetsoft.report.internal.StyleCore

setVariableTable

public void setVariableTable(VariableTable vars)
Set the report parameters.

Overrides:
setVariableTable in class inetsoft.report.internal.StyleCore

clear

public void clear()
Remove all report elements.

Overrides:
clear in class ReportSheet

reset

public void reset()
Reset the printing. If there is a partially printed job, the rest of the contents are ignored. The next printNext starts from first page.

Overrides:
reset in class ReportSheet

setVisible

public void setVisible(String id,
                       boolean vis)
Set the visibility of an element.

Overrides:
setVisible in class ReportSheet
Parameters:
id - element id.
vis - true to show element and false to hide it.

getProperty

public String getProperty(String name)
Get a property value.

Overrides:
getProperty in class ReportSheet
Parameters:
name - property name.
Returns:
property value.

setProperty

public void setProperty(String name,
                        String val)
Set a property. Properties are attributes in a report template that can be used to store any arbitrary information. It is often used by visual designers on configuration information. The properties may serve as hints on how report is presented at runtime. The currently recognized runtime properties are:

 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.

Overrides:
setProperty in class ReportSheet
Parameters:
name - property name.
val - property value.

setPageNumberingStart

public void setPageNumberingStart(int idx)
Set the page index where the page numbering starts.

Overrides:
setPageNumberingStart in class ReportSheet
Parameters:
idx - the page index where the page numbering starts. The page would be page one.

removeElement

public void removeElement(String id)
Remove the specified element.

Specified by:
removeElement in class ReportSheet
Parameters:
id - element id in string format.

replaceElement

public void replaceElement(String id,
                           ReportElement e)
Replace the specified element.

Specified by:
replaceElement in class ReportSheet
Parameters:
id - element id in string format.

moveElement

public void moveElement(String id,
                        int direction)
Move element up or down.

Specified by:
moveElement in class ReportSheet
Parameters:
id - 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.