Style Intelligence v12.0

inetsoft.report
Class TabularSheet

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

public class TabularSheet
extends ReportSheet

TabularSheet is one of the two report types in Style Report. It uses a grid layout model. Report contents are divided into grid cells. Each cell is independently processed. It is best suited for reports with contents divided into tabular sections.

ReportSheet contains the common API for report generation. Please refer to the Style Report Programming Guide for more details on the concepts and features of the TabularSheet.

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
TabularSheet()
          Create an empty TabularSheet.
 
Method Summary
 String addAreaBreak(int r, int c)
          Add a area break to the document.
 String addBean(int r, int c, String name)
          Add a bean to the report.
 String addBreak(int r, int c)
          Add a break to the document.
 String addBullet(int r, int c)
          Add a bullet to the document.
 String addBullet(int r, int c, Image icon)
          Add a bullet with user specified image as bullet icon.
 String addButton(int r, int c, String form, String name, String text)
          Add a form button to the report.
 String addButton(int r, int c, String form, String name, String script, String text)
          Add a form button to the report.
 String addChart(int r, int c, DataSet chart)
          Add a chart to the report.
 String addChart(int r, int c, DataSet chart, double winch, double hinch)
          This is same as addChart() exception an explicit size of the chart area is specified.
 String addCheckBox(int r, int c, String form, String name, String text, boolean selected)
          Add a checkbox to the report.
 String addCheckBox(int r, int c, String form, String name, String script, String text, boolean selected)
          Add a checkbox to the report.
 String addChoiceElement(int r, int c, String form, String name, String selected, String[] choices)
          Add a choice field to the report.
 String addChoiceElement(int r, int c, String form, String name, String script, String selected, String[] choices)
          Add a choice field to the report.
 String addComponent(int r, int c, Component comp)
          Add an AWT component to the document.
 String addComponent(int r, int c, Component component, double winch, double hinch)
          This is same as addComponent() exception an explicit size of the painter area is specified.
 String addComposite(int r, int c, CompositeLens container)
          Add a composite element to the report.
 String addConditionalPageBreak(int r, int c, double inch)
          Add a conditional page break.
 String addConditionalPageBreak(int r, int c, int min)
          Add a conditional page break.
 String addDateCombo(int r, int c, String form, String name, Date date)
          Add a date combobox to a report.
 String addDateCombo(int r, int c, String form, String name, String script, Date date)
          Add a date combobox to a report.
 String addElement(int r, int c, ReportElement e)
          Add an element to the document.
 String addForm(int r, int c, FormLens form)
          Add a form to the document.
 String addImage(int r, int c, Image image)
          Add an image to the document.
 String addImage(int r, int c, Image image, double winch, double hinch)
          This is same as addImage() exception an explicit size of the painter area is specified.
 String addImage(int r, int c, URL image)
          Add an image to the document.
 String addImageButton(int r, int c, String form, String name, String resource)
          Add a form image button to the report.
 String addImageButton(int r, int c, String form, String name, String script, String resource)
          Add a form image button to the report.
 String addListElement(int r, int c, String form, String name, String[] selected, String[] choices)
          Add a list field to the report.
 String addListElement(int r, int c, String form, String name, String script, String[] selected, String[] choices)
          Add a list field to the report.
 String addNewline(int r, int c, int n)
          Add one or more newline to the document.
 String addObject(int r, int c, Object obj)
          Add an object to the document.
 String addPageBreak(int r, int c)
          Add a page break to the document.
 String addPainter(int r, int c, Painter area)
          Add a painter element to the document.
 String addPainter(int r, int c, Painter area, double winch, double hinch)
          This is same as addPainter() except an explicit size of the painter area is specified.
 String addRadioButton(int r, int c, String form, String name, String text, boolean selected, String group)
          Add a radio button to the report.
 String addRadioButton(int r, int c, String form, String name, String script, String text, boolean selected, String group)
          Add a radio button to the report.
 String addRightTab(int r, int c)
          Add a right aligned tab.
 String addSection(int r, int c, SectionLens section)
          Add a section element to the report.
 String addSection(int r, int c, SectionLens section, TableLens table)
          Add a section element to the report.
 String addSeparator(int r, int c, int style)
          Add a separator.
 void addShape(PageLayout.Shape shape)
          Add a shape to the report.
 String addSpace(int r, int c, int pixels)
          Add horizontal space to the document.
 String addTab(int r, int c, int fill)
          Add a tab.
 String addTable(int r, int c, TableLens table)
          Add a table to the document.
 String addText(int r, int c, String text)
          Add a text element to the document.
 String addText(int r, int c, TextLens text)
          Add a text element to the document.
 String addTextArea(int r, int c, String form, String name, String text, int rows, int cols)
          Add a textarea to a report.
 String addTextArea(int r, int c, String form, String name, String script, String text, int rows, int cols)
          Add a textarea to a report.
 String addTextBox(int r, int c, String text)
          Add a text box to the document.
 String addTextBox(int r, int c, String text, int border, double winch, double hinch, int textalign)
          Add a text box to the document.
 String addTextBox(int r, int c, TextLens text)
          Add a text box to the document.
 String addTextBox(int r, int c, TextLens text, int border, double winch, double hinch, int textalign)
          Add a text box to the document.
 String addTextField(int r, int c, String form, String name, String text, int cols)
          Add a textfield to a report.
 String addTextField(int r, int c, String form, String name, String script, String text, int cols)
          Add a textfield to a report.
 String addTOC(int r, int c, TOC toc)
          Add a table of contents section to the report.
 Object clone()
          Make a copy of this report.
 Object clone(boolean deep)
          Make a copy of this report.
protected  void copyTabularSheet(TabularSheet report, boolean flag)
          Copy this report to that report.
protected  void copyTabularSheet(TabularSheet report, boolean flag, boolean deep)
          Copy this report to that report.
 Vector getAllElements()
          Get all elements in the report body.
 Object getCellBackground(int r, int c)
          Get the background image or color of the specified cell.
 int getCellBackgroundLayout(int r, int c)
          Get the background layout of the specified cell.
 Dimension getCellBackgroundSize(int r, int c)
          Get the background size of the specified cell.
 Color getCellBorderColor(int r, int c)
          Get the border color of the specified cell.
 Insets getCellBorders(int r, int c)
          Get the borders of the specified cell.
 Rectangle getCellSpan(int r, int c)
          Get the span setting of the specified cell.
 int getColCount()
          Get number of columns in the grid.
 String getColWidth(int c)
          Get the column width setting.
 float getColWidthPoints(int c)
          Get the column width in number of points.
 ReportElement getElement(int r, int c, int idx)
          Get the specified element.
 Point getElementCell(ReportElement e)
          Find the cell an element is contained.
 int getElementCount(int r, int c)
          Return the number of elements in the document.
 int getElementIndex(int r, int c, ReportElement e)
          Get the index of the specified element.
 int getMinRowHeight(int r)
          Get the row height.
 Integer getNextOrientation()
          Get the page orientation for the next page.
 int getRowCount()
          Get number of rows in the grid.
 int getRowHeight(int r)
          Get the actual row height.
 Margin getRowMargin(int r)
          Get the margin of a row.
 Integer getRowOrientation(int r)
          Get the orientation of a row.
 PageLayout.Shape getShape(int idx)
          Get the specified shape.
 int getShapeCount()
          Get the number of shapes contained in this report.
 void insertCols(int c, int ncol)
          Insert columns before the specified column.
 String insertElement(int r, int c, int idx, ReportElement e)
          Insert the element at specified position (before).
 void insertRows(int r, int nrow)
          Insert rows before the specified row.
 boolean isCellRepeat(int r, int c)
          Check if the cell contents is repeated.
 boolean isFitPage(int r, int c)
          Check if the cell fit page.
 void mergeCells(int r, int c, int nrow, int ncol)
          Merge the cells in the region.
 void moveElement(String id, int direction)
          Move element up or down.
 boolean printNext(StylePage pg)
          Print one page.
 boolean printNextPage(StylePage pg)
          Print the next page.
 void removeAllElements(int r, int c)
          Remove all elements from the specified cell.
 void removeCols(int c, int ncol)
          Remove columns at specified column.
protected  void removeContents()
          Remove all elements from the contents.
 void removeElement(int r, int c, int idx)
          Remove the specified element.
 void removeElement(String id)
          Remove the specified element.
 void removeRows(int r, int nrow)
          Remove rows at specified row.
 void removeShape(int idx)
          Remove the specified shape.
protected  void replaceElement(int r, int c, int idx, ReportElement e)
          Replace the specified element.
protected  void replaceElement(String id, ReportElement e)
          Replace the specified element.
protected  void resetContents()
          Reset all elements in the contents.
 void setCellBackground(int r, int c, Object bg)
          Set the background image or color of the specified cell.
 void setCellBackgroundLayout(int r, int c, int layout)
          Set the background layout of the specified cell.
 void setCellBackgroundSize(int r, int c, Dimension d)
          Set the background size of the specified cell.
 void setCellBackgroundSize(int r, int c, int width, int height)
          Set the background size of the specified cell.
 void setCellBorderColor(int r, int c, Color color)
          Set the border color of the specified cell.
 void setCellBorders(int r, int c, Insets borders)
          Set the borders of the specified cell.
 void setCellRepeat(int r, int c, boolean repeat)
          Set the repeat flag of a cell.
 void setCellSpan(int r, int c, int nrow, int ncol)
          Merge the cells in the region.
 void setCellSpan(int r, int c, Rectangle rec)
          Set cell span directly.
 void setColWidth(int c, String width)
          Set the column width.
 void setFitPage(int r, int c, boolean print)
          Set the fitPage of a cell.
 void setMinRowHeight(int r, int height)
          Set the row height in pixels (points).
 void setRowMargin(int r, Margin margin)
          Set the page margin for a row.
 void setRowOrientation(int r, Integer orientation)
          Set the page orientation for a row.
 void splitCols(int r, int c, int ncol)
          Split a cell into columns.
 void splitRows(int r, int c, int nrow)
          Split a cell into rows.
 String toString()
           
 
Methods inherited from class inetsoft.report.ReportSheet
addExecuteListener, addFooterBreak, addFooterElement, addFooterImage, addFooterImage, addFooterImage, addFooterNewline, addFooterObject, addFooterPainter, addFooterPainter, addFooterRightTab, addFooterSection, addFooterSection, addFooterSeparator, addFooterSpace, addFooterTab, addFooterTable, addFooterText, addFooterText, addFooterTextBox, addFooterTextBox, addFormat, addFormat, addFormula, addHeaderBreak, addHeaderElement, addHeaderImage, addHeaderImage, addHeaderImage, addHeaderNewline, addHeaderObject, addHeaderPainter, addHeaderPainter, addHeaderRightTab, addHeaderSection, addHeaderSection, addHeaderSeparator, addHeaderSpace, addHeaderTab, addHeaderTable, addHeaderText, addHeaderText, addHeaderTextBox, addHeaderTextBox, addPageBreakListener, addParameter, addParameter, addPresenter, addPresenter, addRefreshListener, addRunningTotal, clear, clearFormat, clearPresenter, containsFormula, copyFormulas, copyReportSheet, copyReportSheet, exportQueries, fireExecuteEvent, firePageBreakEvent, getAllFooterElementCount, getAllHeaderElementCount, getBackground, getBackgroundLayout, getBackgroundSize, getContextName, getCSSLocation, getCurrentAlignment, getCurrentBackground, getCurrentCellPadding, getCurrentFont, getCurrentForeground, getCurrentIndent, getCurrentLineId, getCurrentLineSpacing, getCurrentMargin, getCurrentPainterLayout, getCurrentPainterMargin, getCurrentSeparatorAdvance, getCurrentTableAdvance, getCurrentTableLayout, getCurrentTableWidth, getCurrentTabStops, getCurrentTextAdvance, getCurrentWrapping, getDataSet, getDirectory, getElement, getElements, getExecuteListeners, getExportInfo, getFooterBounds, getFooterElement, getFooterElementCount, getFooterElementIndex, getFooterFromEdge, getForm, getFormat, getFormula, getFormulas, getFormulas, getHeaderBounds, getHeaderElement, getHeaderElementCount, getHeaderElementIndex, getHeaderFromEdge, getImportInfo, getLocale, getMargin, getMaxPages, getMaxPages, getMetaTemplate, getOnInit, getOnLoad, getOnPageBreak, getOnPrint, getOrientation, getPageNumberingStart, getPageSize, getParameter, getParameterCount, getParameters, getParameterSheetFlow, getParameterSheets, getParentReport, getPresenter, getPrinterMargin, getProperty, getQueries, getQuery, getQueryNames, getQueryType, getRunningTotal, getRunningTotalCount, getSharedFilter, getTable, getTableStyle, getText, getVersion, importQueries, insertFooterElement, insertHeaderElement, isCurrentJustify, isCurrentOrphanControl, isCurrentTableOrphanControl, isExportSinglePage, isFromMetaTemplate, isHorizontalWrap, isLandscape, isParameterPrompting, isSinglePageForTopReport, isVisible, keepWithNext, mergeInto, moveAnchor, moveHeaderFooterElement, print, print, printHeaderFooter, printNextArea, printNextLine, printNonFlowAreas, refreshFormats, removeAllParameters, removeContext, removeElementHeaderFooter, removeExecuteListener, removeExecuteListeners, removeFooterElement, removeFormat, removeFormula, removeHeaderElement, removeHeaderFooterElement, removePageBreakListener, removeParameter, removePresenter, removeQuery, removeRunningTotal, replaceFooterElement, replaceFormulaInfo, replaceHeaderElement, replaceHeaderFooterElement, reset, resetPageNumbering, saveContext, selectContext, setBackground, setBackgroundLayout, setBackgroundSize, setBackgroundSize, setContextName, setCSSLocation, setCurrentAlignment, setCurrentBackground, setCurrentCellPadding, setCurrentFont, setCurrentFooter, setCurrentFooter, setCurrentForeground, setCurrentHeader, setCurrentHeader, setCurrentIndent, setCurrentJustify, setCurrentLineId, setCurrentLineSpacing, setCurrentOrphanControl, setCurrentPainterLayout, setCurrentPainterMargin, setCurrentSeparatorAdvance, setCurrentTableAdvance, setCurrentTableLayout, setCurrentTableOrphanControl, setCurrentTableWidth, setCurrentTabStops, setCurrentTextAdvance, setCurrentWrapping, setDirectory, setElement, setFooterFromEdge, setFormulaInfos, setHeaderFromEdge, setHorizontalWrap, setLocale, setMargin, setMaxPages, setMetaTemplate, setOnInit, setOnLoad, setOnPageBreak, setOnPrint, setOrientation, setPageNumberingStart, setPageSize, setParameterPrompting, setParameterSheet, setParameterSheetFlow, setParameterSheets, setParentReport, setPrinterMargin, setProperty, setQuery, setSharedFilter, setTableStyle, setVersion, setVisible, syncSourceInfo, syncSourceInfo, updateQuery
 
Methods inherited from class inetsoft.report.internal.StyleCore
addChangeListener, addr, addScriptObject, advance, alignLine, append, append, calcGrid, checkDataSourceFolderPermission, checkDataSourcePermission, checkQueryFolderPermission, checkQueryPermission, cloneElements, cloneElements, complete, completeElement, copyQueries, copyStyleCore, createFinder, createFormatMap, createPresenterMap, deleteScriptEnv, fireEvent, format, format, getActionScriptable, getAllFooterElements, getAllHeaderElements, 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, resetOnLoad, resetScriptEnv, restoreHeadingNumberArray, runOnInit, runOnLoad, runOnPrint, setBackgroundImageLocation, setBurstInfo, setDesignTime, setElemInfoBoundsMap, setFooterContinue, setHeaderContinue, setHeadingNumberArray, setHFTextFormatter, setHindent, setOverrideFooter, setOverrideHeader, setPageTotalStart, setParentScope, setPrintMode, setReportMode, setReportMode, setReusePages, setScriptEnv, setSubreport, setValue, setVariableTable, 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, wait, wait, wait
 

Constructor Detail

TabularSheet

public TabularSheet()
Create an empty TabularSheet.

Method Detail

getRowCount

public int getRowCount()
Get number of rows in the grid.


getColCount

public int getColCount()
Get number of columns in the grid.


mergeCells

public void mergeCells(int r,
                       int c,
                       int nrow,
                       int ncol)
Merge the cells in the region. The merging is done by setting the cell spanning of the cells. If a cell in the merge region is already a span cell, its full span is also merged into the region.


splitRows

public void splitRows(int r,
                      int c,
                      int nrow)
Split a cell into rows. If the cell is a span cell, the row spanning is undone before new rows are inserted into the grid.

Parameters:
r - row index.
c - column index.
nrow - number of rows to split the cell into.

splitCols

public void splitCols(int r,
                      int c,
                      int ncol)
Split a cell into columns. If the cell is a span cell, the column spanning is undone before new columns are inserted into the grid.

Parameters:
r - row index.
c - column index.
ncol - number of columns to split the cell into.

getCellBackground

public Object getCellBackground(int r,
                                int c)
Get the background image or color of the specified cell.

Parameters:
r - row index.
c - column index.
Returns:
cell background image or color.

setCellBackground

public void setCellBackground(int r,
                              int c,
                              Object bg)
Set the background image or color of the specified cell.

Parameters:
r - row index.
c - column index.
bg - cell background image or color.

getCellBackgroundLayout

public int getCellBackgroundLayout(int r,
                                   int c)
Get the background layout of the specified cell.

Parameters:
r - row index.
c - column index.
Returns:
cell background layout.

setCellBackgroundLayout

public void setCellBackgroundLayout(int r,
                                    int c,
                                    int layout)
Set the background layout of the specified cell.

Parameters:
r - row index.
c - column index.
layout - cell background layout.

getCellBackgroundSize

public Dimension getCellBackgroundSize(int r,
                                       int c)
Get the background size of the specified cell.

Parameters:
r - row index.
c - column index.
Returns:
cell background size.

setCellBackgroundSize

public void setCellBackgroundSize(int r,
                                  int c,
                                  Dimension d)
Set the background size of the specified cell.

Parameters:
r - row index.
c - column index.
d - cell background size.

setCellBackgroundSize

public void setCellBackgroundSize(int r,
                                  int c,
                                  int width,
                                  int height)
Set the background size of the specified cell.

Parameters:
r - row index.
c - column index.
width - cell background width.
height - cell background height.

getCellBorders

public Insets getCellBorders(int r,
                             int c)
Get the borders of the specified cell.

Parameters:
r - row index.
c - column index.
Returns:
cell borders line styles.

setCellBorders

public void setCellBorders(int r,
                           int c,
                           Insets borders)
Set the borders of the specified cell.

Parameters:
r - row index.
c - column index.
borders - cell borders line styles.

getCellBorderColor

public Color getCellBorderColor(int r,
                                int c)
Get the border color of the specified cell.

Parameters:
r - row index.
c - column index.
Returns:
cell border color.

setCellBorderColor

public void setCellBorderColor(int r,
                               int c,
                               Color color)
Set the border color of the specified cell.

Parameters:
r - row index.
c - column index.
color - cell border color.

isCellRepeat

public boolean isCellRepeat(int r,
                            int c)
Check if the cell contents is repeated.

Parameters:
r - row index.
c - column index.
Returns:
true if cell contents is repeated on every page it is printed.

setCellRepeat

public void setCellRepeat(int r,
                          int c,
                          boolean repeat)
Set the repeat flag of a cell. If this flag is true, the cell contents is repeated on every page it is printed on. This can be used to create a sidebar on a report.

Parameters:
r - row index.
c - column index.
repeat - repeat flag.

isFitPage

public boolean isFitPage(int r,
                         int c)
Check if the cell fit page.

Parameters:
r - row index.
c - column index.
Returns:
true if fit page.

setFitPage

public void setFitPage(int r,
                       int c,
                       boolean print)
Set the fitPage of a cell. If this flag is true, the cell print bottom border to fit content, otherwise print on last page bottom.

Parameters:
r - row index.
c - column index.
print - print flag.

setCellSpan

public void setCellSpan(int r,
                        int c,
                        Rectangle rec)
Set cell span directly.

Parameters:
r - row index.
c - column index.
rec - span rectangle.

setCellSpan

public void setCellSpan(int r,
                        int c,
                        int nrow,
                        int ncol)
Merge the cells in the region. This is different from the mergeCells() call. If the span region overlaps an existing span region, the new span region is not merged into the span region. Instead, the existing span region is reset to remove the overlapping, and then the new spanning is applied.


getCellSpan

public Rectangle getCellSpan(int r,
                             int c)
Get the span setting of the specified cell.

Returns:
cell span information. If the specified cell is inside a span cell, the x value is the negative value of the distance from this cell to the left most cell in the span cell. The y value is the negative value of the distance from this cell to the top most cell in the span cell. The width is the column span, and height is the row span.

setMinRowHeight

public void setMinRowHeight(int r,
                            int height)
Set the row height in pixels (points). A value of zero indicates the row height should be calculated from the cell contents.

Parameters:
r - row index.
height - row height in points (1/72 inch).

getMinRowHeight

public int getMinRowHeight(int r)
Get the row height.

Parameters:
r - row index.
Returns:
row height in points.

getRowHeight

public int getRowHeight(int r)
Get the actual row height. This value is only available after this report has been printed or otherwise processed.


setRowOrientation

public void setRowOrientation(int r,
                              Integer orientation)
Set the page orientation for a row. If orientation is set for a row, it automatically forces a new page, and change the new page to the specified orientation. Set orientation to null to use the default orientation.

Parameters:
orientation - a Integer object with value in StyleConstants.PORTRAIT or StyleConstants.LANDSCAPE.

getRowOrientation

public Integer getRowOrientation(int r)
Get the orientation of a row.


setRowMargin

public void setRowMargin(int r,
                         Margin margin)
Set the page margin for a row. If margin is set for a row, it automatically forces a new page, and change the new page to the specified margin. Set orientation to null to use the default orientation.

Parameters:
margin - margin in inches.

getRowMargin

public Margin getRowMargin(int r)
Get the margin of a row.


setColWidth

public void setColWidth(int c,
                        String width)
Set the column width. The width is specified as a percentage of the page width (e.g. 50%), or proportion to other columns (e.g. 2*), or as fixed size in points (e.g. 200).

Parameters:
c - column index.
width - width specification.

getColWidth

public String getColWidth(int c)
Get the column width setting. The width is specified as a string. See setColWidth() for width specification format.

Parameters:
c - column index.
Returns:
width specification.

getColWidthPoints

public float getColWidthPoints(int c)
Get the column width in number of points. This width is calculated during the layout process. It is only available after a report has been printed.


insertRows

public void insertRows(int r,
                       int nrow)
Insert rows before the specified row. To add rows to the end of the table, use row count as the row index.

Parameters:
r - row index.
nrow - number of rows to insert.

insertCols

public void insertCols(int c,
                       int ncol)
Insert columns before the specified column. To add columns to the end of the table, use column count as the column index.

Parameters:
c - column index.
ncol - number of columns to insert.

removeRows

public void removeRows(int r,
                       int nrow)
Remove rows at specified row.

Parameters:
r - row index.
nrow - number of rows.

removeCols

public void removeCols(int c,
                       int ncol)
Remove columns at specified column.

Parameters:
c - column index.
ncol - number of columns.

addShape

public void addShape(PageLayout.Shape shape)
Add a shape to the report. The shape is drawn as the background of the report.

Parameters:
shape - a shape (line, rectangle, or oval).

getShapeCount

public int getShapeCount()
Get the number of shapes contained in this report.


getShape

public PageLayout.Shape getShape(int idx)
Get the specified shape.


removeShape

public void removeShape(int idx)
Remove the specified shape.


addObject

public String addObject(int r,
                        int c,
                        Object obj)
Add an object to the document. First the TabularSheet 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 TabularSheet 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()) and treated as a regular text element.

Parameters:
r - row index.
c - column index.
obj - object value.
Returns:
element id.

addText

public String addText(int r,
                      int c,
                      String text)
Add a text element to the document. The text string can be a simple string, or contains multiple lines separated by the newline character.

Parameters:
r - row index.
c - column index.
text - text string.
Returns:
element id.

addText

public String addText(int r,
                      int c,
                      TextLens text)
Add a text element to the document. The TextLens provides an extra level of indirection. For example, it can be used to refer to a TextField on a GUI screen, the most up-to-date value in the text field will be used when printing the document. This way a TabularSheet can be created once, and don't need to be modified when the text contents change.

The inetsoft.report.lens package also contains a StreamTextLens, which allows retrieving text from a file, URL, or any input stream.

Parameters:
r - row index.
c - column index.
text - text content lens.
Returns:
element id.

addTextBox

public String addTextBox(int r,
                         int c,
                         TextLens text)
Add a text box to the document. 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.

Parameters:
r - row index.
c - column index.
text - text content.
Returns:
element id.

addTextBox

public String addTextBox(int r,
                         int c,
                         String text)
Add a text box to the document. 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.

Parameters:
r - row index.
c - column index.
text - text content.
Returns:
element id.

addTextBox

public String addTextBox(int r,
                         int c,
                         TextLens text,
                         int border,
                         double winch,
                         double hinch,
                         int textalign)
Add a text box to the document. 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.

Parameters:
r - row index.
c - column index.
text - text content.
border - border line style. One of the line styles defined in the StyleConstants class.
winch - area width in inches. Pass 0 to use default.
hinch - area height in inches. Pass 0 to use default.
textalign - text alignment within the box.
Returns:
element id.

addTextBox

public String addTextBox(int r,
                         int c,
                         String text,
                         int border,
                         double winch,
                         double hinch,
                         int textalign)
Add a text box to the document. 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.

Parameters:
r - row index.
c - column index.
text - text content.
border - border line style. One of the line styles defined in the StyleConstants class.
winch - area width in inches. Pass 0 to use default.
hinch - area height in inches. Pass 0 to use default.
textalign - text alignment within the box.
Returns:
element id.

addPainter

public String addPainter(int r,
                         int c,
                         Painter area)
Add a painter element to the document. 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.

Parameters:
r - row index.
c - column index.
area - the painter element.
Returns:
element id.

addPainter

public String addPainter(int r,
                         int c,
                         Painter area,
                         double winch,
                         double hinch)
This is same as addPainter() except 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.

Parameters:
r - row index.
c - column index.
area - the painter element.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addChart

public String addChart(int r,
                       int c,
                       DataSet chart)
Add a chart to the report. The chart behaves like a painter. It reserves an area and paints a chart on the area. The current PainterLayout value is also applied to the chart.

Parameters:
r - row index.
c - column index.
chart - chart data model.
Returns:
element id.

addChart

public String addChart(int r,
                       int c,
                       DataSet chart,
                       double winch,
                       double hinch)
This is same as addChart() exception an explicit size of the chart area is specified. The specified size (in inches) is the preferred size of this chart on paper, where as the preferred size of the Chart 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 Chart.getPreferredSize) to the area defined.

Parameters:
r - row index.
c - column index.
chart - the chart element.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addComponent

public String addComponent(int r,
                           int c,
                           Component comp)
Add an AWT component to the document. The onscreen image of the component is 'copied' on to the document.

Parameters:
r - row index.
c - column index.
comp - component.
Returns:
element id.

addComponent

public String addComponent(int r,
                           int c,
                           Component component,
                           double winch,
                           double hinch)
This is same as addComponent() 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 component is scaled from the pixel size (returned by Painter.getPreferredSize) to the area defined.

Parameters:
r - row index.
c - column index.
component - component to paint.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addImage

public String addImage(int r,
                       int c,
                       Image image)
Add an image to the document.

Parameters:
r - row index.
c - column index.
image - image object.
Returns:
element id.

addImage

public String addImage(int r,
                       int c,
                       Image image,
                       double winch,
                       double hinch)
This is same as addImage() 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.

Parameters:
r - row index.
c - column index.
image - image to paint.
winch - area width in inches.
hinch - area height in inches.
Returns:
element id.

addImage

public String addImage(int r,
                       int c,
                       URL image)
                throws IOException
Add an image to the document.

Parameters:
r - row index.
c - column index.
image - image URL.
Returns:
element id.
Throws:
IOException

addBullet

public String addBullet(int r,
                        int c)
Add a bullet to the document. A bullet can be used to create a bullet list. The default bullet is a round dot. The bullet has a special layout property. After a bullet is added, a hanging indent is created to just right of the bullet. If a Break is added, the cursor is advanced to the next line at the hanging indent position. If a newline element is added, the hanging indent is reset.

Parameters:
r - row index.
c - column index.
Returns:
element id.

addBullet

public String addBullet(int r,
                        int c,
                        Image icon)
Add a bullet with user specified image as bullet icon. The bullet is otherwise same as the default.

Parameters:
r - row index.
c - column index.
icon - icon to used for bullet.
Returns:
element id.

addSpace

public String addSpace(int r,
                       int c,
                       int pixels)
Add horizontal space to the document. The space is added after the current element.

Parameters:
r - row index.
c - column index.
pixels - space in pixels.
Returns:
element id.

addNewline

public String addNewline(int r,
                         int c,
                         int n)
Add one or more newline to the document.

Parameters:
r - row index.
c - column index.
n - number of newline.
Returns:
element id.

addBreak

public String addBreak(int r,
                       int c)
Add a break to the document. The break is different from a newline in that the break does not reset the hanging indent which is set by a bullet.

Parameters:
r - row index.
c - column index.
Returns:
element id.

addPageBreak

public String addPageBreak(int r,
                           int c)
Add a page break to the document. This causes the print to advance to a new page.

Parameters:
r - row index.
c - column index.
Returns:
element id.

addAreaBreak

public String addAreaBreak(int r,
                           int c)
Add a area break to the document. This causes the print to advance to a new area. In the default case, each page is consisted of one area, so this is same as adding a page break.

Parameters:
r - row index.
c - column index.
Returns:
element id.

addConditionalPageBreak

public String addConditionalPageBreak(int r,
                                      int c,
                                      int min)
Add a conditional page break. The print advance to a new page if the remaining space in the current page is less than the specified minimum space.

Parameters:
r - row index.
c - column index.
min - minimu space in pixels.
Returns:
element id.

addConditionalPageBreak

public String addConditionalPageBreak(int r,
                                      int c,
                                      double inch)
Add a conditional page break. The print advance to a new page if the remaining space in the current page is less than the specified minimum space.

Parameters:
r - row index.
c - column index.
inch - minimu space in inches.
Returns:
element id.

addSeparator

public String addSeparator(int r,
                           int c,
                           int style)
Add a separator. A separator is a horizontal line in either 3D or plain mode.

Parameters:
r - row index.
c - column index.
style - the line style (defined in StyleConstants).
Returns:
element id.

addTab

public String addTab(int r,
                     int c,
                     int fill)
Add a tab. The fill specifies a line style to fill the tab space.

Parameters:
fill - a line style defined in StyleConstants.
r - row index.
c - column index.
Returns:
element id.

addRightTab

public String addRightTab(int r,
                          int c)
Add a right aligned tab. A right aligned tab causes the text preceding the tab to be right aligned at the next tab stop.

Parameters:
r - row index.
c - column index.
Returns:
element id.

addTable

public String addTable(int r,
                       int c,
                       TableLens table)
Add a table to the document. The table lens object encapsulates the table attributes and contents. Through the table lens, the print discovers table attributes such as color, border, font, etc.. For more details, refer the TableLens document.

Parameters:
r - row index.
c - column index.
table - table lens.
Returns:
element id.

addForm

public String addForm(int r,
                      int c,
                      FormLens form)
Add a form to the document. A form is a collection of labels and values. With each field consists of a label and a field value. The fields are layed out in rows and columns.

Parameters:
r - row index.
c - column index.
form - form lens.
Returns:
element id.

addTOC

public String addTOC(int r,
                     int c,
                     TOC toc)
Add a table of contents section to the report. The table of contents is built from the heading elements in the report. Heading elements are special text elements that contains a heading level.

Parameters:
r - row index.
c - column index.
toc - table of contents style.
Returns:
element id.

addBean

public String addBean(int r,
                      int c,
                      String name)
Add a bean to the report. The bean is a reference to a report component. The contents of the report component is printed in the place of the bean element.

Parameters:
r - row index.
c - column index.
name - bean name, must be an existing bean in the bean library.
Returns:
element id.

addComposite

public String addComposite(int r,
                           int c,
                           CompositeLens container)
Add a composite element to the report. A composite element is a container of elements. It can contain multiple elements which are printed as part of the report flow. The elements in the container can be changed dynamically or created programmatically. A ElementContainer class can be used to create a composite lens without implementing the interface.

Parameters:
r - row index.
c - column index.
container - composite lens.
Returns:
element id.

addSection

public String addSection(int r,
                         int c,
                         SectionLens section)
Add a section element to the report. A section contains fixed positioned elements that are printed relative to the frame position.

Parameters:
r - row index.
c - column index.
section - section contents.
Returns:
element ID.

addSection

public String addSection(int r,
                         int c,
                         SectionLens section,
                         TableLens table)
Add a section element to the report. A table is bound to the section. The table header is used to populate the section header element values. The table rows are used to populate the section content element values. The section content band is repeated for each row in the table.

Parameters:
r - row index.
c - column index.
section - section contents.
table - section data.
Returns:
element ID.

addButton

public String addButton(int r,
                        int c,
                        String form,
                        String name,
                        String text)
Add a form button to the report.

Parameters:
form - form name.
name - field name.
text - button text.
Returns:
element ID.

addButton

public String addButton(int r,
                        int c,
                        String form,
                        String name,
                        String script,
                        String text)
Add a form button to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
text - button text.
Returns:
element ID.

addImageButton

public String addImageButton(int r,
                             int c,
                             String form,
                             String name,
                             String resource)
Add a form image button to the report.

Parameters:
form - form name.
name - field name.
resource - image resource name.
Returns:
element ID.

addImageButton

public String addImageButton(int r,
                             int c,
                             String form,
                             String name,
                             String script,
                             String resource)
Add a form image button to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
resource - image resource name.
Returns:
element ID.

addCheckBox

public String addCheckBox(int r,
                          int c,
                          String form,
                          String name,
                          String text,
                          boolean selected)
Add a checkbox to the report.

Parameters:
form - form name.
name - field name.
text - checkbox label.
selected - true if the default is selected.
Returns:
element ID.

addCheckBox

public String addCheckBox(int r,
                          int c,
                          String form,
                          String name,
                          String script,
                          String text,
                          boolean selected)
Add a checkbox to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
text - checkbox label.
selected - true if the default is selected.
Returns:
element ID.

addRadioButton

public String addRadioButton(int r,
                             int c,
                             String form,
                             String name,
                             String text,
                             boolean selected,
                             String group)
Add a radio button to the report.

Parameters:
form - form name.
name - field name.
text - button label.
selected - true if the default is selected.
group - radio button group name.
Returns:
element ID.

addRadioButton

public String addRadioButton(int r,
                             int c,
                             String form,
                             String name,
                             String script,
                             String text,
                             boolean selected,
                             String group)
Add a radio button to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
text - button label.
selected - true if the default is selected.
group - radio button group name.
Returns:
element ID.

addChoiceElement

public String addChoiceElement(int r,
                               int c,
                               String form,
                               String name,
                               String selected,
                               String[] choices)
Add a choice field to the report.

Parameters:
form - form name.
name - field name.
selected - the default selected item.
choices - the list of choices.
Returns:
element ID.

addChoiceElement

public String addChoiceElement(int r,
                               int c,
                               String form,
                               String name,
                               String script,
                               String selected,
                               String[] choices)
Add a choice field to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
selected - the default selected item.
choices - the list of choices.
Returns:
element ID.

addListElement

public String addListElement(int r,
                             int c,
                             String form,
                             String name,
                             String[] selected,
                             String[] choices)
Add a list field to the report.

Parameters:
form - form name.
name - field name.
selected - the default selected item.
choices - the list of choices.
Returns:
element ID.

addListElement

public String addListElement(int r,
                             int c,
                             String form,
                             String name,
                             String script,
                             String[] selected,
                             String[] choices)
Add a list field to the report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
selected - the default selected item.
choices - the list of choices.
Returns:
element ID.

addDateCombo

public String addDateCombo(int r,
                           int c,
                           String form,
                           String name,
                           Date date)
Add a date combobox to a report.

Parameters:
form - form name.
name - field name.
date - default date/
Returns:
element ID.

addDateCombo

public String addDateCombo(int r,
                           int c,
                           String form,
                           String name,
                           String script,
                           Date date)
Add a date combobox to a report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
date - default date.
Returns:
element ID.

addTextField

public String addTextField(int r,
                           int c,
                           String form,
                           String name,
                           String text,
                           int cols)
Add a textfield to a report.

Parameters:
form - form name.
name - field name.
text - default text.
cols - number of columns.
Returns:
element ID.

addTextField

public String addTextField(int r,
                           int c,
                           String form,
                           String name,
                           String script,
                           String text,
                           int cols)
Add a textfield to a report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
text - default text.
cols - number of columns.
Returns:
element ID.

addTextArea

public String addTextArea(int r,
                          int c,
                          String form,
                          String name,
                          String text,
                          int rows,
                          int cols)
Add a textarea to a report.

Parameters:
form - form name.
name - field name.
text - default text.
rows - number of rows.
cols - number of columns.
Returns:
element ID.

addTextArea

public String addTextArea(int r,
                          int c,
                          String form,
                          String name,
                          String script,
                          String text,
                          int rows,
                          int cols)
Add a textarea to a report.

Parameters:
form - form name.
name - field name.
script - onSubmit java script.
text - default text.
rows - number of rows.
cols - number of columns.
Returns:
element ID.

addElement

public String addElement(int r,
                         int c,
                         ReportElement e)
Add an element to the document. Classes extending the TabularSheet can extend element classes from the Element, and use this method for adding the element to the document.

Parameters:
r - row index.
c - column index.
e - document element.
Returns:
element id.

getElementCount

public int getElementCount(int r,
                           int c)
Return the number of elements in the document.

Parameters:
r - row index.
c - column index.
Returns:
number of elements.

getElement

public ReportElement getElement(int r,
                                int c,
                                int idx)
Get the specified element.

Parameters:
r - row index.
c - column index.
idx - element index.
Returns:
document element.

getElementCell

public Point getElementCell(ReportElement e)
Find the cell an element is contained.

Parameters:
e - element.
Returns:
cell where the element is contained.

getElementIndex

public int getElementIndex(int r,
                           int c,
                           ReportElement e)
Get the index of the specified element.

Parameters:
r - row index.
c - column index.
e - element.
Returns:
element index.

removeElement

public void removeElement(int r,
                          int c,
                          int idx)
Remove the specified element.

Parameters:
r - row index.
c - column index.
idx - element index.

removeAllElements

public void removeAllElements(int r,
                              int c)
Remove all elements from the specified cell.

Parameters:
r - row index.
c - column index.

removeElement

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

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

replaceElement

protected void replaceElement(int r,
                              int c,
                              int idx,
                              ReportElement e)
Replace the specified element.

Parameters:
r - row index.
c - column index.
idx - element index.

replaceElement

protected 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, up or down.

insertElement

public String insertElement(int r,
                            int c,
                            int idx,
                            ReportElement e)
Insert the element at specified position (before).

Parameters:
idx - position to insert.
r - row index.
c - column index.
e - element.
Returns:
element ID.

getAllElements

public Vector getAllElements()
Get all elements in the report body.

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

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.

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.

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 setup correctly before the call.

Specified by:
printNextPage in class ReportSheet

removeContents

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

Specified by:
removeContents in class ReportSheet

resetContents

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

Specified by:
resetContents in class ReportSheet

toString

public String toString()
Overrides:
toString in class Object

clone

public Object clone()
Description copied from class: ReportSheet
Make a copy of this report.

Overrides:
clone in class ReportSheet

clone

public Object clone(boolean deep)
Description copied from class: ReportSheet
Make a copy of this report.

Overrides:
clone in class ReportSheet

copyTabularSheet

protected void copyTabularSheet(TabularSheet report,
                                boolean flag)
Copy this report to that report.

Parameters:
report - the report copied to.
flag - if true flag all copied elements as from template.

copyTabularSheet

protected void copyTabularSheet(TabularSheet report,
                                boolean flag,
                                boolean deep)
Copy this report to that report.

Parameters:
report - the report copied to.
flag - if true flag all copied elements as from template.

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.