Designer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jet.api
Class Designer

java.lang.Object
  jet.api.API
      jet.api.Designer

Direct Known Subclasses:: MultipliedDesigner, MultiUserDesigner

public class Designer
extends API
extends API

The Designer class allows an application to create and manipulate JReport ReportSets (.cls) and its children objects. By building a Designer instance in a Java program, users can edit a ReportSet by methods provided by API.
ReportSets are also called Page Reports in JReport manuals.

JReport ReportSet and its objects are stored in a tree structure. An instance of Designer can retrieve each object in the ReportSet by its handle. The handle of an object is named by its qualified and unique instance name.

A ReportSet is composed of one or more reports (also called tabs or sheets) that are designed for the same purpose, or related purposes. Report developers can design, maintain, run and schedule these reports together or separately. The reports in the same ReportSet can share the same parameters and DataSets which reduces the number of queries to the DBMS.

A dataset is the set of data built from the result of a query, and can optionally have filters applied to it. A dataset contains not only DBFields, but also all formulas, summaries, and parameters that use the DBFields. A dataset has a name, which by default is the name of the resource on which it is created. When you create a data component, you specify whether to create a new dataset for it or use an existing one.

JReport reports are usually composed of multiple components. Components in JReport can be classified as follows:

Static components - labels, images, barcodes, tabulars, groups, sections, subreports, UDOs.
Data components - reports, tables, crosstabs, charts, and banded objects
Fields - DBFields, formula fields, summary fields, parameter fields often referred to as mapping names (as opposed to actual DBMS table and column names)
Drawing objects - lines, arcs, boxes, ovals, round boxes supported only in banded objects
Special fields - Print Date, Print Time, Fetch Date, Fetch Time, Record Number and many more.

A label is an object that contains a string. It is typically a brief description used to identify a field or other value nearby.

An image is a digital representation of a picture. JReport supports the following image formats: .bmp, .gif, .jpg, and .png.

A table is composed of rows and columns, and each contains several cells. Tables give you great control over how to present data, including placing fields, grouping them, and sorting them. With such a structure a table is a good way to show any two-dimensional dataset.

A crosstab summarizes data and presents the summaries in a compact row and column format.

A chart organizes and graphically presents data in a way that makes it easy for end users to see comparisons, trends, and patterns in data. It represents the report data in a visually straightforward form. A chart is based on the chart platform. On the platform, the chart paper, the legend, and labels make up the chart. You can create a chart that contains only simple DBFields, or a complicated chart that contains DBFields, groups, summaries, and even formulas. Normally, DBFields, summaries, and formulas in a report are represented in a chart using chart data markers, and groups are used to produce category names and data series names. DBFields can also be used as category names.

A banded object is a component that can present grouped data and detailed data. A banded object is composed of several banded panels(sections) with which you can easily organize data fields and other elements.

A tabular is a component designed to lay out other components. Unlike a table component, which is used to display a dataset, a tabular is a set of cells that can each display a data component.

A report that is inserted into another report is referred to as the subreport. Subreports are inserted and managed just like a component in a primary report, but a subreport itself is created and managed just like a primary report. You can specify relationships between the primary report and the subreport as well as have JReport pass values to the primary report or the subreport. A primary report can have more than one subreport. They can be in the same ReportSet as the primary report or can be in different ReportSets.

Formula fields are calculated from DBFields, other formulas, summaries, parameters and constants, so they can present information that DBFields cannot do.

A summary is a special kind of formula. A summary generates a count, average, sum, standard deviation or other aggregation of a set of data values. A summary may apply to a defined group of data or can be a dynamic summary able to summarize on any group.

A parameter in JReport is a variable whose value is determined at runtime. The runtime parameters help you dynamically control your report results when used as parameters in a query.

Drawing objects can only be inserted into banded objects. You can add arcs, ovals, boxes, round boxes and lines to your report.

Some components can be bound with a dataset or inherit data from the dataset of their parents. These components are table, chart, crosstab, and banded object, and they are also referred to as data containers or data components. Depending on the location of the libraries you either need a Designer API License Key or a Server Designer API License Key. If you are using Designer libraries you need report.jar and JREngine.jar (Designer API License Key) If you are using Server libraries you need JRSRMI.jar (Server Designer API License Key)

For detailed explanation about the object properties, refer to the help document Getting property information

The following is one example of the use of the Designer . The code:

 
  Designer dr = null;
        try
        {
                  String path = "C:\\JReport\\Designer\\Demo\\Reports\\TutorialReports";
        String catName = "TutorialReports.cat";
        DesignerUserInfo userInfo=new DesignerUserInfo("UID", "designer API license key");
                  dr = new Designer(path, catName,userInfo);
                  CatalogAPI cat = dr.getCatalogAPI();
         ......         
        }
        finally
        {
                dr.exit();
        }

   // To create a new ReportSet (Page Report) with a banded object using the above Designer (dr)
   // 1. Create ReportSet
   reportset = dr.createReportSet(name);
   // 2. Add Dataset
   dataset = dr.addDataset(reportset, queryname, dsname, null, Designer.DATASET_TYPE_QUERY);
   // 3. Create a report tab inside the ReportSet
   report = dr.addReport(reportset, name);
   // 4. Insert a PagePanel into the report tab
   page = dr.insertPage(report);
   // 5. Insert the data component you want to use such as a banded object
   banded = dr.insertBandedObject(reportbody, true, true, true);
   // 6. Bind the dataset to the reportbody and set inherit from parent for the banded object
   dr.bindDataSet(reportbody, queryname);
   dr.set(banded, "dataInherit", true);
   // 7. Get handles so that you can start adding objects to the report
   handles = dr.getHandles(banded, Designer.PAGE);
      ......
   // 8. Add groups to the banded object page
   GroupInfo ginfo = new GroupInfo(dbfield,GroupInfo.DESCENDING);
   group = dr.insertSectionGroup(handles[0], ginfo);
      .....
   // 9. Exit and save changes
   dr.exit();

Field Summary
`static int`	`ARC` Shape object type.
`static int`	`AREA_ARRAY_2D` The chart type value.
`static int`	`AREA_ARRAY_3D` The chart type value.
`static int`	`AREA_PERCENT_2D` The chart type value.
`static int`	`AREA_PERCENT_3D` The chart type value.
`static int`	`AREA_STACK_2D` The chart type value.
`static int`	`AREA_STACK_3D` The chart type value.
`static int`	`AREACHART` The chart type value.
`static int`	`BANDEDOBJECT` JReport BandedObject object type.
`static int`	`BANDEDOBJECT_FOOTER` BandedObjectFooter Section object type.
`static int`	`BANDEDOBJECT_HEADER` BandedObjectHeader Section object type.
`static int`	`BANDEDOBJECT_PAGEFOOTER` BandedObject PageFooter Section object type.
`static int`	`BANDEDOBJECT_PAGEHEADER` BandedObject PageHeader Section object type.
`static int`	`BAR_ARRAY_3D` The chart type value.
`static int`	`BAR_PERCENT_2D` The chart type value.
`static int`	`BAR_PERCENT_3D` The chart type value.
`static int`	`BAR_PERCENT_AREA_STACK_2D` The chart type value.
`static int`	`BAR_PERCENT_LINE_ARRAY_2D` The chart type value.
`static int`	`BAR_PERCENT_LINE_STACK_2D` The chart type value.
`static int`	`BAR_SIDEBYSIDE_2D` The chart type value.
`static int`	`BAR_SIDEBYSIDE_3D` The chart type value.
`static int`	`BAR_SIDEBYSIDE_AREA_STACK_2D` The chart type value.
`static int`	`BAR_SIDEBYSIDE_LINE_ARRAY_2D` The chart type value.
`static int`	`BAR_SIDEBYSIDE_LINE_STACK_2D` The chart type value.
`static int`	`BAR_STACK_2D` The chart type value.
`static int`	`BAR_STACK_3D` The chart type value.
`static int`	`BAR_STACK_AREA_STACK_2D` The chart type value.
`static int`	`BAR_STACK_LINE_ARRAY_2D` The chart type value.
`static int`	`BAR_STACK_LINE_STACK_2D` The chart type value.
`static int`	`BARCHART` The chart type value.
`static int`	`BARCODEFIELD` JReport BarCode object type.
`static int`	`BENCH_ARRAY_3D` The chart type value.
`static int`	`BENCH_PERCENT_2D` The chart type value.
`static int`	`BENCH_PERCENT_3D` The chart type value.
`static int`	`BENCH_SIDEBYSIDE_2D` The chart type value.
`static int`	`BENCH_SIDEBYSIDE_3D` The chart type value.
`static int`	`BENCH_STACK_2D` The chart type value.
`static int`	`BENCH_STACK_3D` The chart type value.
`static int`	`BENCHARRAYCHART` The chart type value.
`static int`	`BENCHCHART` The chart type value.
`static int`	`BOX` Shape object type.
`static int`	`BUBBLE_2D` The chart type value.
`static int`	`CENTERBOTTOM` The alignment type value.
`static int`	`CENTERCENTER` The alignment type value.
`static int`	`CENTERTOP` The alignment type value.
`static int`	`CHART2DCOORDINATEPAPER` Combinatorial 2D Chart CoordinatePaper object type.
`static int`	`CHARTCOORDINATEPAPER` Combinatorial Chart CoordinatePaper object type.
`static int`	`CHARTLABEL` Combinatorial Chart Label object type
`static int`	`CHARTLEGEND` Combinatorial Chart Legend object type.
`static int`	`CHARTPLATFORM` Combinatorial Chart Platform object type.
`static int`	`CODABAR` The Barcode type value.
`static int`	`CODE_128` The Barcode type value.
`static int`	`CODE_39` The Barcode type value.
`static int`	`COLUMN` Table Column object type.
`static int`	`COMPUTEDCOLUMN` ComputedColumn Field object type.
`static int`	`CROSSTAB` Combinatorial Crosstab object type.
`static int`	`CTAGGFIELD` Combinatorial Crosstab Aggregation Field object type.
`static int`	`CTAGGINFO` Combinatorial Crosstab AggregationInfo object type.
`static int`	`CTDBFIELD` Combinatorial Crosstab Field object type.
`static int`	`CTHDDBFIELD` Combinatorial Crosstab Header Field object type.
`static int`	`CTHDTEXTFIELD` Combinatorial Crosstab HeaderText Field object type.
`static int`	`DATAOBJECT` DataContainer object type.
`static int`	`DATASET` DataSet object type.
`static int`	`DATASET_TYPE_HDS` The Dataset type constant.
`static int`	`DATASET_TYPE_ONDEMAND` The Dataset type constant.
`static int`	`DATASET_TYPE_QUERY` The Dataset type constant.
`static int`	`DBFIELD` Database Field object type.
`static int`	`DETAIL` Detail Section object type.
`static int`	`DIRECTION_BACKSIDE` The type values.
`static int`	`DIRECTION_FORESIDE` The direction value.
`static int`	`EAN_13` The Barcode type value.
`static int`	`EAN_8` The Barcode type value.
`static int`	`FETCHDATE` JReport Special Field object type
`static int`	`FETCHTIME` JReport Special Field object type
`static int`	`FIELD_CATALOGPATH_ONDISK` JReport Special Field object types.
`static int`	`FIELD_CATALOGPATH_ONSERVER` JReport Special Field object types.
`static int`	`FIELD_REPORTPATH_ONDISK` JReport Special Field object types.
`static int`	`FIELD_REPORTPATH_ONSERVER` JReport Special Field object types.
`static int`	`FORMULA` Formula Field object type.
`static int`	`GAUGE_BALLS_2D` The chart type value.
`static int`	`GAUGE_BARS_2D` The chart type value.
`static int`	`GAUGE_DIALS_2D` The chart type value.
`static int`	`GROUP` Group object type.
`static int`	`GROUPFOOTER` GroupFooter Section object type.
`static int`	`GROUPHEADER` GroupHeader Section object type.
`static int`	`GROUPNAME` JReport Special Field object type
`static int`	`GROUPNUMBER` JReport Special Field object type
`static int`	`GROUPNUMBERS` JReport Special Field object type
`static int`	`IMAGE` Image object type.
`static int`	`JBROWSER` JReport UDO object type
`static int`	`JHYPERLINK` JReport UDO object type
`static int`	`JUSTIFYBOTTOM` The alignment type value.
`static int`	`JUSTIFYCENTER` The alignment type value.
`static int`	`JUSTIFYTOP` The alignment type value.
`static int`	`LABEL` Label Field object type.
`static int`	`LEFT` The moving direction value.
`static int`	`LEFT_UNDERSIDE_POINT` The resize direction value.
`static int`	`LEFT_UPSIDE_POINT` The resize direction value.
`static int`	`LEFTBOTTOM` The alignment type value.
`static int`	`LEFTCENTER` The alignment type value.
`static int`	`LEFTTOP` The alignment type value.
`static int`	`LINE` Shape object type.
`static int`	`LINE_ARRAY_2D` The chart type value.
`static int`	`LINE_ARRAY_3D` The chart type value.
`static int`	`LINE_ARRAY_LINE_ARRAY_2D` The chart type value.
`static int`	`LINE_PERCENT_2D` The chart type value.
`static int`	`LINE_STACK_2D` The chart type value.
`static int`	`LINECHART` The chart type value.
`static int`	`MEDIAFIELD` JReport MediaField object type.
`static int`	`MODIFIEDDATE` JReport Special Field object type
`static int`	`MODIFIEDTIME` JReport Special Field object type
`static int`	`MULTI_VALUE_BOX` Container object type.
`static int`	`NEWSTYLETABLE` Table object type.
`static int`	`OVAL` Shape object type.
`static int`	`PAGE` Page container object type.
`static int`	`PAGEBREAK` JReport PageBreak object type.
`static int`	`PAGEEND` JReport PageEnd object type.
`static int`	`PAGEFOOTER` PageFooter Section object type.
`static int`	`PAGEHEADER` PageHeader Section object type.
`static int`	`PAGENOFM` Special Field object types.
`static int`	`PAGENUMBER` JReport Special Field object type
`static int`	`PAGENUMBERS` JReport Special Field object type
`static int`	`PAGESTART` JReport PageStart object type.
`static int`	`PARAGRAPH` Container object type.
`static int`	`PARALLELDETAIL` Parallel Detail Section object type.
`static int`	`PARAMETER` Parameter Field object type.
`static int`	`PIE_SIDEBYSIDE_2D` The chart type value.
`static int`	`PIE_SIDEBYSIDE_3D` The chart type value.
`static int`	`PIECHART` The chart type value.
`static int`	`PRINTDATE` JReport Special Field object type
`static int`	`PRINTTIME` JReport Special Field object type
`static int`	`RADAR_2D` The chart type value.
`static int`	`RECORDNUMBER` JReport Special Field object type
`static int`	`RENDER_BARCODE` The field render type constant.
`static int`	`RENDER_BUTTON` The field render type constant.
`static int`	`RENDER_CHECKBOX` The field render type constant.
`static int`	`RENDER_DROPDOWNLIST` The field render type constant.
`static int`	`RENDER_IMAGE` The field render type constant.
`static int`	`RENDER_IMAGEBUTTON` The field render type constant.
`static int`	`RENDER_LIST` The field render type constant.
`static int`	`RENDER_RADIOBTN` The field render type constant.
`static int`	`RENDER_RANK` The field render type constant.
`static int`	`RENDER_RESETBUTTON` The field render type constant.
`static int`	`RENDER_SUBMITBUTTON` The field render type constant.
`static int`	`RENDER_TEXT` The field render type constant.
`static int`	`RENDER_TEXTAREA` The field render type constant.
`static int`	`RENDER_TEXTFIELD` The field render type constant.
`static int`	`REPORT` Report object type.
`static int`	`REPORTBODY` ReportBody object type.
`static int`	`REPORTFOOTER` ReportFooter Section object type.
`static int`	`REPORTHEADER` ReportHeader Section object type.
`static int`	`REPORTSET` ReportSet object type.
`static int`	`REPORTSHEET` Report object type.
`static int`	`RIGHT` The moving direction value.
`static int`	`RIGHT_UNDERSIDE_POINT` The resize direction value.
`static int`	`RIGHT_UPSIDE_POINT` The resize direction value.
`static int`	`RIGHTBOTTOM` The alignment type value.
`static int`	`RIGHTCENTER` The alignment type value.
`static int`	`RIGHTTOP` The alignment type value.
`static int`	`ROUNDBOX` Shape object type.
`static int`	`RPTDATASOURCE` Report Datasource object type
`static int`	`SCATTER_POINTS_2D` The chart type value.
`static int`	`SCATTER_SMOOTH_LINES_2D` The chart type value.
`static int`	`SCATTER_STRAIGHT_LINES_2D` The chart type value.
`static int`	`SHAPE` Shape object type.
`static int`	`SIDEBYSIDEBARCHART` The chart type value.
`static int`	`SQLSTATMENT` JReport Special Field object type
`static int`	`STACKEDBARCHART` The chart type value.
`static int`	`STACKEDBENCH` The chart type value.
`static int`	`STOCK_HIGH_LOW_2D` The chart type value.
`static int`	`STOCK_HIGH_LOW_CLOSE_2D` The chart type value.
`static int`	`STOCK_OPEN_HIGH_LOW_CLOSE_2D` The chart type value.
`static int`	`SUBLINK` SubreportLink object type.
`static int`	`SUBPARAMLINK` Subreport ParamterLink object type.
`static int`	`SUBREPORT` Subreport object type.
`static int`	`SUBRETVALUE` Subreport ReturnValue object type .
`static int`	`SUMMARY` Summary Field object type.
`static int`	`SURFACE_3D` The chart type value.
`static int`	`TABLE` Deprecated.
`static int`	`TABLE_COMMONCOLUMN` Table COMMON column object type.
`static int`	`TABLE_DETAILCOLUMN` Table DETAIL column object type.
`static int`	`TABLE_DETAILSECTION` TableDetail Section object type.
`static int`	`TABLE_FOOTERSECTION` TableFooter Section object type.
`static int`	`TABLE_GROUP_FOOTERSECTION` Table GroupFooter section object type.
`static int`	`TABLE_GROUP_HEADERSECTION` Table GroupHeader section object type.
`static int`	`TABLE_GROUPCOLUMN` Table GROUP column object type.
`static int`	`TABLE_HEADERSECTION` TableHeader Section object type.
`static int`	`TABLE_SUMMARYCOLUMN` Table SUMMARY column object type.
`static int`	`TABLECELL` Table cell object type.
`static int`	`TABULARCELL` JReport Tabula object type.
`static int`	`TEXT` JReport TextArea object type.
`static int`	`TEXTBOX` TextBox object type.
`static int`	`UDO` JReport UDO object type.
`static int`	`UPC_A` The Barcode type value.
`static int`	`UPC_E` The Barcode type value.
`static int`	`USERNAME` JReport Special Field object type
`static int`	`ZORDER_BACKWARD` The z-order type constant.
`static int`	`ZORDER_BOTTOM` The z-order type constant.
`static int`	`ZORDER_FORWARD` The z-order type constant.
`static int`	`ZORDER_TOP` The z-order type constant.

Fields inherited from class jet.api.API
`BOOLEAN, CAT, CENTIMETER, COLOR, DOUBLE, ENUM, FLOAT, INCH, INTEGER, LONG, PIXEL, REFERENCE, RPT, SELFRPT, STRING, TEXTRPT, UNKNOWN, XMLCAT, XMLRPT`

Constructor Summary
`Designer(java.lang.String path, java.lang.String name)` Deprecated. since version 6.1. Replaced by `Designer(String, String, DesignerUserInfo)`
`Designer(java.lang.String path, java.lang.String name, DesignerUserInfo user)` Constructor.
`Designer(java.lang.String path, java.lang.String name, java.lang.String suffix)` Deprecated. since version 6.1.
`Designer(java.lang.String path, java.lang.String name, java.lang.String suffix, DesignerUserInfo user)` Constructor.

Method Summary
`java.lang.String`	`addDataset(java.lang.String reportsetHandle, java.lang.String datasourceName, java.lang.String queryName, java.lang.String name, java.lang.String BVName, int datasetType)` Creates a dataset in the reportset.
`void`	`addDisplayName(java.lang.String report, DisplayNameInfo displayNameInfo)` Adds a Display Name into a report.
`boolean`	`addDisplayName(java.lang.String report, java.lang.String datasetHandle, DisplayNameInfo displayNameInfo)` Adds a DisplayName to a report.
`java.lang.String`	`addReport(java.lang.String reportsetHandle, java.lang.String name)` Adds a report to the reportset.
`boolean`	`appendTabularColumn(java.lang.String tabular)` Adds a tabular column after the last column of the tabular.
`boolean`	`appendTabularRow(java.lang.String tabular)` Adds a tabular row after the last row of the tabular.
`boolean`	`bindDataSet(java.lang.String handle, java.lang.String datasetName)` Binds a dataset to a data container object.
`boolean`	`canDeleted(java.lang.String handle)` Checks whether the instance can be deleted or not.
`boolean`	`canMergeTableCell(java.lang.String table, java.lang.String[] cellHandles)` Checks whether the cells can be merged or not.
`boolean`	`canMergeTabularCell(java.lang.String tabular, java.lang.String[] cellHandles)` Checks whether the cells can be merged or not.
`boolean`	`changeTabularCellHeight(java.lang.String tabular, java.lang.String cellHandle, double dispersion)` Modifies a tabular cell object's height.
`boolean`	`changeTabularCellWidth(java.lang.String tabular, java.lang.String cellHandle, double dispersion)` Modifies a tabular cell object's width.
`boolean`	`changeTabularHeight(java.lang.String tabular, double dispersion)` Modifies a tabular object's height.
`boolean`	`changeTabularWidth(java.lang.String tabular, double dispersion)` Modifies a tabular object's width.
`boolean`	`changeZOrder(java.lang.String objectHandle, int zorderType)` Sets z-order of cascading objects.
`boolean`	`close(java.lang.String handle)` Closes a report panel according to a report handle.
`boolean`	`closeReportSet()` Closes the current reportset and saves the changes.
`java.lang.String`	`create(java.lang.String name, java.lang.String query)` Deprecated. since version 8.0, replaced by `createReportSet(String)`.
`java.lang.String`	`create(java.lang.String name, java.lang.String sourceName, java.lang.String query)` Deprecated. since version 8.0, replaced by `createReportSet(String)`.
`java.lang.String`	`createReportSet(java.lang.String name)` Creates a new reportset with an instance name.
`boolean`	`delete(java.lang.String handle)` Deletes an object from its parent node.
`boolean`	`deleteBandedObject(java.lang.String bandedObject)` Deletes a Banded Object from a report
`boolean`	`deleteCrossTabAggregations(java.lang.String crossTab, int[] index)` Deletes aggregations from a crosstab.
`boolean`	`deleteCrossTabColumns(java.lang.String crossTab, int[] index)` Deletes crosstab columns.
`boolean`	`deleteCrossTabRows(java.lang.String crossTab, int[] index)` Deletes rows from a crosstab.
`boolean`	`deleteDetailPanel(java.lang.String detailSection)` Deletes a detail section from a report.
`boolean`	`deleteGroup(java.lang.String groupHandle, boolean removeAllChildren)` Deletes a group object from a report.
`boolean`	`deletePage(java.lang.String pageHandle)` Deletes a page panel object from a report.
`boolean`	`deletePageController(java.lang.String controllerHandle)` Deletes a page controller object from a report
`boolean`	`deleteReport(java.lang.String name)` Deprecated. since version 8.0, replaced by `deleteReportFile(String)`.
`boolean`	`deleteReport(java.lang.String rptsetHandle, java.lang.String name)` Deletes a report from the reportset.
`boolean`	`deleteReportFile(java.lang.String name)` Deletes a reportset file with a file name.
`boolean`	`deleteSectionFooterPanel(java.lang.String footerSection)` Deletes a footer section from a report
`boolean`	`deleteSectionHeaderPanel(java.lang.String headerSection)` Deletes a header section from a report.
`boolean`	`deleteTableColumns(java.lang.String table, int[] index)` Deletes columns from a new style table.
`boolean`	`deleteTabularColumn(java.lang.String tabular, java.lang.String cellHandle)` Deletes a tabular column from a tabular.
`boolean`	`deleteTabularRow(java.lang.String tabular, java.lang.String cellHandle)` Deletes a tabular row from a tabular.
`void`	`exit()` Exits from editing mode.
`void`	`exitAndSave()` Exits from editing mode.
`java.util.Vector`	`getAllDisplayNames(java.lang.String report)` Gets all DisplayName objects in a report.
`java.lang.String[]`	`getAllResourceNames(java.lang.String report)` Gets all resource names used in report.
`CatalogAPI`	`getCatalogAPI()` Gets a CatalogAPI instance with the specified catalog.
`java.lang.String`	`getCatalogName()` Gets the loaded catalog's name.
`java.lang.String[]`	`getChangedByFields(java.lang.String handle, java.lang.String propertyName)` Gets the fields that can be used to control the object's property values at runtime.
`ChartLabelInfo`	`getChartLabel(java.lang.String handle)` Gets the label information in the chart.
`java.lang.String`	`getControlField(java.lang.String handle, java.lang.String name)` Gets the field that controls the property value at runtime.
`java.lang.String[]`	`getControlFields(java.lang.String handle, java.lang.String name)` Gets the fields that can be used to control an object's property values at runtime.
`BLFilterInformation`	`getDatasetBLFilter(java.lang.String datasetHandle)` Gets a JReport businees logic filter from the specified dataset.
`java.lang.String[]`	`getDBFields(java.lang.String handle)` Gets the DBField mapping names from the query that is bound to the object
`DisplayNameInfo`	`getDisplayName(java.lang.String report, java.lang.String resourceName)` Gets the definition of DisplayName by field mapping name.
`java.lang.String[]`	`getFormats(java.lang.String handle)` Gets the default format list of the object.
`java.lang.String[]`	`getFormulae(java.lang.String handle)` Gets the formulae that can be used in the report.
`java.lang.String[]`	`getFormulas(java.lang.String report)` Gets all formula names used in a report.
`java.lang.String[]`	`getGeometries(java.lang.String handle)` Gets the handles of the geometry objects in a report.
`java.lang.String[]`	`getGeometries(java.lang.String handle, boolean visible)` Gets the handles of the geometry objects in a report.
`GroupInfo[]`	`getGroupInfo(java.lang.String handle)` Gets the group information of the report.
`java.util.Vector`	`getGroupNames(java.lang.String report)` Gets all groupby fields' mapping names of the groups in a report.
`java.lang.String[]`	`getGroups(java.lang.String handle)` Gets the handles of the groups in a report.
`int`	`getIndex(java.lang.String objHandle)` Gets the child index in its parent container.
`java.lang.String`	`getKey()` Gets the key of JReport Design API.
`float`	`getMinSectionHeight(java.lang.String handle)` Gets the minimum height value of the section.
`ObjectInfo`	`getObjectInfo(java.lang.String handle)` Gets the property information of the object.
`int`	`getObjectType(java.lang.String handle)` Gets the int type value of the object.
`java.lang.String[]`	`getParameter()` Gets all parameters in the default data source in the catalog.
`java.lang.String`	`getParent(java.lang.String handle)` Gets the container(parent) of the object.
`java.lang.String[]`	`getProcedures()` Gets Stored Procedures in the default data source in the catalog.
`java.lang.String[]`	`getProcedures(java.lang.String sourceName)` Gets Stored Procedures in the specified data source in the catalog.
`java.lang.String[]`	`getQueries()` Gets the queries in the default data source in the catalog.
`java.lang.String[]`	`getQueries(java.lang.String sourceName)` Gets the queries in the specified data source in the catalog.
`java.lang.String`	`getQueryName(java.lang.String handle)` Gets query name of a report.
`java.lang.String`	`getReporthome()` Gets the install root of the application,
`ReportSortInfo`	`getReportSortInfo(java.lang.String handle)` Gets the sort information of the report
`java.lang.String[]`	`getSections(java.lang.String handle)` Gets the handles of the sections in a report.
`java.lang.String[]`	`getSections(java.lang.String handle, boolean visible)` Gets the handles of the sections in a report.
`java.lang.String[]`	`getSections(java.lang.String handle, boolean visible, int type)` Gets the handles of the sections in a report.
`SortInfo[]`	`getSortInfo(java.lang.String handle)` Gets the sort information of the group or the report
`java.lang.String[]`	`getSQLs()` Gets Import SQLs in the default data source in the catalog.
`java.lang.String[]`	`getSQLs(java.lang.String sourceName)` Gets Import SQLs in the specified data source in the catalog.
`java.lang.String[]`	`getSummaries(java.lang.String handle)` Gets the summaries that can be used in the report.
`java.lang.String`	`getTableColumnHandle(java.lang.String tableHandle, int index)` Gets the specified table column's handle.
`int`	`getTableColumnIndex(java.lang.String columnHandle)` Gets the table column's index.
`double`	`getTableWidth(java.lang.String parent, TableTemplateInfo info)` Gets the preferred table width according to the specified TableTemplateInfo.
`java.lang.String`	`getTabularCell(java.lang.String tabular, int rowIndex, int colIndex)` Gets the handle of the cell in the specified tabular row or column.
`java.lang.String[]`	`getTabularColumnCells(java.lang.String tabular, int index)` Gets the handles of the cells in a specified tabular column.
`java.lang.String[]`	`getTabularRowCells(java.lang.String tabular, int index)` Gets the handles of the cells in a specified tabular row
`java.lang.String[]`	`getUDS()` Gets Import UDSs in the default data source in the catalog.
`java.lang.String[]`	`getUDS(java.lang.String sourceName)` Gets UDSs in the specified data source in the catalog.
`java.lang.String`	`getUID()` Gets the UserID of JReport Design API.
`java.lang.String`	`getUserID()` Gets user ID of the designer API instance.
`java.lang.String[]`	`getViews()` Gets the database Views in the default data source in the catalog.
`boolean`	`hasPageSecurity(java.lang.String handle)` Gets the status whether the report use page level security or not.
`boolean`	`hideTableColumn(java.lang.String table, int index)` Hides a table column.
`java.lang.String`	`insert(java.lang.String parent, ChartLegendInfo chartLegendInfo, java.lang.String paperName)` Inserts a chart object and its children into the parent node.
`java.lang.String`	`insert(java.lang.String parent, CTRowColFieldInfo colInfo, CTRowColFieldInfo rowInfo, CTAggFieldInfo aggInfo)` Deprecated. since version 8.0, replaced by `String , CrossTabInfo`.
`java.lang.String`	`insert(java.lang.String parent, int type, java.lang.String name)` Inserts an object into the parent node.
`java.lang.String`	`insert(java.lang.String parent, int type, java.lang.String name, GroupInfo groupInfo, SpecGroupInfo specGroupInfo)` Inserts a group/sort into the parent node.
`java.lang.String`	`insert(java.lang.String parent, int type, java.lang.String name, java.lang.String mapping)` Inserts an object of database field, parameter, formula , summary or group into the parent node.
`java.lang.String`	`insert(java.lang.String parent, int type, java.lang.String name, java.lang.String topSection, java.lang.String bottomSection)` Inserts a shape object such as box, line, arc, or oval into the report.
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, boolean avoid, boolean onleft, boolean ontop, boolean repeat, boolean vertical, int boundary, CTRowColFieldInfo[] colInfo, CTRowColFieldInfo[] rowInfo, CTAggFieldInfo[] aggInfo)` Deprecated. since version 8.0.Replaced by `insertCrossTab(String, CrossTabInfo)`
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, CTRowColFieldInfo[] colInfo, CTRowColFieldInfo[] rowInfo, CTAggFieldInfo[] aggInfo)` Deprecated. since version 8.0. Replaced by `insertCrossTab(String, CrossTabInfo)`
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, GroupInfo groupInfo)` Deprecated. since version 8.0. Replaced by `insertSectionGroup(group, groupInfo)`
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, int type, boolean isGroup, java.lang.String group1, java.lang.String group2, java.lang.String[] value)` Deprecated. since version 8.0. Replaced by `insertChart(String, ChartInfo)`
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, java.lang.String UDOname)` Inserts a UDO object into the parent node.
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, java.lang.String paperName, int type, boolean isGroup, java.lang.String group1, java.lang.String group2, java.lang.String[] value, ChartLegendInfo chartLegendInfo, ChartLabelInfo chartLabelInfo)` Inserts a chart object and its children into the parent node.
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, java.lang.String paperName, int type1, int type2, boolean isGroup, java.lang.String group1, java.lang.String group2, java.lang.String[] value, ChartLegendInfo chartLegendInfo, ChartLabelInfo chartLabelInfo)` Inserts a combo chart object and its children into the parent node.
`java.lang.String`	`insert(java.lang.String parent, java.lang.String name, java.lang.String paperName, int type, java.lang.String group1, java.lang.String group2, java.lang.String value, ChartLegendInfo chartLegendInfo, ChartLabelInfo chartLabelInfo)` Deprecated. since version 8.0. Replaced by `insertChart(String, ChartInfo)`
`java.lang.String`	`insertBandedObject(java.lang.String parent, boolean withHeader, boolean withFooter, boolean withDetail)` Inserts a Banded Object into a report.
`java.lang.String`	`insertChart(java.lang.String parent, ChartInfo info)` Inserts a chart into a report.
`java.lang.String`	`insertColumn(java.lang.String parent, int type, java.lang.String name, java.lang.String mapping, int index)` Deprecated. since version 8.0, replaced by `insertTableColumn(String, int, int, String, String, boolean, boolean)`.
`java.lang.String`	`insertCrossTab(java.lang.String parent, CrossTabInfo info)` Inserts a crosstab into the report.
`java.lang.String`	`insertCrossTabAggregations(java.lang.String crossTab, CTAggFieldInfo[] infos, int index)` Inserts aggregations into a crosstab
`java.lang.String`	`insertCrossTabColumns(java.lang.String crossTab, CTRowColFieldInfo[] infos, int index)` Inserts columns into a crosstab.
`java.lang.String`	`insertCrossTabRows(java.lang.String crossTab, CTRowColFieldInfo[] infos, int index)` Inserts rows into a crosstab
`java.lang.String`	`insertDetailPanel(java.lang.String parent, java.lang.String referredHandle, boolean isinsertedBefore)` Inserts a detail section object into a report.
`java.lang.String`	`insertField(java.lang.String parent, java.lang.String mappingName, java.lang.String blName, int fieldType, int renderType)` Inserts a field object into a report.
`java.lang.String`	`insertPage(java.lang.String reportHandle)` Inserts a page panel object into a report.
`java.lang.String`	`insertPageBreak(java.lang.String parent, java.lang.String referredHandle, boolean isinsertedBefore)` Inserts a page break object into a report.
`java.lang.String[]`	`insertPageStartEnd(java.lang.String pageHandle, java.lang.String parent, int startIndex, int endIndex)` Inserts a page control object into a report
`java.lang.String`	`insertSectionFooterPanel(java.lang.String parent, java.lang.String referredHandle, boolean isinsertedBefore)` Inserts a banded object section footer into a report
`java.lang.String`	`insertSectionGroup(java.lang.String parent, GroupInfo groupInfo)` Inserts a group object into a report.
`java.lang.String`	`insertSectionHeaderPanel(java.lang.String parent, java.lang.String referredHandle, boolean isinsertedBefore)` Inserts a banded object header section object into a report
`java.lang.String`	`insertSectionPanel(java.lang.String parent, java.lang.String referredHandle, int sectionType, boolean isinsertedBefore)` Inserts a banded object section into a report
`java.lang.String`	`insertShape(java.lang.String parent, Shape shape)` Inserts a geometry object into a report.
`java.lang.String`	`insertSubReport(java.lang.String parent, SubReportInfo info)` Inserts a Subreport into a report.
`java.lang.String`	`insertTable(java.lang.String parent, TableTemplateInfo info)` Inserts a new style (post V8) table into the report.
`java.lang.String`	`insertTable(java.lang.String parent, TableTemplateInfo info, boolean increasePanel)` Inserts a new style (post V8) table into the report.
`java.lang.String`	`insertTableColumn(java.lang.String table, int index, int direction)` Inserts a column into a new style table.
`java.lang.String`	`insertTableColumn(java.lang.String table, int index, int direction, java.lang.String fieldName, java.lang.String title, boolean increaseTable, boolean auotResetPage)` Inserts a column with fields into a new style table
`java.lang.String`	`insertTableGroup(java.lang.String table, java.lang.String parentGroup, java.lang.String mapping, java.lang.String blName)` Inserts a group into the table.
`java.lang.String`	`insertTabular(java.lang.String parent, java.lang.String tabularName, int colVol, int rowVol)` Inserts a new tabular object into a report.
`boolean`	`mergeTableCells(java.lang.String table, java.lang.String[] cellsid)` Merges table cells into one cell.
`java.lang.String`	`mergeTabularCells(java.lang.String tabular, java.lang.String[] cellsid)` Merges several tabular cells into one cell.
`java.lang.String`	`moveCrossTabAggregations(java.lang.String crossTab, int[] orignalIndex, int desIndex)` Adjusts crosstab aggregations' positions in the summary areas of a crosstab.
`java.lang.String`	`moveCrossTabColumns(java.lang.String crossTab, int[] orignalIndex, int desIndex)` Adjusts a crosstab's column order.
`java.lang.String`	`moveCrossTabRows(java.lang.String crossTab, int[] orignalIndex, int desIndex)` Adjusts a crosstab's row order.
`boolean`	`moveTableColumns(java.lang.String table, int[] index, int step, int direction)` Moves columns in a table
`java.lang.String`	`open(java.lang.String name)` Loads a report panel according to a report file name.
`boolean`	`pivotCrossTab(java.lang.String crossTab)` Pivots the crosstab.
`boolean`	`pivotTable(java.lang.String table, int colIndex1, int colIndex2)` Exchanges the specified table's columns.
`boolean`	`quit()` Quits from editing mode without saving any changes to the catalog and the reportsets.
`boolean`	`quit(java.lang.String handle)` Quits the specified report according to the report handle without any changes being saved.
`boolean`	`removeDisplayName(java.lang.String report, DisplayNameInfo displayNameInfo)` Removes a DisplayName object from a report.
`java.lang.String`	`removeTableGroup(java.lang.String table, java.lang.String group)` Removes the specified group from the table.
`boolean`	`resizeTable(java.lang.String table, int refPoint, double xPercentage, double yPercentage, boolean increasePanel)` Resizes the table in the specified rate.
`boolean`	`resizeTabular(java.lang.String tabular, int refPoint, double xPercentage, double yPercentage, boolean increasePanel)` Resizes the Tabular in the specified rate.
`java.lang.String`	`saveAs(java.lang.String handle, java.lang.String newname)` Saves a report as a new report file.
`boolean`	`saveSelfContainedReport(java.lang.String rptHandle, java.lang.String path, java.lang.String filename)` Saves the report as a self-contained report.
`boolean`	`saveSelfReport(java.lang.String path, java.lang.String name, java.lang.String newName)` Deprecated. since version 8.0,replaced by `saveSelfContainedReport(String, String, String )`.
`boolean`	`set(java.lang.String handle, java.lang.String name, float value)` Changes the property value of an object.
`boolean`	`set(java.lang.String handle, java.lang.String name, int value)` Changes the property value of an object.
`boolean`	`setControlFields(java.lang.String handle, java.lang.String prop, java.lang.String field)` Sets the field to control the property value at runtime.
`boolean`	`setCTAggFieldHeight(java.lang.String crossTab, int yDepth, int index, double height)` Sets the specified aggregation's height in a crosstab.
`boolean`	`setCTAggFieldWidth(java.lang.String crossTab, int xDepth, int index, double width)` Sets the specified aggregation's width in a crosstab.
`boolean`	`setCTAggTitleHeight(java.lang.String crossTab, int index, double height)` sets the height of a crosstab aggregation's title
`boolean`	`setCTAggTitleWidth(java.lang.String crossTab, int index, double width)` sets the width of a crosstab aggregation's title
`boolean`	`setCTColHeaderHeight(java.lang.String crossTab, int index, double height)` Sets the specified column header's cell height of a crosstab.
`boolean`	`setCTRowHeaderWidth(java.lang.String crossTab, int index, double width)` Sets the specified row header's cell width of crosstab.
`boolean`	`setDataset(java.lang.String objHandle, java.lang.String datasetHandle)` Applys a dataset to the report object.
`boolean`	`setDatasetBLFilter(java.lang.String datasetHandle, BLFilterInformation filterInfo)` Applys a JReport BusinessLogic filter to the dataset.
`boolean`	`setDefaultFormat(java.lang.String handle)` Sets a default object format for an object.
`void`	`setPageWidth(double width)` Sets the width of the page panel and also its sections.
`void`	`setReporthome(java.lang.String reporthome)` Sets the reporthome of the application.
`void`	`setReportSortInfo(java.lang.String handle, ReportSortInfo sortInfo)` Sets the sort information of the whole report
`void`	`setSortInfo(java.lang.String handle, SortInfo[] sortInfo)` Sets the sort information of the specified group
`boolean`	`setStyle(java.lang.String reportHandle, java.lang.String[] objectHandles, java.lang.String styleName, boolean isURL)` Sets css or a style to the report objects.
`boolean`	`setStyle(java.lang.String reportHandle, java.lang.String viewName, java.lang.String styleName)` Sets css or a style to the report.
`boolean`	`setTableColumnWidth(java.lang.String table, int index, double increment, boolean increaseTable, boolean increasePanel)` Resets the table column's width
`void`	`setUserInfo(java.lang.String uid, java.lang.String key)` Deprecated. since version 6.1.
`boolean`	`showTableColumn(java.lang.String table, int index)` Makes a hidden table column to be visible
`boolean`	`splitTabularCell(java.lang.String tabular, java.lang.String cellHandle, int rowVol, int clmVol)` Splits a tabular cell into a set of cells.
`void`	`updateDisplayName(java.lang.String report, DisplayNameInfo displayNameInfo)` Updates the properties of an existing DisplayName in a report.

Methods inherited from class jet.api.API
`clearError, clearMsg, clearWarning, closeLog, containPropName, getBool, getChildren, getClassType, getColor, getDouble, getError, getFloat, getHandles, getHandles, getHandles, getHandles, getInstanceName, getInt, getLong, getPropNames, getPropType, getQualifyName, getString, getStringArray, getUnit, getWarning, set, set, set, set, set, setLog, setLog, setLog, setReference, setUnit, writeLog, writeLog`

Methods inherited from class jet.api.API

clearError, clearMsg, clearWarning, closeLog, containPropName, getBool, getChildren, getClassType, getColor, getDouble, getError, getFloat, getHandles, getHandles, getHandles, getHandles, getInstanceName, getInt, getLong, getPropNames, getPropType, getQualifyName, getString, getStringArray, getUnit, getWarning, set, set, set, set, set, setLog, setLog, setLog, setReference, setUnit, writeLog, writeLog

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

REPORT

public static final int REPORT

Report object type.

See Also:: Constant Field Values

PAGE

public static final int PAGE

Page container object type.

See Also:: Constant Field Values

GROUP

public static final int GROUP

Group object type.

See Also:: Constant Field Values

REPORTHEADER

public static final int REPORTHEADER

ReportHeader Section object type.

See Also:: Constant Field Values

REPORTFOOTER

public static final int REPORTFOOTER

ReportFooter Section object type.

See Also:: Constant Field Values

PAGEHEADER

public static final int PAGEHEADER

PageHeader Section object type.

See Also:: Constant Field Values

PAGEFOOTER

public static final int PAGEFOOTER

PageFooter Section object type.

See Also:: Constant Field Values

GROUPHEADER

public static final int GROUPHEADER

GroupHeader Section object type.

See Also:: Constant Field Values

GROUPFOOTER

public static final int GROUPFOOTER

GroupFooter Section object type.

See Also:: Constant Field Values

DETAIL

public static final int DETAIL

Detail Section object type.

See Also:: Constant Field Values

LABEL

public static final int LABEL

Label Field object type.

See Also:: Constant Field Values

DBFIELD

public static final int DBFIELD

Database Field object type.

See Also:: Constant Field Values

COMPUTEDCOLUMN

public static final int COMPUTEDCOLUMN

ComputedColumn Field object type.

See Also:: Constant Field Values

FORMULA

public static final int FORMULA

Formula Field object type.

See Also:: Constant Field Values

SUMMARY

public static final int SUMMARY

Summary Field object type.

See Also:: Constant Field Values

PARAMETER

public static final int PARAMETER

Parameter Field object type.

See Also:: Constant Field Values

IMAGE

public static final int IMAGE

Image object type.

See Also:: Constant Field Values

USERNAME

public static final int USERNAME

JReport Special Field object type

See Also:: Constant Field Values

PRINTDATE

public static final int PRINTDATE

JReport Special Field object type

See Also:: Constant Field Values

PRINTTIME

public static final int PRINTTIME

JReport Special Field object type

See Also:: Constant Field Values

FETCHDATE

public static final int FETCHDATE

JReport Special Field object type

See Also:: Constant Field Values

FETCHTIME

public static final int FETCHTIME

JReport Special Field object type

See Also:: Constant Field Values

MODIFIEDDATE

public static final int MODIFIEDDATE

JReport Special Field object type

See Also:: Constant Field Values

MODIFIEDTIME

public static final int MODIFIEDTIME

JReport Special Field object type

See Also:: Constant Field Values

RECORDNUMBER

public static final int RECORDNUMBER

JReport Special Field object type

See Also:: Constant Field Values

GROUPNAME

public static final int GROUPNAME

JReport Special Field object type

See Also:: Constant Field Values

GROUPNUMBER

public static final int GROUPNUMBER

JReport Special Field object type

See Also:: Constant Field Values

GROUPNUMBERS

public static final int GROUPNUMBERS

JReport Special Field object type

See Also:: Constant Field Values

PAGENUMBER

public static final int PAGENUMBER

JReport Special Field object type

See Also:: Constant Field Values

PAGENUMBERS

public static final int PAGENUMBERS

JReport Special Field object type

See Also:: Constant Field Values

SQLSTATMENT

public static final int SQLSTATMENT

JReport Special Field object type

See Also:: Constant Field Values

TEXT

public static final int TEXT

JReport TextArea object type.

See Also:: Constant Field Values

CHARTLABEL

public static final int CHARTLABEL

Combinatorial Chart Label object type

See Also:: Constant Field Values

CHARTLEGEND

public static final int CHARTLEGEND

Combinatorial Chart Legend object type.

See Also:: Constant Field Values

CHARTPLATFORM

public static final int CHARTPLATFORM

Combinatorial Chart Platform object type.

See Also:: Constant Field Values

CHARTCOORDINATEPAPER

public static final int CHARTCOORDINATEPAPER

Combinatorial Chart CoordinatePaper object type.

See Also:: Constant Field Values

CROSSTAB

public static final int CROSSTAB

Combinatorial Crosstab object type.

See Also:: Constant Field Values

CTAGGFIELD

public static final int CTAGGFIELD

Combinatorial Crosstab Aggregation Field object type.

See Also:: Constant Field Values

CTAGGINFO

public static final int CTAGGINFO

Combinatorial Crosstab AggregationInfo object type.

See Also:: Constant Field Values

CTDBFIELD

public static final int CTDBFIELD

Combinatorial Crosstab Field object type.

See Also:: Constant Field Values

CTHDDBFIELD

public static final int CTHDDBFIELD

Combinatorial Crosstab Header Field object type.

See Also:: Constant Field Values

CTHDTEXTFIELD

public static final int CTHDTEXTFIELD

Combinatorial Crosstab HeaderText Field object type.

See Also:: Constant Field Values

SUBREPORT

public static final int SUBREPORT

Subreport object type.

See Also:: Constant Field Values

SUBLINK

public static final int SUBLINK

SubreportLink object type.

See Also:: Constant Field Values

SUBPARAMLINK

public static final int SUBPARAMLINK

Subreport ParamterLink object type.

See Also:: Constant Field Values

SUBRETVALUE

public static final int SUBRETVALUE

Subreport ReturnValue object type .

See Also:: Constant Field Values

LINE

public static final int LINE

Shape object type.

See Also:: Constant Field Values

BOX

public static final int BOX

Shape object type.

See Also:: Constant Field Values

ROUNDBOX

public static final int ROUNDBOX

Shape object type.

See Also:: Constant Field Values

OVAL

public static final int OVAL

Shape object type.

See Also:: Constant Field Values

ARC

public static final int ARC

Shape object type.

See Also:: Constant Field Values

RPTDATASOURCE

public static final int RPTDATASOURCE

Report Datasource object type

See Also:: Constant Field Values

JHYPERLINK

public static final int JHYPERLINK

JReport UDO object type

See Also:: Constant Field Values

JBROWSER

public static final int JBROWSER

JReport UDO object type

See Also:: Constant Field Values

DATAOBJECT

public static final int DATAOBJECT

DataContainer object type.

See Also:: Constant Field Values

TABLE

public static final int TABLE

Deprecated.

Table object type.

See Also:: Constant Field Values

COLUMN

public static final int COLUMN

Table Column object type.

See Also:: Constant Field Values

MEDIAFIELD

public static final int MEDIAFIELD

JReport MediaField object type.

See Also:: Constant Field Values

UDO

public static final int UDO

JReport UDO object type.

See Also:: Constant Field Values

CHART2DCOORDINATEPAPER

public static final int CHART2DCOORDINATEPAPER

Combinatorial 2D Chart CoordinatePaper object type.

See Also:: Constant Field Values

BARCODEFIELD

public static final int BARCODEFIELD

JReport BarCode object type.

See Also:: Constant Field Values

PAGENOFM

public static final int PAGENOFM

Special Field object types.

See Also:: Constant Field Values

NEWSTYLETABLE

public static final int NEWSTYLETABLE

Table object type.

See Also:: Constant Field Values

TABLECELL

public static final int TABLECELL

Table cell object type.

See Also:: Constant Field Values

REPORTSET

public static final int REPORTSET

ReportSet object type.

See Also:: Constant Field Values

DATASET

public static final int DATASET

DataSet object type.

See Also:: Constant Field Values

REPORTBODY

public static final int REPORTBODY

ReportBody object type.

See Also:: Constant Field Values

PARAGRAPH

public static final int PARAGRAPH

Container object type.

See Also:: Constant Field Values

TEXTBOX

public static final int TEXTBOX

TextBox object type.

See Also:: Constant Field Values

MULTI_VALUE_BOX

public static final int MULTI_VALUE_BOX

Container object type.

See Also:: Constant Field Values

PARALLELDETAIL

public static final int PARALLELDETAIL

Parallel Detail Section object type.

See Also:: Constant Field Values

PAGEBREAK

public static final int PAGEBREAK

JReport PageBreak object type.

See Also:: Constant Field Values

PAGESTART

public static final int PAGESTART

JReport PageStart object type.

See Also:: Constant Field Values

PAGEEND

public static final int PAGEEND

JReport PageEnd object type.

See Also:: Constant Field Values

REPORTSHEET

public static final int REPORTSHEET

Report object type.

See Also:: Constant Field Values

TABULARCELL

public static final int TABULARCELL

JReport Tabula object type.

See Also:: Constant Field Values

BANDEDOBJECT

public static final int BANDEDOBJECT

JReport BandedObject object type.

See Also:: Constant Field Values

BANDEDOBJECT_PAGEHEADER

public static final int BANDEDOBJECT_PAGEHEADER

BandedObject PageHeader Section object type.

See Also:: Constant Field Values

BANDEDOBJECT_PAGEFOOTER

public static final int BANDEDOBJECT_PAGEFOOTER

BandedObject PageFooter Section object type.

See Also:: Constant Field Values

BANDEDOBJECT_HEADER

public static final int BANDEDOBJECT_HEADER

BandedObjectHeader Section object type.

See Also:: Constant Field Values

BANDEDOBJECT_FOOTER

public static final int BANDEDOBJECT_FOOTER

BandedObjectFooter Section object type.

See Also:: Constant Field Values

SHAPE

public static final int SHAPE

Shape object type.

See Also:: Constant Field Values

TABLE_COMMONCOLUMN

public static final int TABLE_COMMONCOLUMN

Table COMMON column object type.

See Also:: Constant Field Values

TABLE_GROUPCOLUMN

public static final int TABLE_GROUPCOLUMN

Table GROUP column object type.

See Also:: Constant Field Values

TABLE_DETAILCOLUMN

public static final int TABLE_DETAILCOLUMN

Table DETAIL column object type.

See Also:: Constant Field Values

TABLE_SUMMARYCOLUMN

public static final int TABLE_SUMMARYCOLUMN

Table SUMMARY column object type.

See Also:: Constant Field Values

TABLE_HEADERSECTION

public static final int TABLE_HEADERSECTION

TableHeader Section object type.

See Also:: Constant Field Values

TABLE_DETAILSECTION

public static final int TABLE_DETAILSECTION

TableDetail Section object type.

See Also:: Constant Field Values

TABLE_FOOTERSECTION

public static final int TABLE_FOOTERSECTION

TableFooter Section object type.

See Also:: Constant Field Values

TABLE_GROUP_HEADERSECTION

public static final int TABLE_GROUP_HEADERSECTION

Table GroupHeader section object type.

See Also:: Constant Field Values

TABLE_GROUP_FOOTERSECTION

public static final int TABLE_GROUP_FOOTERSECTION

Table GroupFooter section object type.

See Also:: Constant Field Values

FIELD_REPORTPATH_ONSERVER

public static final int FIELD_REPORTPATH_ONSERVER

JReport Special Field object types.

See Also:: Constant Field Values

FIELD_REPORTPATH_ONDISK

public static final int FIELD_REPORTPATH_ONDISK

JReport Special Field object types.

See Also:: Constant Field Values

FIELD_CATALOGPATH_ONSERVER

public static final int FIELD_CATALOGPATH_ONSERVER

JReport Special Field object types.

See Also:: Constant Field Values

FIELD_CATALOGPATH_ONDISK

public static final int FIELD_CATALOGPATH_ONDISK

JReport Special Field object types.

See Also:: Constant Field Values

BARCHART

public static final int BARCHART

The chart type value.

See Also:: Constant Field Values

SIDEBYSIDEBARCHART

public static final int SIDEBYSIDEBARCHART

The chart type value.

See Also:: Constant Field Values

STACKEDBARCHART

public static final int STACKEDBARCHART

The chart type value.

See Also:: Constant Field Values

BENCHARRAYCHART

public static final int BENCHARRAYCHART

The chart type value.

See Also:: Constant Field Values

BENCHCHART

public static final int BENCHCHART

The chart type value.

See Also:: Constant Field Values

STACKEDBENCH

public static final int STACKEDBENCH

The chart type value.

See Also:: Constant Field Values

PIECHART

public static final int PIECHART

The chart type value.

See Also:: Constant Field Values

LINECHART

public static final int LINECHART

The chart type value.

See Also:: Constant Field Values

AREACHART

public static final int AREACHART

The chart type value.

See Also:: Constant Field Values

BAR_SIDEBYSIDE_2D

public static final int BAR_SIDEBYSIDE_2D

The chart type value.

See Also:: Constant Field Values

BAR_STACK_2D

public static final int BAR_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_PERCENT_2D

public static final int BAR_PERCENT_2D

The chart type value.

See Also:: Constant Field Values

BAR_SIDEBYSIDE_3D

public static final int BAR_SIDEBYSIDE_3D

The chart type value.

See Also:: Constant Field Values

BAR_STACK_3D

public static final int BAR_STACK_3D

The chart type value.

See Also:: Constant Field Values

BAR_PERCENT_3D

public static final int BAR_PERCENT_3D

The chart type value.

See Also:: Constant Field Values

BAR_ARRAY_3D

public static final int BAR_ARRAY_3D

The chart type value.

See Also:: Constant Field Values

BENCH_SIDEBYSIDE_2D

public static final int BENCH_SIDEBYSIDE_2D

The chart type value.

See Also:: Constant Field Values

BENCH_STACK_2D

public static final int BENCH_STACK_2D

The chart type value.

See Also:: Constant Field Values

BENCH_PERCENT_2D

public static final int BENCH_PERCENT_2D

The chart type value.

See Also:: Constant Field Values

BENCH_SIDEBYSIDE_3D

public static final int BENCH_SIDEBYSIDE_3D

The chart type value.

See Also:: Constant Field Values

BENCH_STACK_3D

public static final int BENCH_STACK_3D

The chart type value.

See Also:: Constant Field Values

BENCH_PERCENT_3D

public static final int BENCH_PERCENT_3D

The chart type value.

See Also:: Constant Field Values

BENCH_ARRAY_3D

public static final int BENCH_ARRAY_3D

The chart type value.

See Also:: Constant Field Values

LINE_ARRAY_2D

public static final int LINE_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

LINE_STACK_2D

public static final int LINE_STACK_2D

The chart type value.

See Also:: Constant Field Values

LINE_PERCENT_2D

public static final int LINE_PERCENT_2D

The chart type value.

See Also:: Constant Field Values

LINE_ARRAY_3D

public static final int LINE_ARRAY_3D

The chart type value.

See Also:: Constant Field Values

AREA_STACK_2D

public static final int AREA_STACK_2D

The chart type value.

See Also:: Constant Field Values

AREA_PERCENT_2D

public static final int AREA_PERCENT_2D

The chart type value.

See Also:: Constant Field Values

AREA_STACK_3D

public static final int AREA_STACK_3D

The chart type value.

See Also:: Constant Field Values

AREA_PERCENT_3D

public static final int AREA_PERCENT_3D

The chart type value.

See Also:: Constant Field Values

PIE_SIDEBYSIDE_2D

public static final int PIE_SIDEBYSIDE_2D

The chart type value.

See Also:: Constant Field Values

PIE_SIDEBYSIDE_3D

public static final int PIE_SIDEBYSIDE_3D

The chart type value.

See Also:: Constant Field Values

BAR_SIDEBYSIDE_LINE_ARRAY_2D

public static final int BAR_SIDEBYSIDE_LINE_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

BAR_STACK_LINE_ARRAY_2D

public static final int BAR_STACK_LINE_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

BAR_PERCENT_LINE_ARRAY_2D

public static final int BAR_PERCENT_LINE_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

LINE_ARRAY_LINE_ARRAY_2D

public static final int LINE_ARRAY_LINE_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

AREA_ARRAY_2D

public static final int AREA_ARRAY_2D

The chart type value.

See Also:: Constant Field Values

AREA_ARRAY_3D

public static final int AREA_ARRAY_3D

The chart type value.

See Also:: Constant Field Values

BAR_SIDEBYSIDE_LINE_STACK_2D

public static final int BAR_SIDEBYSIDE_LINE_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_STACK_LINE_STACK_2D

public static final int BAR_STACK_LINE_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_PERCENT_LINE_STACK_2D

public static final int BAR_PERCENT_LINE_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_SIDEBYSIDE_AREA_STACK_2D

public static final int BAR_SIDEBYSIDE_AREA_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_STACK_AREA_STACK_2D

public static final int BAR_STACK_AREA_STACK_2D

The chart type value.

See Also:: Constant Field Values

BAR_PERCENT_AREA_STACK_2D

public static final int BAR_PERCENT_AREA_STACK_2D

The chart type value.

See Also:: Constant Field Values

STOCK_HIGH_LOW_CLOSE_2D

public static final int STOCK_HIGH_LOW_CLOSE_2D

The chart type value.

See Also:: Constant Field Values

STOCK_OPEN_HIGH_LOW_CLOSE_2D

public static final int STOCK_OPEN_HIGH_LOW_CLOSE_2D

The chart type value.

See Also:: Constant Field Values

RADAR_2D

public static final int RADAR_2D

The chart type value.

See Also:: Constant Field Values

SCATTER_POINTS_2D

public static final int SCATTER_POINTS_2D

The chart type value.

See Also:: Constant Field Values

SCATTER_SMOOTH_LINES_2D

public static final int SCATTER_SMOOTH_LINES_2D

The chart type value.

See Also:: Constant Field Values

SCATTER_STRAIGHT_LINES_2D

public static final int SCATTER_STRAIGHT_LINES_2D

The chart type value.

See Also:: Constant Field Values

BUBBLE_2D

public static final int BUBBLE_2D

The chart type value.

See Also:: Constant Field Values

GAUGE_DIALS_2D

public static final int GAUGE_DIALS_2D

The chart type value.

See Also:: Constant Field Values

GAUGE_BARS_2D

public static final int GAUGE_BARS_2D

The chart type value.

See Also:: Constant Field Values

GAUGE_BALLS_2D

public static final int GAUGE_BALLS_2D

The chart type value.

See Also:: Constant Field Values

SURFACE_3D

public static final int SURFACE_3D

The chart type value.

See Also:: Constant Field Values

STOCK_HIGH_LOW_2D

public static final int STOCK_HIGH_LOW_2D

The chart type value.

See Also:: Constant Field Values

UPC_A

public static final int UPC_A

The Barcode type value.

See Also:: Constant Field Values

UPC_E

public static final int UPC_E

The Barcode type value.

See Also:: Constant Field Values

EAN_13

public static final int EAN_13

The Barcode type value.

See Also:: Constant Field Values

EAN_8

public static final int EAN_8

The Barcode type value.

See Also:: Constant Field Values

CODE_39

public static final int CODE_39

The Barcode type value.

See Also:: Constant Field Values

CODE_128

public static final int CODE_128

The Barcode type value.

See Also:: Constant Field Values

CODABAR

public static final int CODABAR

The Barcode type value.

See Also:: Constant Field Values

LEFTTOP

public static final int LEFTTOP

The alignment type value.

See Also:: Constant Field Values

CENTERTOP

public static final int CENTERTOP

The alignment type value.

See Also:: Constant Field Values

RIGHTTOP

public static final int RIGHTTOP

The alignment type value.

See Also:: Constant Field Values

LEFTCENTER

public static final int LEFTCENTER

The alignment type value.

See Also:: Constant Field Values

CENTERCENTER

public static final int CENTERCENTER

The alignment type value.

See Also:: Constant Field Values

RIGHTCENTER

public static final int RIGHTCENTER

The alignment type value.

See Also:: Constant Field Values

LEFTBOTTOM

public static final int LEFTBOTTOM

The alignment type value.

See Also:: Constant Field Values

CENTERBOTTOM

public static final int CENTERBOTTOM

The alignment type value.

See Also:: Constant Field Values

RIGHTBOTTOM

public static final int RIGHTBOTTOM

The alignment type value.

See Also:: Constant Field Values

JUSTIFYTOP

public static final int JUSTIFYTOP

The alignment type value.

See Also:: Constant Field Values

JUSTIFYCENTER

public static final int JUSTIFYCENTER

The alignment type value.

See Also:: Constant Field Values

JUSTIFYBOTTOM

public static final int JUSTIFYBOTTOM

The alignment type value.

See Also:: Constant Field Values

LEFT_UPSIDE_POINT

public static final int LEFT_UPSIDE_POINT

The resize direction value.

See Also:: Constant Field Values

LEFT_UNDERSIDE_POINT

public static final int LEFT_UNDERSIDE_POINT

The resize direction value.

See Also:: Constant Field Values

RIGHT_UPSIDE_POINT

public static final int RIGHT_UPSIDE_POINT

The resize direction value.

See Also:: Constant Field Values

RIGHT_UNDERSIDE_POINT

public static final int RIGHT_UNDERSIDE_POINT

The resize direction value.

See Also:: Constant Field Values

LEFT

public static final int LEFT

The moving direction value.

See Also:: Constant Field Values

RIGHT

public static final int RIGHT

The moving direction value.

See Also:: Constant Field Values

DIRECTION_FORESIDE

public static final int DIRECTION_FORESIDE

The direction value.

See Also:: Constant Field Values

DIRECTION_BACKSIDE

public static final int DIRECTION_BACKSIDE

The type values.

See Also:: Constant Field Values