Klasse Section
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Region
com.inet.report.Section
- Alle implementierten Schnittstellen:
ElementContainer, NodeParser, com.inet.report.ReferenceHolder, SimpleElementContainer, Serializable
The
Each report consists of several sections which are associated with
Here you can add elements to your report, like lines, boxes, text fields, pictures and of course fields with dynamic content, called
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. Use the
All elements in a section are bundled in a
This class is part of 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. Use the
ReportComponent.setHeight(int) and ReportComponent.setWidth(int) methods for changing it
manually.All elements in a section are bundled in a
Vector, that you
can access with getElementsV().
The index of each element is the position in this Vector
object.
You need the index if you want to remove an element (with remove(Element)).
This class is part of the
RDC.- Siehe auch:
-
Feldübersicht
FelderModifikator und TypFeldBeschreibungstatic final intDefault value of the property 'height'.Von Klasse geerbte Felder Region
DETAIL, GROUP_FOOTER, GROUP_HEADER, PAGE_FOOTER, PAGE_HEADER, REPORT_FOOTER, REPORT_HEADER -
Methodenübersicht
Modifikator und TypMethodeBeschreibungaddBox(int xpos, int ypos, int objwidth, int objheight) Adds a newBoxto thisSectionand returns it.Adds a newBoxto thisSectionand returns it.addChart2(ChartStyle style, int xpos, int ypos, int objwidth, int objheight) Adds a new chart element to the container and returns it.addCrossTab(int xpos, int ypos, SummaryField field) Adds the simplest possible cross table (at least on field for summarization) into thisSectionand returns it.addDatabasePicture(Field field, int xpos, int ypos, int objwidth, int objheight) Adds a newDatabasePicture(e.g.@Nonnull FieldElementaddFieldElement(Field field, int xpos, int ypos, int objwidth, int objheight) com.inet.report.FormFieldElementaddFormField(int xpos, int ypos, int objwidth, int objheight) Adds a new form field element to the container.addHorizontalLine(int xpos, int ypos, int objwidth) Adds a new horizontal line to the container and returns it.com.inet.report.InteractiveSortingaddInteractiveSorting(Field field, int xpos, int ypos, int objwidth, int objheight) Adds a new InteractiveSorting element to the container.addJavaBean(String className, int xpos, int ypos, int objwidth, int objheight) Add a new JavaBean to the container.@Nonnull PictureaddPicture(int xpos, int ypos, int objwidth, int objheight, byte[] buffer) Adds a new picture element to the container and returns it.@Nonnull PictureaddPicture(int xpos, int ypos, int objwidth, int objheight, int[] buffer) Adds a new picture element to the container and returns it.@Nonnull PictureaddPicture(int xpos, int ypos, int objwidth, int objheight, BufferedImage im) Adds a new picture element to the container and returns it.@Nonnull PictureaddPicture(int xpos, int ypos, int objwidth, int objheight, File file) Adds a new picture element to the container and returns it.@Nonnull PictureaddPicture(int xpos, int ypos, int objwidth, int objheight, String fileName) Adds a new picture element to the container and returns it.addSignatureForm(int xpos, int ypos, int objwidth, int objheight) Adds a newSignatureFormelement to thisSection.addSubreport(int xpos, int ypos, int objwidth, int objheight) Adds a new subreport element to the container and returns it.addSubreport(int xpos, int ypos, int objwidth, int objheight, String filename) Adds a new subreport element with definition from file to the container and returns it.addText(int xpos, int ypos, int objwidth, int objheight) Adds a new text element to the container.addVerticalLine(int xpos, int ypos, int objheight) Adds a new vertical line to the container and returns it.addVerticalLine(int xpos, int ypos, int y2, Section endSection) Adds a new vertical line to the container and returns it.intAllElementsthat are notFieldElementswill be removed from thisSection.voidcopyContent(Section source) Copies content and properties of the source section into target section.voidcopyContent(SimpleElementContainer source) Copies content and properties of the source container into this container.voidcopyProperties(Section source) Some properties of the source section will be copied to this section.Element[]Returns anArraycontaining all elements in this section.Returns aVectorcontaining all elements in this section.getName()Returns the name of the section - i.e.Returns the parentAreaof theSection.Returns a list with all property formulas that are set for this report element.getReportElement(int idx) Returns a report element.intCounts the number of Report Elements in this section and returns it.getSectionNameByNumber(int number) Generates a name ending usually used for section names.Returns allReportComponents that are descendants of this one.booleanReturns the value of the property 'suppress if blank'.Returns the formula for the property 'suppress if blank'.booleanReturns the value of the property 'underlay follow'.Returns the formula for the property 'underlay follow'.booleanReturns the value of the property 'useColor'.intgetWidth()Returns the width of the section.intindexOf()Returns the current index of thisSectionin thisArea.voidmoveElement(Element elem, Section dest) Moves theElement elemfrom thisSectionto the destinationSection dest.voidmoveElement(Element elem, SimpleElementContainer dest) Moves the elementelemfrom this container to the destination containerdest.Returns a string identifying this report component.parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidparseEndElement(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLpasteElement(Object copy) Paste a copy of anElementto thisSection.voidRemoves the given report element from the container.voidFOR INTERNAL USE ONLYvoidFOR INTERNAL USE ONLYvoidsetSuppressIfBlank(boolean newValue) Sets the value of the property 'suppress if blank'.voidsetSuppressIfBlankFormula(FormulaField newFormula) Sets the formula for the property 'suppress if blank'.voidsetUnderlayFollow(boolean newValue) Sets the value of the property 'underlay follow'.voidsetUnderlayFollowFormula(FormulaField newFormula) Sets the formula for the property 'underlay follow'.voidsetUseColor(boolean newValue) Sets the value of the property 'useColor'.sortAndFilterSectionElements(int accuracy, boolean write_sub, boolean makeFilteredList) FOR INTERNAL USE ONLY Method for XLS-Export: Labels, Fields, CrossTab, Line, Box and Subreport will be sorted Elements are filtered and sorted by their positions (up-down, then left-right) XLS-Export: makeFilteredList=true, because Z-order of elements must be kept Elements with negative x-coordinate will be not proceeded because of problem with IntObjectMapVon Klasse geerbte Methoden Region
getAtBottomOfPageFormula, getNewPageAfterFormula, getNewPageBeforeFormula, getResetPageNumberFormula, getSuppressOnDrillDownFormula, getType, getTypeAsString, isAtBottomOfPage, isHeader, isNewPageAfter, isNewPageBefore, isResetPageNumber, isSuppressOnDrillDown, setAtBottomOfPage, setAtBottomOfPageFormula, setNewPageAfter, setNewPageAfterFormula, setNewPageBefore, setNewPageBeforeFormula, setResetPageNumber, setResetPageNumberFormula, setSuppressOnDrillDown, setSuppressOnDrillDownFormulaVon Klasse geerbte Methoden ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getStructElem, getSuppressFormula, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setStructElem, setSuppress, setSuppressFormula, setWidth, setX, setY
-
Felddetails
-
DEFAULT_HEIGHT
public static final int DEFAULT_HEIGHTDefault value of the property 'height'.- Siehe auch:
-
-
Methodendetails
-
getParent
Returns the parentAreaof theSection.- Gibt zurück:
- The parent
Area. - Löst aus:
IllegalStateException- if the type of the section is invalid.- Seit:
- 6.0
-
paramString
Returns a string identifying this report component. This method is useful for logging and for debugging.- Setzt außer Kraft:
paramStringin KlasseReportComponent- Gibt zurück:
- a string identifying the ReportComponent
-
pasteElement
Paste a copy of anElementto thisSection. The parameter is not an instance ofElement. If theElementneeds references to aFieldor aGroupthen these objects must exist in thisEngine. In the other cases aReportExceptionwill be thrown. The coordinates on that theElementwill be paste in theSectionare the coordinates of the copied element.- Angegeben von:
pasteElementin SchnittstelleElementContainer- Parameter:
copy- An object created with the methodElement.copy().- Gibt zurück:
- The inserted
Element. - Löst aus:
ReportException- If theElementcannot be created because of missing references.- Seit:
- 6.0
- Siehe auch:
-
moveElement
Moves theElement elemfrom thisSectionto the destinationSection dest.- Parameter:
elem- TheElement, which should move to anotherSection.dest- The destinationSectionof movement.- Löst aus:
ReportException- will thrown ifdestorelemisnull.- Seit:
- 6.0
- Siehe auch:
-
getElementsV
Returns aVectorcontaining all elements in this section. Each element in the returned Vector is an instance of classElementor an instance of Elements subclasses.- Angegeben von:
getElementsVin SchnittstelleSimpleElementContainer- Gibt zurück:
- A
Vectorcontaining all elements in this section. - Seit:
- 6.0
- Siehe auch:
-
getElements
Returns anArraycontaining all elements in this section. Each field of theArraycontains an instance of classElementor an instance of Elements subclasses.- Angegeben von:
getElementsin SchnittstelleSimpleElementContainer- Gibt zurück:
- An
Arraycontaining all elements in thisSection. - Seit:
- 6.0
- Siehe auch:
-
addFieldElement
public @Nonnull FieldElement addFieldElement(Field field, int xpos, int ypos, int objwidth, int objheight) throws ReportException Adds a newFieldElement(a dynamic text element based on aField) to thisSectionand returns it. Note that for binary fields you need to use the methodaddDatabasePicture(Field, int, int, int, int), since picture fields are notFieldElements.- Angegeben von:
addFieldElementin SchnittstelleSimpleElementContainer- Parameter:
field- The field that should added intoSection. May not be null.xpos- The x-coordinate of the upper left corner in twips.ypos- The y-coordinate of the upper left corner in twips.objwidth- The width of the newFieldElementin twips.objheight- The height of the newFieldElementin twips.- Gibt zurück:
- The created
FieldElementornullif the creation was not successfull. - Löst aus:
ReportException- if the value type of the field is binary - useaddDatabasePicture(Field, int, int, int, int)instead.IllegalArgumentException- if the parameters x, y, width or height are negative or the field is null- Seit:
- 6.0
- Siehe auch:
-
addDatabasePicture
public DatabasePicture addDatabasePicture(Field field, int xpos, int ypos, int objwidth, int objheight) Adds a newDatabasePicture(e.g. Blob) to thisSectionand returns it.- Angegeben von:
addDatabasePicturein SchnittstelleSimpleElementContainer- Parameter:
field- Field which valuetype is Field.BINARY and that should be added to the section. This can be a database field, a formula field, a prompt field or a SQL field.xpos- x-coordinate of the upper left corner in twips.ypos- y-coordinate of the upper left corner in twips.objwidth- Width of the new fieldElement in twips.objheight- Height of the new fieldElement in twips.- Gibt zurück:
- new created DatabasePicture
- Seit:
- 6.0
-
addBox
Adds a newBoxto thisSectionand returns it.- Angegeben von:
addBoxin SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset in twips.ypos- The vertical offset in twips.objwidth- The width of the box in twips.objheight- The height of the box in twips.- Gibt zurück:
- The created
Boxelement ornullif the creation was not successfull - Löst aus:
IllegalArgumentException- If the parameter width or height are negative.- Seit:
- 6.0
-
addBox
Adds a newBoxto thisSectionand returns it.- Angegeben von:
addBoxin SchnittstelleElementContainer- Parameter:
xpos- The horizontal offset in twips.ypos- The vertical offset in twips.objwidth- The width of the box in twips.objheight- The minimal height of the box in start section in twips.y2- The vertical offset of the end point in end sectionendSection- The section where the box ends- Gibt zurück:
- The created box element
- Seit:
- 6.0
-
addCrossTab
Adds the simplest possible cross table (at least on field for summarization) into thisSectionand returns it. To make this cross table more complex use the add and append methods in classcom.inet.report.CrossTab.- Angegeben von:
addCrossTabin SchnittstelleElementContainer- Parameter:
xpos- The x position of the upper left corner of the whole cross table in twips..ypos- The y position of the upper left corner of the whole cross table in twips..field- The field to summarize in cross table.- Gibt zurück:
- The created Crosstab.
- Löst aus:
IllegalArgumentException- if the parameters x or y are negative- Seit:
- 6.0
- Siehe auch:
-
addChart2
Adds a new chart element to the container and returns it. The chart type is defined by the parameter style. You can use e.g.BarStyle.BAR2Dfor a simple bar chart 2D. To see which chart types are allowed see the subclasses ofChartStyle. Initializes all properties with default values.- Angegeben von:
addChart2in SchnittstelleElementContainer- Parameter:
style- the style of chart.xpos- the x offset of the upper left corner in twips.ypos- the y offset of the upper left corner in twips.objwidth- the total width of the chart element in twips.objheight- the total height of the chart element in twips.- Gibt zurück:
- the new Chart2.
- Siehe auch:
-
addHorizontalLine
Adds a new horizontal line to the container and returns it.- Angegeben von:
addHorizontalLinein SchnittstelleSimpleElementContainer- Parameter:
xpos- the horizontal offset of the start point in twips.ypos- the vertical offset of the start point in twips.objwidth- the width of the line in twips.- Gibt zurück:
- the created line element
-
addJavaBean
public JavaBean addJavaBean(String className, int xpos, int ypos, int objwidth, int objheight) throws ReportException Add a new JavaBean to the container. The class of the Java Bean need to be extends form java.awt.Component.- Angegeben von:
addJavaBeanin SchnittstelleSimpleElementContainer- Parameter:
className- The class name of the Java Bean.xpos- The x-coordinate of the upper left corner in twips.ypos- The y-coordinate of the upper left corner in twips.objwidth- The width of the new fieldElement in twips.objheight- The height of the new fieldElement in twips.- Gibt zurück:
- The created JavaBean.
- Löst aus:
ReportException- if the Java Bean cannot created.
-
addVerticalLine
Adds a new vertical line to the container and returns it.- Angegeben von:
addVerticalLinein SchnittstelleSimpleElementContainer- Parameter:
xpos- the horizontal offset of the start point in twips.ypos- the vertical offset of the start point in twips.objheight- the height of the line in twips.- Gibt zurück:
- the created line element
-
addVerticalLine
Adds a new vertical line to the container and returns it.- Angegeben von:
addVerticalLinein SchnittstelleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.y2- The vertical offset of the end point in end section in twips.endSection- The section where the line should end.- Gibt zurück:
- The created line element.
-
addPicture
public @Nonnull Picture addPicture(int xpos, int ypos, int objwidth, int objheight, String fileName) throws ReportException Adds a new picture element to the container and returns it. If the width or height is -1 then the width and height from the loaded image will be used. Valid formats are GIF, JPG, PNG, BMP, WMF or EMF. Also PDF and HTML files can be added as image if the decoder is installed in the lib directory of i-net Clear Reports.- Angegeben von:
addPicturein SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.objwidth- The width of the picture in twipsobjheight- The height of the picture in twips.fileName- The absolute or relative to working directory path to the image.- Gibt zurück:
- Picture The created report element.
- Löst aus:
ReportException- will thrown iffileis an unknown picture format.- Siehe auch:
-
addPicture
public @Nonnull Picture addPicture(int xpos, int ypos, int objwidth, int objheight, File file) throws ReportException Adds a new picture element to the container and returns it. If the width or height is -1 then the width and height from the loaded image will be used. Valid formats are GIF, JPG, PNG, BMP, WMF or EMF. Also PDF and HTML files can be added as image if the decoder is installed in the lib directory of i-net Clear Reports.- Angegeben von:
addPicturein SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.objwidth- The width of the picture in twips.objheight- The height of the picture in twips.file- The file object to the image.- Gibt zurück:
- Picture The created report element.
- Löst aus:
ReportException- will thrown iffileis an unknown picture format.- Siehe auch:
-
addPicture
public @Nonnull Picture addPicture(int xpos, int ypos, int objwidth, int objheight, int[] buffer) throws ReportException Adds a new picture element to the container and returns it. If the width or height is -1 then the width and height from the loaded image will be used. Valid formats are GIF, JPG, PNG, BMP, WMF or EMF. Also PDF and HTML files can be added as image if the decoder is installed in the lib directory of i-net Clear Reports.- Angegeben von:
addPicturein SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.objwidth- The width of the picture in twips.objheight- The height of the picture in twips.buffer- A int[] with image header and data.- Gibt zurück:
- Picture The created report element.
- Löst aus:
ReportException- ReportException will thrown ifbufferis an unknown picture format.- Siehe auch:
-
addPicture
public @Nonnull Picture addPicture(int xpos, int ypos, int objwidth, int objheight, byte[] buffer) throws ReportException Adds a new picture element to the container and returns it. If the width or height is -1 then the width and height from the loaded image will be used. Valid formats are GIF, JPG, PNG, BMP, WMF or EMF. Also PDF and HTML files can be added as image if the decoder is installed in the lib directory of i-net Clear Reports.- Angegeben von:
addPicturein SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.objwidth- The width of the picture in twips.objheight- The height of the picture in twips.buffer- A byte[] with image header and data.- Gibt zurück:
- Picture The created report element.
- Löst aus:
ReportException- ReportException will thrown ifbufferis an unknown picture format.ReportException- ifbufferis an unknown picture format.- Siehe auch:
-
addPicture
public @Nonnull Picture addPicture(int xpos, int ypos, int objwidth, int objheight, BufferedImage im) throws ReportException Adds a new picture element to the container and returns it. If the width or height is -1 then the width and height from the loaded image will be used. Valid formats are GIF, JPG, PNG, BMP, WMF or EMF. Also PDF and HTML files can be added as image if the decoder is installed in the lib directory of i-net Clear Reports. If the width or height -1 then the width and height from the loaded image is used. The TYPE_INT_ARGB color model is supported only.- Angegeben von:
addPicturein SchnittstelleSimpleElementContainer- Parameter:
xpos- The horizontal offset of the start point in twips.ypos- The vertical offset of the start point in twips.objwidth- The width of the picture in twips.objheight- The height of the picture in twips.im- The image object.- Gibt zurück:
- Picture The created report element.
- Löst aus:
ReportException- ReportException will thrown ifimis an unknown picture format.- Siehe auch:
-
copyContent
Copies content and properties of the source section into target section.- Parameter:
source- The sections thats content and properties should copied.- Seit:
- 6.0
-
addSubreport
public Subreport addSubreport(int xpos, int ypos, int objwidth, int objheight, String filename) throws ReportException, MalformedURLException, FileNotFoundException Adds a new subreport element with definition from file to the container and returns it.- Angegeben von:
addSubreportin SchnittstelleElementContainer- Parameter:
xpos- The x offset of the left upper corner of subreport frame.ypos- The y offset of the left upper corner of subreport frame.objwidth- The width of the subreport frame.objheight- The height of the subreport frame.filename- The file name of the subreport to insert.- Gibt zurück:
- The created subreport element. You can get the engine of the subreport with method getEngine in class Subreport.
- Löst aus:
ReportException- if Engine is not initialized or finished.MalformedURLException- Thrown to indicate that a malformed URL has occurred.FileNotFoundException- If no file for the subreport were found.
-
addSubreport
Adds a new subreport element to the container and returns it. Add-on is only possible if this report is a main report.- Angegeben von:
addSubreportin SchnittstelleElementContainer- Parameter:
xpos- The x offset of the left upper corner of subreport frame.ypos- The y offset of the left upper corner of subreport frame.objwidth- The width of the subreport frame.objheight- The height of the subreport frame.- Gibt zurück:
- The created subreport element. You can get the engine of the subreport with method getEngine in class Subreport.
-
addText
Adds a new text element to the container. To fill a new line into this text element useaddParagraphmethod. The returned text element is empty, that means it contains no paragraph object.- Angegeben von:
addTextin SchnittstelleSimpleElementContainer- Parameter:
xpos- the x offset of the text elementypos- the y offset of the text elementobjwidth- the width of the text elementobjheight- the height of the text element- Gibt zurück:
- the created text element.
-
addFormField
public com.inet.report.FormFieldElement addFormField(int xpos, int ypos, int objwidth, int objheight) Adds a new form field element to the container.- Angegeben von:
addFormFieldin SchnittstelleElementContainer- Parameter:
xpos- The x offset of the left upper corner of the form field.ypos- The y offset of the left upper corner of the form field.objwidth- The width of the form field.objheight- The height of the form field.- Gibt zurück:
- the created form field element.
-
addInteractiveSorting
public com.inet.report.InteractiveSorting addInteractiveSorting(Field field, int xpos, int ypos, int objwidth, int objheight) Adds a new InteractiveSorting element to the container.- Angegeben von:
addInteractiveSortingin SchnittstelleElementContainer- Parameter:
field- the a group field or a sorting field which sorting should be interactive.xpos- The x offset of the left upper corner of the form field.ypos- The y offset of the left upper corner of the form field.objwidth- The width of the form field.objheight- The height of the form field.- Gibt zurück:
- the created form field element.
-
remove
Removes the given report element from the container.- Angegeben von:
removein SchnittstelleSimpleElementContainer- Parameter:
elem- The Report Element which should be removed from the container (nullis not permitted).
-
getSectionNameByNumber
Generates a name ending usually used for section names.- Parameter:
number- - A number greater than 0; usually the index of the section in the sections set.- Gibt zurück:
- String - "a" for 0, "z" for 25, "ab" for 27
- Löst aus:
ReportException- if number is lesser than 0- Seit:
- 6.0
-
getName
Returns the name of the section - i.e. "Db" for the second detail section.- Gibt zurück:
- The Name of the section
- Löst aus:
ReportException- will thrown if Section was not found.- Seit:
- 6.0
-
setSuppressIfBlank
public void setSuppressIfBlank(boolean newValue) Sets the value of the property 'suppress if blank'. If this property is enabled the section will not printed if it is blank.- Parameter:
newValue- The new value of the property 'suppress if blank'.- Seit:
- 6.0
-
getSuppressIfBlank
public boolean getSuppressIfBlank()Returns the value of the property 'suppress if blank'. If this property is enabled the section will not printed if it is blank.- Gibt zurück:
- The value of the property 'suppress if blank'.
- Seit:
- 6.0
-
setSuppressIfBlankFormula
Sets the formula for the property 'suppress if blank'. If this property is enabled the section will not printed if it is blank.- Parameter:
newFormula- The new formula for the property 'suppress if blank'.- Seit:
- 6.0
-
getSuppressIfBlankFormula
Returns the formula for the property 'suppress if blank'. If this property is enabled the section will not printed if it is blank.- Gibt zurück:
- The formula for the property 'suppress if blank'.
- Seit:
- 6.0
-
setUnderlayFollow
public void setUnderlayFollow(boolean newValue) Sets the value of the property 'underlay follow'. If this property is enabled the section will underlay the following section(s).- Parameter:
newValue- The new value of the property 'underlay follow'.- Seit:
- 6.0
-
getUnderlayFollow
public boolean getUnderlayFollow()Returns the value of the property 'underlay follow'. If this property is enabled the section will underlay the following section(s).- Gibt zurück:
- The value of the property 'underlay follow'.
- Seit:
- 6.0
-
setUnderlayFollowFormula
Sets the formula for the property 'underlay follow'. If this property is enabled the section will underlay the following section(s).- Parameter:
newFormula- The new formula for the property 'underlay follow'.- Seit:
- 6.0
-
getUnderlayFollowFormula
Returns the formula for the property 'underlay follow'. If this property is enabled the section will underlay the following section(s).- Gibt zurück:
- The formula for the property 'underlay follow'.
- Seit:
- 6.0
-
getReportElementsCount
public int getReportElementsCount()Counts the number of Report Elements in this section and returns it.- Angegeben von:
getReportElementsCountin SchnittstelleSimpleElementContainer- Gibt zurück:
- The number of report elements in this section.
- Seit:
- 6.0
-
getReportElement
Returns a report element. You can specify the returned element with the idx parameter.- Angegeben von:
getReportElementin SchnittstelleSimpleElementContainer- Parameter:
idx- The 0-based index of the element, which should be returned.- Gibt zurück:
- The returned Element can be a FieldElement, a Text, a Line, a Box, a Picture, a DatabasePicture, a OldChart, Subreport or a CrossTab.
- Seit:
- 6.0
- Siehe auch:
-
sortAndFilterSectionElements
public List<Element> sortAndFilterSectionElements(int accuracy, boolean write_sub, boolean makeFilteredList) FOR INTERNAL USE ONLY Method for XLS-Export: Labels, Fields, CrossTab, Line, Box and Subreport will be sorted Elements are filtered and sorted by their positions (up-down, then left-right) XLS-Export: makeFilteredList=true, because Z-order of elements must be kept Elements with negative x-coordinate will be not proceeded because of problem with IntObjectMap- Parameter:
accuracy- accuracy for horizontal positioningwrite_sub- if true subreports will be rendered.makeFilteredList- if true the list without not renderable elements will be produced.- Gibt zurück:
- filtered list (elements in original order without suppressed elements)
-
indexOf
public int indexOf()Returns the current index of thisSectionin thisArea.- Angegeben von:
indexOfin KlasseReportComponent- Gibt zurück:
- The current index of this section in this area.
- Löst aus:
IllegalStateException- Thrown if this section was not found in the parent area.- Seit:
- 6.0
-
setReferences
public void setReferences()FOR INTERNAL USE ONLY- Angegeben von:
setReferencesin Schnittstellecom.inet.report.ReferenceHolder- Setzt außer Kraft:
setReferencesin KlasseReportComponent
-
resetReferences
public void resetReferences()FOR INTERNAL USE ONLY- Angegeben von:
resetReferencesin Schnittstellecom.inet.report.ReferenceHolder- Setzt außer Kraft:
resetReferencesin KlasseReportComponent- Seit:
- 6.0
-
getPropertyFormulas
Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendantReportComponentof this one. To get the property formulas for descendantReportComponentuseReportComponent.getSubComponents()- Setzt außer Kraft:
getPropertyFormulasin KlasseRegion- Gibt zurück:
- List of property formulas
- Seit:
- 6.0
-
setUseColor
public void setUseColor(boolean newValue) Sets the value of the property 'useColor'. When this property is enabled the color defined in 'background color' is used.- Parameter:
newValue- The new value of the property 'useColor'.- Seit:
- 6.1
-
getUseColor
public boolean getUseColor()Returns the value of the property 'useColor'. When this property is enabled the color defined in 'background color' is used.- Gibt zurück:
- The current value of the property 'useColor'.
- Seit:
- 6.1
-
getWidth
public int getWidth()Returns the width of the section. As the width of a section can not vary it will returnEngine.getReportProperties().getPaperWidth()-Engine.getReportProperties().getMarginLeft()-Engine.getReportProperties().getMarginRight()for all main reports.
Only if this section belongs to a sub report the section width will not be the width of the page because it is limited to the width of the sub report.- Setzt außer Kraft:
getWidthin KlasseReportComponent- Gibt zurück:
- The width of this section.
- Seit:
- 7.0
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.
- Angegeben von:
parseElementin SchnittstelleNodeParser- Setzt außer Kraft:
parseElementin KlasseRegion- Parameter:
group- XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.tag- The XMLTag to be parsedatts- The set of attributes in the current XMLTagparserMap- The map of current Parser.- Gibt zurück:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Löst aus:
FatalParserException- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseEndElement
public void parseEndElement(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLReceive notification of the end of an XML tag.
- Angegeben von:
parseEndElementin SchnittstelleNodeParser- Setzt außer Kraft:
parseEndElementin KlasseReportComponent- Parameter:
group- XMLTag of the current node to be parsed, or null if there is no such current group.tag- The XMLTag to be parsedparserMap- The map of current Parser.- Löst aus:
FatalParserException- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseText
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLThis method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)
- Angegeben von:
parseTextin SchnittstelleNodeParser- Setzt außer Kraft:
parseTextin KlasseReportComponent- Parameter:
text- text encountered and to be storedparserMap- The map of current Parser.
-
addSignatureForm
Adds a newSignatureFormelement to thisSection. This signature element is useful for PDF export, only.- Angegeben von:
addSignatureFormin SchnittstelleElementContainer- Parameter:
xpos- the x position of the signature form element.ypos- the y position of the signature form element.objwidth- the width of the signature form element.objheight- the height of the signature form element.- Gibt zurück:
- the created signature form element.
- Löst aus:
IllegalArgumentException- if the parameters x, y, width or height are negative- Seit:
- 9.1
-
copyProperties
Some properties of the source section will be copied to this section.- Parameter:
source- section to be copied.- Seit:
- 9.1
-
copyContent
Copies content and properties of the source container into this container.- Angegeben von:
copyContentin SchnittstelleElementContainer- Parameter:
source- The container thats content and properties should copied.
-
moveElement
Moves the elementelemfrom this container to the destination containerdest.- Angegeben von:
moveElementin SchnittstelleElementContainer- Parameter:
elem- The element, which should move to another container.dest- The destination container of movement.- Löst aus:
ReportException- will thrown ifdestorelemisnull.- Siehe auch:
-
cleanForDataExport
public int cleanForDataExport()AllElementsthat are notFieldElementswill be removed from thisSection. All suppressed elements apart fromFormulaFieldswill be removed too. All remaining elements will be sorted on their x position.- Gibt zurück:
- number of remaining elements in the section.
- Seit:
- 9.2
-
getSubComponents
Returns allReportComponents that are descendants of this one. E.G. this will return all Element of aSection. But it's as well useful forCrossTabs orTextelements which have additional elements.- Angegeben von:
getSubComponentsin KlasseReportComponent- Gibt zurück:
- a list with all sub components which can be empty as well; will be
nullif the component has no descendants
-