Klasse CrossTabDescriptionSection

java.lang.Object

com.inet.report.ReportComponent

com.inet.report.CrossTabDescriptionSection

Alle implementierten Schnittstellen:

NodeParser, com.inet.report.ReferenceHolder, SimpleElementContainer, Serializable

public class CrossTabDescriptionSection
extends ReportComponent
implements SimpleElementContainer

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.

Seit:

6.0

Siehe auch:

• Serialisierte Form

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
Box	addBox(int boxX, int boxY, int boxWidth, int boxHeight)	Adds a new box to the container and returns it.
DatabasePicture	addDatabasePicture(Field field, int pictureX, int pictureY, int pictureWidth, int pictureHeight)	Adds a new DatabasePicture to the container and returns it.
FieldElement	addFieldElement(Field field, int fieldX, int fieldY, int fieldWidth, int fieldHeight)	Adds a new FieldElement (a dynamic text element based on a Field) to this container and returns it.
Line	addHorizontalLine(int xpos, int ypos, int lineLength)	Adds a new horizontal line to the container and returns it.
JavaBean	addJavaBean(String className, int beanX, int beanY, int beanWidth, int beanHeight)	Add a new JavaBean to the container.
@Nonnull Picture	addPicture(int pictureX, int pictureY, int pictureWidth, int pictureHeight, byte[] buffer)	Adds a new picture element to the container and returns it.
Picture	addPicture(int pictureX, int pictureY, int pictureWidth, int pictureHeight, int[] buffer)	Adds a new picture element to the container and returns it.
Picture	addPicture(int pictureX, int pictureY, int pictureWidth, int pictureHeight, BufferedImage im)	Adds a new picture element to the container and returns it.
Picture	addPicture(int pictureX, int pictureY, int pictureWidth, int pictureHeight, File file)	Adds a new picture element to the container and returns it.
Picture	addPicture(int pictureX, int pictureY, int pictureWidth, int pictureHeight, String fileName)	Adds a new picture element to the container and returns it.
Text	addText(int textX, int textY, int textWidth, int textHeight)	Adds a new text element to the container.
Line	addVerticalLine(int xpos, int ypos, int lineLength)	Adds a new vertical line to the container and returns it.
boolean	contains(Element el)	Tests if the specified element is a component in this section.
Element[]	getElements()	Returns an array containing all elements of this container.
Vector<Element>	getElementsV()	Returns a Vector containing all elements in this container.
Element	getReportElement(int idx)	Get a report Element.
int	getReportElementsCount()	Counts the number of Report Elements in this container and returns it.
List<Element>	getSubComponents()	Returns all ReportComponents that are descendants of this one.
int	getX()	Returns the x position of the left upper corner of the element in the report.
int	getY()	Returns the y position of the left upper corner of the element in the report.
int	indexOf()	Returns the position of this object in the parent collection.
NodeParser	parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap)	FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML
void	remove(Element elem)	Removes the given report element from the container.
void	resetReferences()	FOR INTERNAL USE ONLY
void	setHeight(int height)	This element can not be resized.
void	setReferences()	FOR INTERNAL USE ONLY
void	setWidth(int width)	This element can not be resized.
void	setX(int x)	This element can not be moved.
void	setY(int y)	This element can not be moved.

Von Klasse geerbte Methoden ReportComponent

addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getPropertyFormulas, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getStructElem, getSuppressFormula, getType, getWidth, isDOMParser, isKeepTogether, isSuppress, paramString, parseDOM, parseEndElement, parseText, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setKeepTogether, setKeepTogetherFormula, setStructElem, setSuppress, setSuppressFormula

Von Klasse geerbte Methoden Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methodendetails

addBox

public Box addBox(int boxX,
 int boxY,
 int boxWidth,
 int boxHeight)

Adds a new box to the container and returns it.

Angegeben von:

addBox in Schnittstelle SimpleElementContainer

Parameter:

boxX - The horizontal offset in twips.

boxY - The vertical offset in twips.

boxWidth - The width of the box in twips.

boxHeight - The height of the box in twips.

Gibt zurück:

The created box element or null if the creation was not successful

addFieldElement

public FieldElement addFieldElement(Field field,
 int fieldX,
 int fieldY,
 int fieldWidth,
 int fieldHeight)
                             throws ReportException

Adds a new FieldElement (a dynamic text element based on a Field) to this container and returns it. Note that for binary fields you need to use the method SimpleElementContainer.addDatabasePicture(Field, int, int, int, int), since picture fields are not FieldElements.

Angegeben von:

addFieldElement in Schnittstelle SimpleElementContainer

Parameter:

field - The field that should added into container. May not be null.

fieldX - The x-coordinate of the upper left corner in twips.

fieldY - The y-coordinate of the upper left corner in twips.

fieldWidth - The width of the new fieldElement in twips.

fieldHeight - The height of the new fieldElement in twips.

Gibt zurück:

The created FieldElement if the creation was not successful.

Löst aus:

ReportException - if the value type of the field is binary - use SimpleElementContainer.addDatabasePicture(Field, int, int, int, int) instead.

Siehe auch:

• DatabaseField
• FormulaField
• PromptField
• SummaryField
• SQLField
• GroupField

addJavaBean

public JavaBean addJavaBean(String className,
 int beanX,
 int beanY,
 int beanWidth,
 int beanHeight)
                     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:

addJavaBean in Schnittstelle SimpleElementContainer

Parameter:

className - The class name of the Java Bean.

beanX - The x-coordinate of the upper left corner in twips.

beanY - The y-coordinate of the upper left corner in twips.

beanWidth - The width of the new fieldElement in twips.

beanHeight - The height of the new fieldElement in twips.

Gibt zurück:

The created JavaBean.

Löst aus:

ReportException - if the Java Bean cannot created.

addPicture

public Picture addPicture(int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight,
 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:

addPicture in Schnittstelle SimpleElementContainer

Parameter:

pictureX - The horizontal offset of the start point in twips.

pictureY - The vertical offset of the start point in twips.

pictureWidth - The width of the picture in twips

pictureHeight - 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 if file is an unknown picture format.

Siehe auch:

• SimpleElementContainer.addPicture(int,int,int,int,java.awt.image.BufferedImage)
• SimpleElementContainer.addPicture(int,int,int,int,java.io.File)
• SimpleElementContainer.addPicture(int,int,int,int,byte[])
• SimpleElementContainer.addPicture(int, int, int, int, int[])

addPicture

public Picture addPicture(int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight,
 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:

addPicture in Schnittstelle SimpleElementContainer

Parameter:

pictureX - The horizontal offset of the start point in twips.

pictureY - The vertical offset of the start point in twips.

pictureWidth - The width of the picture in twips.

pictureHeight - 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 if file is an unknown picture format.

Siehe auch:

• SimpleElementContainer.addPicture(int, int, int, int, BufferedImage)
• SimpleElementContainer.addPicture(int, int, int, int, String)
• SimpleElementContainer.addPicture(int, int, int, int, byte[])
• SimpleElementContainer.addPicture(int, int, int, int, int[])

addPicture

public Picture addPicture(int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight,
 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:

addPicture in Schnittstelle SimpleElementContainer

Parameter:

pictureX - The horizontal offset of the start point in twips.

pictureY - The vertical offset of the start point in twips.

pictureWidth - The width of the picture in twips.

pictureHeight - 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 if buffer is an unknown picture format.

Siehe auch:

• SimpleElementContainer.addPicture(int, int, int, int, java.awt.image.BufferedImage)
• SimpleElementContainer.addPicture(int, int, int, int, String)
• SimpleElementContainer.addPicture(int, int, int, int, byte[])
• SimpleElementContainer.addPicture(int, int, int, int, File)
• SimpleElementContainer.addPicture(int,int,int,int,java.io.File)
• SimpleElementContainer.addPicture(int,int,int,int,String)

addPicture

public @Nonnull Picture addPicture(int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight,
 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:

addPicture in Schnittstelle SimpleElementContainer

Parameter:

pictureX - The horizontal offset of the start point in twips.

pictureY - The vertical offset of the start point in twips.

pictureWidth - The width of the picture in twips.

pictureHeight - 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 if buffer is an unknown picture format.

ReportException - if buffer is an unknown picture format.

Siehe auch:

• SimpleElementContainer.addPicture(int,int,int,int,java.awt.image.BufferedImage)
• SimpleElementContainer.addPicture(int, int, int, int, String)
• SimpleElementContainer.addPicture(int,int,int,int,java.io.File)
• SimpleElementContainer.addPicture(int, int, int, int, int[])

addPicture

public Picture addPicture(int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight,
 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:

addPicture in Schnittstelle SimpleElementContainer

Parameter:

pictureX - The horizontal offset of the start point in twips.

pictureY - The vertical offset of the start point in twips.

pictureWidth - The width of the picture in twips.

pictureHeight - 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 if im is an unknown picture format.

Siehe auch:

• SimpleElementContainer.addPicture(int, int, int, int, String)
• SimpleElementContainer.addPicture(int,int,int,int,java.io.File)
• SimpleElementContainer.addPicture(int,int,int,int,byte[])
• SimpleElementContainer.addPicture(int, int, int, int, int[])

addDatabasePicture

public DatabasePicture addDatabasePicture(Field field,
 int pictureX,
 int pictureY,
 int pictureWidth,
 int pictureHeight)

Adds a new DatabasePicture to the container and returns it.

Angegeben von:

addDatabasePicture in Schnittstelle SimpleElementContainer

Parameter:

field - Field which value type is Field.BINARY and that should be added to the container. This can be a database field, a formula field, a prompt field or a SQL field.

pictureX - x-coordinate of the upper left corner in twips.

pictureY - y-coordinate of the upper left corner in twips.

pictureWidth - Width of the new fieldElement in twips.

pictureHeight - Height of the new fieldElement in twips.

Gibt zurück:

new created DatabasePicture

addText

public Text addText(int textX,
 int textY,
 int textWidth,
 int textHeight)

Adds a new text element to the container. To fill a new line into this text element use addParagraph method. The returned text element is empty, that means it contains no paragraph object.

Angegeben von:

addText in Schnittstelle SimpleElementContainer

Parameter:

textX - the x offset of the text element

textY - the y offset of the text element

textWidth - the width of the text element

textHeight - the height of the text element

Gibt zurück:

the created text element.

addHorizontalLine

public Line addHorizontalLine(int xpos,
 int ypos,
 int lineLength)

Adds a new horizontal line to the container and returns it.

Angegeben von:

addHorizontalLine in Schnittstelle SimpleElementContainer

Parameter:

xpos - the horizontal offset of the start point in twips.

ypos - the vertical offset of the start point in twips.

lineLength - the width of the line in twips.

Gibt zurück:

the created line element

addVerticalLine

public Line addVerticalLine(int xpos,
 int ypos,
 int lineLength)

Adds a new vertical line to the container and returns it.

Angegeben von:

addVerticalLine in Schnittstelle SimpleElementContainer

Parameter:

xpos - the horizontal offset of the start point in twips.

ypos - the vertical offset of the start point in twips.

lineLength - the height of the line in twips.

Gibt zurück:

the created line element

remove

public void remove(Element elem)

Removes the given report element from the container.

Angegeben von:

remove in Schnittstelle SimpleElementContainer

Parameter:

elem - The Report Element which should be removed from the container (null is not permitted).

getElementsV

public Vector<Element> getElementsV()

Returns a Vector containing all elements in this container. Each element in the returned Vector is an instance of the class Element or an instance of Element's subclass.

Angegeben von:

getElementsV in Schnittstelle SimpleElementContainer

Gibt zurück:

A Vector containing all elements in this container.

Siehe auch:

• SimpleElementContainer.getElements()
• Element

getElements

public Element[] getElements()

Returns an array containing all elements of this container. Each field of the array contains an instance of class Element or an instance of Elements subclass.

Angegeben von:

getElements in Schnittstelle SimpleElementContainer

Gibt zurück:

An array containing all elements in this container.

Siehe auch:

• SimpleElementContainer.getElementsV()
• Element

contains

public boolean contains(Element el)

Tests if the specified element is a component in this section.

Parameter:

el - an element.

Gibt zurück:

true if and only if the specified element is the same as a component in this section, as determined by the equals method; false otherwise.

Seit:

6.0

setX

public void setX(int x)

This element can not be moved. Invoking this method will have no effect.

Setzt außer Kraft:

setX in Klasse ReportComponent

Parameter:

x - has no effect

Seit:

6.0

setY

public void setY(int y)

This element can not be moved. Invoking this method will have no effect.

Setzt außer Kraft:

setY in Klasse ReportComponent

Parameter:

y - has no effect

Seit:

6.0

getX

public int getX()

Returns the x position of the left upper corner of the element in the report. Use the 'object x position' property the adjust the element position from the left side margin. The unit is in twips.

Setzt außer Kraft:

getX in Klasse ReportComponent

Gibt zurück:

The x position in twips.

getY

public int getY()

Returns the y position of the left upper corner of the element in the report. Use the 'object y position' property the adjust the element position from the top margin. The unit is in twips.

Setzt außer Kraft:

getY in Klasse ReportComponent

Gibt zurück:

The y position in twips.

setWidth

public void setWidth(int width)

This element can not be resized. Invoking this method will have no effect. The size of this element depends on the row header width and the column header height.

Setzt außer Kraft:

setWidth in Klasse ReportComponent

Parameter:

width - Cannot be set for this element.

Seit:

6.0

setHeight

public void setHeight(int height)

This element can not be resized. Invoking this method will have no effect. The size of this element depends on the row header width and the column header height.

Setzt außer Kraft:

setHeight in Klasse ReportComponent

Parameter:

height - Cannot be set for this element.

Seit:

6.0

setReferences

public void setReferences()

FOR INTERNAL USE ONLY

Angegeben von:

setReferences in Schnittstelle com.inet.report.ReferenceHolder

Setzt außer Kraft:

setReferences in Klasse ReportComponent

resetReferences

public void resetReferences()

FOR INTERNAL USE ONLY

Angegeben von:

resetReferences in Schnittstelle com.inet.report.ReferenceHolder

Setzt außer Kraft:

resetReferences in Klasse ReportComponent

indexOf

public int indexOf()
            throws ReportException

Returns the position of this object in the parent collection.

Angegeben von:

indexOf in Klasse ReportComponent

Gibt zurück:

Position of this object in the parent collection.

Löst aus:

ReportException - If there is no parent or the object does not exist.

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
 String tag,
 Attributes atts,
 Map<String,Object> parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses 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:

parseElement in Schnittstelle NodeParser

Setzt außer Kraft:

parseElement in Klasse ReportComponent

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 parsed

atts - The set of attributes in the current XMLTag

parserMap - 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.

getReportElement

public Element getReportElement(int idx)

Get a report Element. You can specify the returned Element with the idx parameter.

Angegeben von:

getReportElement in Schnittstelle SimpleElementContainer

Parameter:

idx - The 0-based index of the element, which should be returned.

Gibt zurück:

in instance of some subclass of Element.

getReportElementsCount

public int getReportElementsCount()

Counts the number of Report Elements in this container and returns it.

Angegeben von:

getReportElementsCount in Schnittstelle SimpleElementContainer

Gibt zurück:

The number of report elements in this container.

getSubComponents

public List<Element> getSubComponents()

Returns all ReportComponents that are descendants of this one. E.G. this will return all Element of a Section. But it's as well useful for CrossTabs or Text elements which have additional elements.

Angegeben von:

getSubComponents in Klasse ReportComponent

Gibt zurück:

a list with all sub components which can be empty as well; will be null if the component has no descendants