i-net /// software API
i-net Clear Reports .NET

Package »com.inet.report«

Interface Summary
BorderProperties Interface for elements that support properties like line style for borders, fore- and back color of the element. This class is part of the RDC.
BoxProperties Interface for elements that displays boxes-like elements with round edges. This class is part of the RDC.
CascadingSource An implementation of this interface can be used as a parent source for a cascading prompt (see CascadingValueProvider). A cascading prompt needs a parent prompt field, but also needs to know the referencing name to use in the SQL query generated to request the default values. Implementations of this interface, e.g. ...
DynamicValueProvider Provides default values for a prompt field at run-time. DynamicValueProvider.getDefaultValues must not return null, but rather at least an empty DefaultValue array.
ElementContainer The interface describes the methods to add some complex elements such as multi-section lines, charts, subreports and crosstabs to the element container. There are the methods for copy, move and paste elements too.
EngineStatistics Holds some statistic data for an instance of Engine
FontProperties Interface for elements that displays text formatted with fonts. This class is part of the RDC.
GeneralProperties Interface for all elements that can be inserted into sections. This class is part of the RDC.
HyperlinkProperties Interface for elements that supports links to external documents. This class is part of the RDC.
LineProperties Interface for elements that draws lines across multiple sections. This class is part of the RDC.
ParagraphProperties Interface for elements that displays lines of text. This class is part of the RDC.
PictureProperties Interface for elements that display pictures. This class is part of the RDC.
PropertiesChecker This is the PropertiesChecker interface. Any client that wants to examine or change HTML page properties or the engine's properties must implement this interface. Since version 6.1, it is possible to create a class (must be called PropertyChecker) which implements this interface and place it in a jar file in the i-net Clear Reports directory. ...
RDC.ElementRemoveListener
RDC.FieldsRefreshListener
RDC.MsgListener
SignatureProperties This class describes the look of visible signature field: which elements will be shown in certificate details, if any, whether the subject name will be written in separate part of the signature, whether the signature field must be divided into two parts. If the signature field is divided into two parts and only one 'standard' element (either certificate details or subject name) is written, then the empty part can be used to allocate some other report elements, e.g. database fields. ...
SimpleElementContainer The interface describes the methods to add some elements such as Text, Box, Line, FieldElement, Picture, JavaBean and DataBasePicture to the container.
SubreportProperties Interface for elements that supports onDemand like subreports. This class is part of the RDC.
TextInterpretationProperties TextInterpretationProperties are implemented by any element which offer text interpretation as HTML or RTF.
TextProperties Interface for all elements with text, i.e. for Text, Subreport, and FieldElement.
Validatable An object that is validatable.
ValueProperties Interface for elements that display numbers, string and other types of values. This class is part of the RDC.
Class Summary
AbstractFontElement The abstract class AbstractFontElement implements FontProperties class and extends Element. Inherit from this class to support Elements that receive Font properties.
AbstractLineElement This class is an abstract implementation of the interface LineProperties.
AbstractPictureElement Parent class of all elements which shows a picture. This class implements PictureProperties interface.
AbstractValueElement This class is an abstract implementation of the interface ValueProperties.
Area The Area element of the Runtime Designer Component. The Area class summarizes the Section element(s) into an Area, which makes it possible to change the behavior of all sections together. All sections in an Area have the same characteristics, but each Section in an Area can have a different format. ...
Box This class represents a box in the report. You can use boxes to enclose other visible elements in the report or to create some graphics. A box can inserted in a single section (use Section.addBox(System.Int32,System.Int32,System.Int32,System.Int32)method in class Section) and can span some sections (use method Section.addBox(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,com.inet.report.Section)in class Section). ...
BySummaryOrder BySummaryOrder saves the options for the sort by aggregate function.
CacheRenderData This class is a RenderData source object running on i-net Clear Reports cache, for use with i-net Clear Reports Viewer. An RenderData object, such as an object of this class, is needed to create a new SwingReportView, for example. It uses the methods provided in Cache to get a cache object (Cache.getCache()), and then passes any data requests on to the cache.
CascadingValueProvider Creates a CascadingValueProvider which provides default values for a prompt based on a value of a parent prompt field. The parent prompt field itself must have a FieldValueProvider so that the possible default values can be filtered with a "WHERE" condition in the query. For example, a PromptField with a FieldValueProvider pointing to a database field representing countries could be set as a parent for a CascadingValueProvider pointing to a database field representing cities. ...
Chart2 This class represents a chart element with new chart API that has been or should be drawn in a report. A chart (or graph) visualize your data with some graphics. To create a new chart use Section.addChart2(com.inet.report.chart.plot.ChartStyle,System.Int32,System.Int32,System.Int32,System.Int32). To change the chart style use Chart2.setPlot(com.inet.report.chart.plot.ChartPlot). ...
CrossTab This class represents a cross table that has been or should be drawn in a report. A cross table is a report to summarize and visualize data in a compact form with rows and columns, so you can better compare data. Use this class to get or set properties. ...
CrossTabBody This is the body of the CrossTab.
CrossTabBodyCell Described a cell in the body of the crosstab.
CrossTabCell Obsolete This class represents container for summarize fields in a cross table. For each value of the fields in rows and columns it will create cells with contents of the fields in this CrossTabCell. To format the fields in the cells use method CrossTabCell.getFieldElement(System.Int32) and change the properties of the returned FieldElement. ...
CrossTabColumn Obsolete A CrossTabColumn holds a field which values are used for the columns of the cross table, i.e. a dayplan would use a CrossTabColumn with a time-field. Each value of the field creates a new column in the cross table. ...
CrossTabDescriptionSection Description section for the Crosstab. It can be used to insert elements into the upper left corner of the crosstab to add some additional information to the crosstab.
CrossTabGridLineFormat Represents the properties of a crosstab grid line. This class is part of the RDC.Serial: exclude
CrossTabHeader A single CrossTab header. There are headers for rows (left) and columns (top).
CrossTabHeaderList This is a container for CrossTabHeader. A crosstab has 2 of this containers. One for rows and one for columns. ...
CrossTabOptions The properties of the Crosstable.
CrossTabRow Obsolete A CrossTabRow holds a field that values are used for the rows of the cross table, i.e. a dayplan would use a CrossTabRow with a weekday-field. Each value of the field creates a new row in the cross table. ...
Database This class is a layer between a DBMS or any other data source and i-net Clear Reports. It compensate the differences between the different DBMS. This class is the default implementation and should work with any SQL99 compatible database. ...
DatabaseField This class represents a database field. A DatabaseField holds the information needed to use a field from a database table. When a field will be evaluated the data of the field are fetched for each record in the table. Therefore the full name of the field in the database table is needed, i.e. "People.Phonenumber". ...
DatabaseMetaDataFactory This class is helpful if you want to use a self defined Database class as base for report design with i-net Designer. The i-net Designer calls some methods from Database class to receive meta data information of the database. To use the own Database class as base for report design these methods have to be overwritten. ...
DatabasePicture It represents a picture that is saved in a BLOB of the database. The picture data must save as gif, jpg, png, bmp, wmf, emf or OLE of this formats. This class is part of the RDC.
DatabaseTables The class DatabaseTables is the starting point if you want to configure everything has to do with databases, tables, connections, table joins and so on. The DatabaseTables contains a list of Datasource objects and a list of Join objects. A Datasource handles the connection to the database and it contains the table, stored procedures and sql commands that are used in the report. ...
Datasource A datasource represents a connection to a database. To create the connection to the database, it needs connection properties like host, user name and password. Using Datasource.setDataSourceConfiguration(com.inet.report.config.datasource.DataSourceConfiguration) or Datasource.setDataSourceConfigurationName(System.String) to configure the datasource by a DataSourceConfiguration. To each Datasource some TableSource objects can be added. ...
DefaultValue Holder for a PromptField's default value and its description. If the default value does not have a description, DefaultValue.getDescription will return null. The default value's "value" may be null. ...
Element The class Element is the superclass of all visible objects in the report. Each of them is inheriting from this class. It holds the properties that all objects have in common, like position, size, color. The elements used in the report are saved in particular sections; you can get them with method Section.getElements in class Section. ...
Engine This is the i-net Clear Reports report engine. Its purpose is to transform a report template and its associated data. The result can either be binary data to be viewed/printed by the Java viewer bean or it can be exported into a lot of export formats, like: HTML, PDF, PS, RTF, XLS, XML, .... You can find a complete list of supported output formats in the documentation (click here to read it online). The engine reads the report file and creates an array of output data that can be used by the client (java viewer or CSV, HTML, PDF, RTF, XLS, XML, PS viewer, ...). ...
EngineError This class provides information about an execution error of an Engine or a sub Engine.
EngineRenderData This implementation of RenderData uses a created Engine to provide all render data to the i-net Clear Reports viewer. When the report viewer requires data, either a new Engine is created if necessary, or an already existing one is used, and then the data requirement is simply passed on to the Engine. One notable unique characteristic of EngineRenderData is that it allows you to set your own PropertiesChecker which is used before rendering to check and handle whichever properties you'd like to create custom behavior for. See the documentation of the PropertiesChecker interface for more information. ...
EngineStatus This class provides status information for an Engine of a main report. This includes errors which occurred during execution of the report. Errors occurred in sub reports will also be included in the list provided by this class. ...
Field Field is the superclass of the different types of fields which can be used in a report. It summarizes the properties shared by all fields. A field is dynamic content in a report, it will be evaluated at runtime and deliver static content (text, picture, ...) for each record to the element that uses the field. ...
FieldElement A FieldElement is an object like a label but the content of it comes dynamically from a field, i.e. a DatabaseField, FormulaField, PromptField etc. With this class you can add a dynamic content into a section of your report. ...
FieldPart This class provides an object commonly known as a FieldElement, i.e. with a DatabaseField or a SummaryField. The difference is the location of the element. ...
Fields The Fields set for the Runtime Designer Component. This class manages all kinds of Fields, DatabaseFields, FormulaFields, PromptFields, etc. You can add, get, count and remove each kind of Fields with this class. ...
FieldValueProvider The FieldValueProvider takes one or two DatabaseFields and at run time provides the values in the fields as default values. The first DatabaseField is used to fetch the values and the second is used to fetch the default values.
FormulaField This class represents a field, which value is calculated by a formula. The formula have to be in Crystal Reports formula syntax or if you set 'basicFmSyntax' to true in basic syntax. To add a FormulaField to the fields set use method Fields.addFormulaField(System.String,System.String,System.Int32) in class Fields. ...
FormulaRange This class is the representation of a range, e.g. defined with a formula like '20 to_ 30'. A range can have one or two limits - a lower and/or a higher limit. ...
Group This class represents a grouping and disposes references to group header- and group footer areas. Note that this class represents groupings only, not the standard page-, report- and detail- area pairs (header and footer areas). If you need to set the properties of a grouping, i.e. ...
GroupField The GroupField represents a group name field, which is automatically created with the creation of a Group object. When evaluating a GroupField the name of the group will returned. So if you have a group then you can print out the name with a FieldElement containing the GroupField. You can get the GroupField of each group with Fields.getGroupNameField(System.Int32) in class Fields. This class is part of the RDC.
JavaBean An instance of this class is an i-net Clear Reports Element that represents a Java Bean which can be rendered to a report. The Java bean must be a lightweight bean extending java.awt.Component. Use Section.addJavaBean to create a JavaBean element. Use the setBeanProperty methods to set a bean property to a Java Object or an i-net Clear Reports ForumulaField. There are two methods for rendering a report. The default method paintToImage paints the view of the Java bean into a background image then draws the image to the report. ...
Join A Join represents a connection between two tables. It is vectored and points from the source table to the target table. There are four kind of Joins: INNER, OUTER, LEFT OUTER and RIGHT OUTER. ...
Line With the Line class you can draw a vertical or horizontal line anywhere in your report. You can draw a line in one section only or a line which spans multiple sections. A line differs from a border line in the report. ...
Listener This class implements the listener that is listening for connections to a certain local port by a client. If the connection is accepted, then a new client socket will be created. The port number for the server socket, on which the listener is to be waiting for new connections, is specified in the i-net Clear Reports configuration. ...
Paragraph The Paragraph class represents a line in a Text and is a set of TextPart elements and FieldPart elements. I.e. a Paragraph that consists of a text formatted with blue color, a field, a text formatted with red color and a text formatted with blue color, has to be split into four parts; three TextPart elements and one FieldPart element. ...
Picture This class represent a static picture. For example you can set a special logo at runtime on all of your reports. To add a picture to your report use method Section.addPicture(System.Int32,System.Int32,System.Int32,System.Int32,java.awt.image.BufferedImage) in class Section and give size, position and the filename of the picture. This class is part of the RDC.
PromptField This class represents a prompt, that is, a field whose value(s) are asked for from the user at runtime. Using prompt fields, it is possible to change the parameterization and looks of a report by using the value(s) given by the user. An example would be to use a prompt field in the record selection formula, in order to only show records with an ID equal to the prompted value. It is possible to have single or multiple discrete values, single or multiple range values, or also multiple discrete and/or range values be passed to a prompt. Range values are considered as all values in between the two limits. Here are two examples of how to use this class: //getting all fields, where engine references your Engine Fields fields = engine.getFields(); //add a prompt of prompt value type NUMBER PromptField pField = fields.addPromptField("PromptName","PromptText", PromptField.NUMBER); --- //get total number of prompts int promptFieldsCount = fields.getPromptFieldsCount(); //for all prompts in fields... ...
QueryValueProvider This implementation of DynamicValueProvider takes a given SQL statement and executes it as a query on the given data source. This is done via Connection.createStatement and Statement.executeQuery(System.String), which means that the SQL query can be any standard SQL statement. SPs also work for most databases, but not for Oracle or PostgreSQL. The ResultSet returned should have the data of the first column be for the value and, if desired, have a second column with data for the description of each default value. ...
RDC This is the main class of the Runtime Designer Component of i-net Clear Reports. Use this class to create a new, empty Engine (report). RDC submits you to create a new report at runtime, to format a report at runtime, bind fields at runtime, set the datasource at runtime, ... . Further on you can use RDC with an existing report file. ...
RDC.FieldsRefreshEvent
Region The Region class is the super class of Area and Section. It describes a logical region in the report.
ReportComponent This is the base class of all report components. Report components are the structure components of a report. There are 2 types of components: the container components like area and section the visible elements like fields
ReportException This is the base class of the i-net Clear Reports exception hierarchy. This exception is thrown whenever an unrecoverable error occurs within i-net Clear Reports.
ReportKeyFactory This class represents the description / identification of a report. It contains the properties that describes how the engine should render this report (i.e. to html or pdf), but also the name and location of the report file. For more information about the report URL parameters, please refer to the i-net Clear Reports documentation. ...
ReportProperties The report properties describe global options for a report or sub report.
ReportServlet This class implements the communication between the client and the engine, that create the requested report. The ReportServlet reads the parameter from the client, sends it to the engine and sends back the requested page of the report to the client. The ReportServlet creates a report through the following steps: 1. ...
Section The Section class represents the sections of a report. Each report consists of several sections which are associated with Areas of type: Report Header, Page Header, Group Header, Detail, Group Footer, Report Footer and Page Footer.Here you can add elements to your report, like lines, boxes, text fields, pictures and of course fields with dynamic content, called FieldElement. To do this you can use the various add methods of this class. The height and the width of a section is generated dynamically. Always when you are adding an element the section height and width would be checked. ...
SignatureForm This class describes the visible Signature in PDF documents, that will be shown in Adobe Reader. The visible signature can consist of one, two or none of the standard elements (certificate details and subject name). With two standard elements the signature field will be divided into two parts (left and right). ...
SortField With this field you can only set the sorting of the report data. This field can not be displayed with a FieldElement. This class is part of the RDC.
SpecialField The SpecialField was created for contents that's source is in the environment of the running engine or of the engine itself. That can be the date or time when the report was printed, or the current page number, the name of the author of the report, etc. This class is part of the RDC.
SpecifiedOrder This class saved the details of the specified sort order of groups. *
SQLField This class represents a field for sql-statements. This class is part of the RDC.
SQLValueProvider This implementation of DynamicValueProvider takes a given SQL statement and executes it as a query on the given data source. This is done via Connection.createStatement and Statement.executeQuery(System.String), which means that the SQL query can be any standard SQL statement. SPs also work for most databases, but not for Oracle or PostgreSQL. The ResultSet returned should have one column for the value and, if desired, one for the description of each default value.
Subreport Engines cannot hold more than one datasource, so if you need a report that uses data from two or more datasources, you have to use Subreport objects in the report. Example: You have one database to store private data of your employees. In another database (a table in the same database should also work, but no subreports are required here) you store the sales of each of your shops. ...
SubreportLink A SubreportLink object links a field in main report with a field in subreport with use of a prompt field in the subreport. The values of the field in main report will used as prompt values in the subreport. These prompt values will be used in the record selection formula to compare with the values of the field in the subreport. ...
SummaryField A summary field summarizes data of other fields in the report. You can print out the summary with a FieldElement or a FieldPart. To create a new SummaryField use the method Fields.addSummaryField(com.inet.report.Field,System.Int32,System.String) in class Fields and give the field which data should summarized and the kind of the summary using the constants. This class is part of the RDC.
SummaryInfo With this class SummaryInfo you can get/set the report summary info specified in the "Summary Info" of the Reports Designer or with the setXXX methods in this class. For example: Engine eng = new Engine(); eng.setReportFile( "file:C:/MyReports/Report1.rpt" ); SummaryInfo su = eng.getSummaryInfo(); System.out.println("created: "+su.getCreated()); System.out.println("LastSaved: "+su.getLastSaved()); System.out.println("Author: "+su.getAuthor()); System.out.println("Subject: "+su.getSubject()); System.out.println("ReportTitle: "+su.getReportTitle());
TableSource A TableSource is the represantation of a table, a view, a stored procedure or a SQL command. The table desciption contains of the table name, the alias and the column description. Every datasource will be represented as a single table in the report design. ...
Text This class provides an object that represents a label. It consists of paragraph elements and will be used like a frame for the containing paragraphs. Note that it is not possible to insert a text or a field directly. ...
TextPart The text objects in a report are separated into parts of text, where each part has its own format, i.e. color & size. This elements are called text parts and are represented by this class. ...
Trigger A trigger is a runtime value that will be evaluated at runtime and can be accessed after a report has rendered. The state of the trigger will not be saved with the rpt file. Sample usage: Fields fields = eng.getFields(); FormulaField formula = fields.addFormulaField( "trigger", "23 = 24", FormulaField.FORMULA_PROPERTY ); Trigger trigger = eng.getTrigger(); trigger.setFormula( formula ); eng.execute(); //render the report eng.getPageCount(); //wait until finish Boolean value = trigger.getValue(); //request the trigger value
Validity This class hold the state of an checked object.
Validity.States States of an object