Package com.inet.report
Class FieldElement
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.AbstractFontElement
com.inet.report.AbstractValueElement
com.inet.report.FieldElement
- All Implemented Interfaces:
BorderProperties
,FontProperties
,GeneralProperties
,HyperlinkProperties
,ParagraphProperties
,NodeParser
,com.inet.report.ReferenceHolder
,TextInterpretationProperties
,TextProperties
,ValueProperties
,Serializable
,Cloneable
public class FieldElement
extends AbstractValueElement
implements ParagraphProperties, TextProperties, TextInterpretationProperties, com.inet.report.ReferenceHolder, HyperlinkProperties, BorderProperties
A
code example: adding a dynamic content to the detail section
Note that the properties for number and currency formats does not take effect when the property 'use system default format' is set. Changes at properties for date/time/datetime does not take effect when the property 'date windows default type' is set to a short or long default format.
This class is part of the RDC.
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. Add an instance of this class with method
Section.addFieldElement(Field, int, int, int, int)
in class Section
. If you want to insert a field into a Text
using this class is wrong, use
FieldPart
. code example: adding a dynamic content to the detail section
Fields fields = engine.getFields();
Area area = engine.getArea("D");
Section section = area.getSection(0);
FieldElement fElem = section.addFieldElement(fields.getDatabaseField(0),0,0,1000,220);
code example: get existing FieldElements and change the property color
Area area = engine.getArea("D");
Section section = area.getSection(0);
Vector elementsV = section.getElementsV();
for(int i=0;i< elementsV.size();i++){
Element elem = (Element)elementsV.elementAt(i);
if(elem instanceof FieldElement){
FieldElement fElem = (FieldElement)elem;
fElem.setFontColor(CoderXML.COLOR_RED);
}
}
If you need a destined FieldElement
you have to check some properties, to be sure having the right one.Note that the properties for number and currency formats does not take effect when the property 'use system default format' is set. Changes at properties for date/time/datetime does not take effect when the property 'date windows default type' is set to a short or long default format.
This class is part of the RDC.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.inet.report.AbstractValueElement
AbstractValueElement.DateTimeProps, AbstractValueElement.NumberProps
Nested classes/interfaces inherited from class com.inet.report.AbstractFontElement
AbstractFontElement.FontProps
Nested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
Field Summary
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
Fields inherited from interface com.inet.report.BorderProperties
LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE
Fields inherited from interface com.inet.report.FontProperties
FONT_DIALOG, FONT_MONOSPACED, FONT_SANS_SERIF, FONT_SERIF, FONT_STYLE_BOLD, FONT_STYLE_ITALIC, FONT_STYLE_STRIKETHROUGH, FONT_STYLE_UNDERLINE
Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
Fields inherited from interface com.inet.report.ParagraphProperties
INDENT_DEFAULT, LINE_SPACING_ABSOLUTE, LINE_SPACING_RELATIVE
Fields inherited from interface com.inet.report.TextInterpretationProperties
ADVANCED_HTML_TEXT, HTML_TEXT, MARKDOWN_COMMONMARK, MARKDOWN_COWORK, PLAIN_TEXT, RTF_TEXT
Fields inherited from interface com.inet.report.TextProperties
GLYPH_DEFAULT, GLYPH_DOWN, GLYPH_LEFT, GLYPH_RIGHT, GLYPH_UP, ROTATE_0, ROTATE_180, ROTATE_270, ROTATE_90
Fields inherited from interface com.inet.report.ValueProperties
AM_PM_AFTER, AM_PM_BEFORE, BRACKETED, DATE_ONLY_ORDER, DATE_TIME_ORDER, DAY_MONTH_YEAR, DAY_OF_WEEK_ENCLOSURE_ANGLE, DAY_OF_WEEK_ENCLOSURE_NONE, DAY_OF_WEEK_ENCLOSURE_PARENTHESIS, DAY_OF_WEEK_ENCLOSURE_SQUARED, DEFAULT_FORMAT, FIXED_SYMBOL, FLOATING_SYMBOL, GREGORIAN_CALENDAR, GREGORIAN_US_CALENDAR, HIJRI_CALENDAR, JAPANESE_CALENDAR, KOREAN_CALENDAR, LEADING_CURRENCY_INSIDE_NEGATIVE, LEADING_CURRENCY_OUTSIDE_NEGATIVE, LEADING_DAY_OF_WEEK, LEADING_MINUS, LEADING_ZERO_NUMERIC_DAY, LEADING_ZERO_NUMERIC_MONTH, LONG_DAY_OF_WEEK, LONG_ERA, LONG_MONTH, LONG_YEAR, MONTH_DAY_YEAR, NO_DAY, NO_DAY_OF_WEEK, NO_ERA, NO_HOUR, NO_MINUTE, NO_MONTH, NO_SYMBOL, NO_YEAR, NOT_NEGATIVE, NOT_USING_SYSTEM_DEFAULTS, NUMBER_FORMAT_CURRENCY, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_PERCENT, NUMERAL_LANGUAGE_ARABIC, NUMERAL_LANGUAGE_BENGALI, NUMERAL_LANGUAGE_DEVANAGARI, NUMERAL_LANGUAGE_EASTERN_ARABIC, NUMERAL_LANGUAGE_ETHIOPIC, NUMERAL_LANGUAGE_EUROPEAN, NUMERAL_LANGUAGE_GUJARATI, NUMERAL_LANGUAGE_GURMUKHI, NUMERAL_LANGUAGE_KANNADA, NUMERAL_LANGUAGE_KHMER, NUMERAL_LANGUAGE_LAO, NUMERAL_LANGUAGE_MALAYALAM, NUMERAL_LANGUAGE_MONGOLIAN, NUMERAL_LANGUAGE_MYANMAR, NUMERAL_LANGUAGE_ORIYA, NUMERAL_LANGUAGE_TAMIL, NUMERAL_LANGUAGE_TELUGU, NUMERAL_LANGUAGE_THAI, NUMERAL_LANGUAGE_TIBETAN, NUMERIC_DAY, NUMERIC_HOUR, NUMERIC_HOUR_NO_LEADING_ZERO, NUMERIC_MINUTE, NUMERIC_MINUTE_NO_LEADING_ZERO, NUMERIC_MONTH, NUMERIC_NO_LEADING_ZERO, NUMERIC_NO_SECOND, NUMERIC_SECOND, ONE_OR_ZERO, ROUND_CEILING, ROUND_DOWN, ROUND_FLOOR, ROUND_HALF_DOWN, ROUND_HALF_EVEN, ROUND_HALF_UP, ROUND_UP, SHORT_DAY_OF_WEEK, SHORT_ERA, SHORT_MONTH, SHORT_YEAR, T_OR_F, TAIWANESE_CALENDAR, THAI_CALENDAR, TIME_DATE_ORDER, TIME_ONLY_ORDER, TRAILING_CURRENCY_INSIDE_NEGATIVE, TRAILING_CURRENCY_OUTSIDE_NEGATIVE, TRAILING_DAY_OF_WEEK, TRAILING_MINUS, TRUE_OR_FALSE, TWELVE_HOURS, TWENTY_FOUR_HOURS, USE_CUSTOM_FORMAT, USE_SYSTEM_LONG_DATE, USE_SYSTEM_LONG_TIME, USE_SYSTEM_MEDIUM_DATE, USE_SYSTEM_MEDIUM_TIME, USE_SYSTEM_SHORT_DATE, USE_SYSTEM_SHORT_TIME, Y_OR_N, YEAR_MONTH_DAY, YES_OR_NO
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a serializable copy of this Element.Returns the currently set base URL for relative URLs.Returns the property formula set for the base URL property.int
Returns the value of the property 'first line indent'.Returns the formula whose return value determines the property 'first line indent'.int
Returns the glyph orientation.Returns the formula whose return value determines the glyph orientation.int
Returns the value of the property 'left indent'.Returns the formula whose return value determines the property 'left indent'.int
Returns the absolute distance between baselines of the lines in this paragraph, measured in twips.Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.double
Returns the factor by which the default line spacing is to be multiplied for this paragraph.Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.Returns a list with all property formulas that are set for this report element.int
Returns the value of the property 'rightIndent'.Returns the formula whose return value determines the property 'right indent'.List<? extends ReportComponent>
Returns allReportComponent
s that are descendants of this one.int
Returns the type of text interpretation.Sets the formula for the type of text interpretation.int
Returns the value of the property 'text rotation'.Returns the formula whose return value determines the property 'text rotation'.Create a string representation of this class for debugging.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 FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
parseEndElement
(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLYvoid
setBaseUrl
(String base) Sets the base URL for relative URLs.void
setBaseUrlFormula
(FormulaField newFormula) Sets a property formula for the base URL property.void
setCanGrow
(boolean canGrow) Number and Currency Field Elements can be set can grow, however they then always have a maximum limit of 1 line, i.e.void
setCanGrowCount
(int limit) Number and Currency Field Elements can only be set to a can grow maximum limit of 1.void
setFirstLineIndent
(int newValue) Sets the value of the property 'first line indent'.void
setFirstLineIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'first line indent'.void
setGlyphOrientation
(int orientation) Sets the orientation of the glyphs.void
setGlyphOrientationFormula
(FormulaField formula) Sets the formula whose return value determines the glyph orientation.void
setLeftIndent
(int newLeftIndent) Sets the value of the property 'left indent'.void
setLeftIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'left indent'.void
setLineSpacingAbsolute
(int lineSpacingAbsolute) Sets the absolute distance between baselines of the lines in this paragraph, measured in twips.void
Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.void
setLineSpacingRelative
(double lineSpacingRelative) Sets the factor by which the default line spacing is to be multiplied for this paragraph.void
Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph.void
setRightIndent
(int newRightIndent) Sets the value of the property 'rightIndent'.void
setRightIndentFormula
(FormulaField formula) Sets the formula whose return value determines the property 'right indent'.void
setTextInterpretation
(int interpretation) Sets the type of text interpretation for the data of the field.void
setTextInterpretationFormula
(FormulaField newFormula) Sets the formula for the type of text interpretation.void
setTextRotation
(int rotation) Sets the value of the property 'text rotation'.void
setTextRotationFormula
(FormulaField formula) Sets the formula whose return value determines the property 'text rotation'.Methods inherited from class com.inet.report.AbstractValueElement
getAllowFieldClippingFormula, getAmPmOrder, getAmPmOrderFormula, getAmString, getAmStringFormula, getBooleanFormatOutputType, getBooleanFormatOutputTypeFormula, getCurrencyPosition, getCurrencyPositionFormula, getCurrencySeparator, getCurrencySeparatorFormula, getCurrencySymbol, getCurrencySymbolFormula, getCurrencySymbolType, getCurrencySymbolTypeFormula, getDateCalendarType, getDateCalendarTypeFormula, getDateEraType, getDateEraTypeFormula, getDateFirstSeparator, getDateFirstSeparatorFormula, getDateFormatType, getDateFormatTypeFormula, getDateOrder, getDateOrderFormula, getDatePrefixSeparator, getDatePrefixSeparatorFormula, getDateSecondSeparator, getDateSecondSeparatorFormula, getDateSuffixSeparator, getDateSuffixSeparatorFormula, getDateTimeOrder, getDateTimeOrderFormula, getDateTimeSeparator, getDateTimeSeparatorFormula, getDateWindowsDefaultTypeFormula, getDayOfWeekEnclosure, getDayOfWeekEnclosureFormula, getDayOfWeekPosition, getDayOfWeekPositionFormula, getDayOfWeekSeparator, getDayOfWeekSeparatorFormula, getDayOfWeekType, getDayOfWeekTypeFormula, getDayType, getDayTypeFormula, getDecimalSeparatorSymbol, getDecimalSeparatorSymbolFormula, getHourMinuteSeparator, getHourMinuteSeparatorFormula, getHourType, getHourTypeFormula, getManualFormatFormula, getMinuteSecondSeparator, getMinuteSecondSeparatorFormula, getMinuteType, getMinuteTypeFormula, getMonthType, getMonthTypeFormula, getNDecimalPlaces, getNDecimalPlacesFormula, getNegativeType, getNegativeTypeFormula, getNumberFormatType, getNumberFormatTypeFormula, getNumeralLanguage, getPmString, getPmStringFormula, getReverseSignForDisplayFormula, getRounding, getRoundingFormula, getRoundingMode, getRoundingModeFormula, getSecondType, getSecondTypeFormula, getSuppressIfZero, getSuppressIfZeroFormula, getThousandsSeparatorSymbol, getThousandsSeparatorSymbolFormula, getTimeBase, getTimeBaseFormula, getTimeFormatType, getTimeFormatTypeFormula, getUseLeadingZero, getUseLeadingZeroFormula, getUseOneCurrencySymbolPerPage, getUseOneCurrencySymbolPerPageFormula, getUseThousandsSeparator, getUseThousandsSeparatorFormula, getYearType, getYearTypeFormula, getZeroValueString, isAllowFieldClipping, isReverseSignForDisplay, setAllowFieldClipping, setAllowFieldClippingFormula, setAmPmOrder, setAmPmOrderFormula, setAmString, setAmStringFormula, setBooleanFormatOutputType, setBooleanFormatOutputTypeFormula, setCurrencyPosition, setCurrencyPositionFormula, setCurrencySeparator, setCurrencySeparatorFormula, setCurrencySymbol, setCurrencySymbolFormula, setCurrencySymbolType, setCurrencySymbolTypeFormula, setDateCalendarType, setDateCalendarTypeFormula, setDateEraType, setDateEraTypeFormula, setDateFirstSeparator, setDateFirstSeparatorFormula, setDateFormatType, setDateFormatTypeFormula, setDateOrder, setDateOrderFormula, setDatePrefixSeparator, setDatePrefixSeparatorFormula, setDateSecondSeparator, setDateSecondSeparatorFormula, setDateSuffixSeparator, setDateSuffixSeparatorFormula, setDateTimeOrder, setDateTimeOrderFormula, setDateTimeSeparator, setDateTimeSeparatorFormula, setDateWindowsDefaultTypeFormula, setDayOfWeekEnclosure, setDayOfWeekEnclosureFormula, setDayOfWeekPosition, setDayOfWeekPositionFormula, setDayOfWeekSeparator, setDayOfWeekSeparatorFormula, setDayOfWeekType, setDayOfWeekTypeFormula, setDayType, setDayTypeFormula, setDecimalSeparatorSymbol, setDecimalSeparatorSymbolFormula, setField, setHourMinuteSeparator, setHourMinuteSeparatorFormula, setHourType, setHourTypeFormula, setManualFormatFormula, setMinuteSecondSeparator, setMinuteSecondSeparatorFormula, setMinuteType, setMinuteTypeFormula, setMonthType, setMonthTypeFormula, setNDecimalPlaces, setNDecimalPlacesFormula, setNegativeType, setNegativeTypeFormula, setNumberFormatType, setNumberFormatTypeFormula, setNumeralLanguage, setPmString, setPmStringFormula, setReverseSignForDisplay, setReverseSignForDisplayFormula, setRounding, setRoundingFormula, setRoundingMode, setRoundingModeFormula, setSecondType, setSecondTypeFormula, setSuppressIfZero, setSuppressIfZeroFormula, setThousandsSeparatorSymbol, setThousandsSeparatorSymbolFormula, setTimeBase, setTimeBaseFormula, setTimeFormatType, setTimeFormatTypeFormula, setUseLeadingZero, setUseLeadingZeroFormula, setUseOneCurrencySymbolPerPage, setUseOneCurrencySymbolPerPageFormula, setUseThousandsSeparator, setUseThousandsSeparatorFormula, setYearType, setYearTypeFormula, setZeroValueString
Methods inherited from class com.inet.report.AbstractFontElement
getFontColor, getFontColorFormula, getFontName, getFontNameFormula, getFontSize, getFontSizeFormula, getFontSizeTwips, getFontStyle, getFontStyleFormula, getStrikeoutFormula, getUnderlineFormula, isBold, isItalic, isStrikeout, isUnderline, setBold, setFontColor, setFontColorFormula, setFontName, setFontNameFormula, setFontSize, setFontSizeFormula, setFontSizeTwips, setFontStyle, setFontStyleFormula, setItalic, setStrikeout, setStrikeoutFormula, setUnderline, setUnderlineFormula
Methods inherited from class com.inet.report.Element
addListener, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.report.BorderProperties
getBackColor, getBackColorFormula, getBottomLineStyle, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyle, getLeftLineStyleFormula, getRightLineStyle, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyle, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
Methods inherited from interface com.inet.report.HyperlinkProperties
getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula
Methods inherited from interface com.inet.report.ReferenceHolder
addReferencedObject, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, removeReferencedObject, setReferences
-
Method Details
-
copy
Creates a serializable copy of this Element. The returned Object is not an instance of Element. This method is used from i-net Designer for Copy and Paste.- Overrides:
copy
in classElement
- Returns:
- A serializable Object.
- Throws:
ReportException
- If accessing properties of this Element causes any errors.- See Also:
-
getFirstLineIndent
public int getFirstLineIndent()Returns the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
getFirstLineIndent
in interfaceParagraphProperties
- Returns:
- The value of the property 'first line indent'.
-
setFirstLineIndent
public void setFirstLineIndent(int newValue) Sets the value of the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
setFirstLineIndent
in interfaceParagraphProperties
- Parameters:
newValue
- The new value of the property 'first line indent'. May be negative (which would cause the first line to be left of the left margin).
-
getLeftIndent
public int getLeftIndent()Returns the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
getLeftIndent
in interfaceParagraphProperties
- Returns:
- The value of the property 'left indent'.
-
setLeftIndent
public void setLeftIndent(int newLeftIndent) Sets the value of the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
setLeftIndent
in interfaceParagraphProperties
- Parameters:
newLeftIndent
- The new value of the property 'left indent'.
-
getRightIndent
public int getRightIndent()Returns the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
getRightIndent
in interfaceParagraphProperties
- Returns:
- The current value of the property 'rightIndent'.
-
setRightIndent
public void setRightIndent(int newRightIndent) Sets the value of the property 'rightIndent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
setRightIndent
in interfaceParagraphProperties
- Parameters:
newRightIndent
- The new value of the property 'rightIndent'.
-
setLineSpacingAbsolute
public void setLineSpacingAbsolute(int lineSpacingAbsolute) Sets the absolute distance between baselines of the lines in this paragraph, measured in twips. It is also possible to set LINE_SPACING_RELATIVE, which restores the default setting.- Specified by:
setLineSpacingAbsolute
in interfaceParagraphProperties
- Parameters:
lineSpacingAbsolute
- Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE in order to restore the default setting.- See Also:
-
getLineSpacingAbsolute
public int getLineSpacingAbsolute()Returns the absolute distance between baselines of the lines in this paragraph, measured in twips. If a relative factor has been set, this will return the constant LINE_SPACING_RELATIVE.- Specified by:
getLineSpacingAbsolute
in interfaceParagraphProperties
- Returns:
- Absolute distance between baselines in this paragraph, measured in twips, or LINE_SPACING_RELATIVE
- See Also:
-
setLineSpacingRelative
public void setLineSpacingRelative(double lineSpacingRelative) Sets the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. Setting LINE_SPACING_ABSOLUTE will cause the value to be reset to its default, which is "1".- Specified by:
setLineSpacingRelative
in interfaceParagraphProperties
- Parameters:
lineSpacingRelative
- Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if the default value is to be set (equivalent to "1")- See Also:
-
getLineSpacingRelative
public double getLineSpacingRelative()Returns the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this number. If an absolute value has been set, this will return LINE_SPACING_ABSOLUTE instead.- Specified by:
getLineSpacingRelative
in interfaceParagraphProperties
- Returns:
- Factor by which the default line spacing is to be multiplied for this paragraph, or LINE_SPACING_ABSOLUTE if an absolute line spacing distance has been set.
- See Also:
-
getTextInterpretation
public int getTextInterpretation()Returns the type of text interpretation.- Specified by:
getTextInterpretation
in interfaceTextInterpretationProperties
- Returns:
- one of the representing text interpretation.
- See Also:
-
setTextInterpretation
public void setTextInterpretation(int interpretation) Sets the type of text interpretation for the data of the field.- Specified by:
setTextInterpretation
in interfaceTextInterpretationProperties
- Parameters:
interpretation
- the new text interpretation to set. must be one ofTextInterpretationProperties.PLAIN_TEXT
,TextInterpretationProperties.RTF_TEXT
,TextInterpretationProperties.HTML_TEXT
,TextInterpretationProperties.ADVANCED_HTML_TEXT
,TextInterpretationProperties.MARKDOWN_COMMONMARK
orTextInterpretationProperties.MARKDOWN_COWORK
.- See Also:
-
TextInterpretationProperties.getTextInterpretation()
TextInterpretationProperties.PLAIN_TEXT
TextInterpretationProperties.RTF_TEXT
TextInterpretationProperties.HTML_TEXT
TextInterpretationProperties.ADVANCED_HTML_TEXT
TextInterpretationProperties.MARKDOWN_COMMONMARK
TextInterpretationProperties.MARKDOWN_COWORK
-
getTextInterpretationFormula
Sets the formula for the type of text interpretation.- Specified by:
getTextInterpretationFormula
in interfaceTextInterpretationProperties
- Returns:
- the formula set for text interpretation or
null
if none has been set - See Also:
-
TextInterpretationProperties.setTextInterpretation(int)
TextInterpretationProperties.getTextInterpretation()
TextInterpretationProperties.setTextInterpretationFormula(com.inet.report.FormulaField)
TextInterpretationProperties.PLAIN_TEXT
TextInterpretationProperties.RTF_TEXT
TextInterpretationProperties.HTML_TEXT
TextInterpretationProperties.ADVANCED_HTML_TEXT
TextInterpretationProperties.MARKDOWN_COMMONMARK
TextInterpretationProperties.MARKDOWN_COWORK
-
setTextInterpretationFormula
Sets the formula for the type of text interpretation.- Specified by:
setTextInterpretationFormula
in interfaceTextInterpretationProperties
- Parameters:
newFormula
- the formula to set for text interpretation ornull
if no formula should be set- See Also:
-
TextInterpretationProperties.setTextInterpretation(int)
TextInterpretationProperties.getTextInterpretation()
TextInterpretationProperties.getTextInterpretationFormula()
TextInterpretationProperties.PLAIN_TEXT
TextInterpretationProperties.RTF_TEXT
TextInterpretationProperties.HTML_TEXT
TextInterpretationProperties.ADVANCED_HTML_TEXT
TextInterpretationProperties.MARKDOWN_COMMONMARK
TextInterpretationProperties.MARKDOWN_COWORK
-
getBaseUrl
Returns the currently set base URL for relative URLs. Null may be returned, which means that the report server location is taken as the base URL.- Specified by:
getBaseUrl
in interfaceTextInterpretationProperties
- Returns:
- the currently set base URL for relative URLs, or null if there is none.
- See Also:
-
getBaseUrlFormula
Returns the property formula set for the base URL property. Can be null which means that no property formula was set for the property.- Specified by:
getBaseUrlFormula
in interfaceTextInterpretationProperties
- Returns:
- returns the current base URL property formula as a formula field.
- See Also:
-
setBaseUrl
Sets the base URL for relative URLs. If a hyperlink URL is relative, it is viewed as relative to this base URL. Setting null causes the default behavior (URLs are viewed as relative to the report server location).- Specified by:
setBaseUrl
in interfaceTextInterpretationProperties
- Parameters:
base
- Base URL to use for relative URLs- See Also:
-
setBaseUrlFormula
Sets a property formula for the base URL property. Can be null which causes there to be no property formula set.- Specified by:
setBaseUrlFormula
in interfaceTextInterpretationProperties
- Parameters:
newFormula
- formula field for the property formula for the base URL property, or null- See Also:
-
paramString
Create a string representation of this class for debugging.- Overrides:
paramString
in classElement
- Returns:
- the string representation of this object
- Since:
- 7.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 descendantReportComponent
of this one. To get the property formulas for descendantReportComponent
useReportComponent.getSubComponents()
- Overrides:
getPropertyFormulas
in classAbstractValueElement
- Returns:
- List of property formulas
- Since:
- 6.0
-
resetReferences
public void resetReferences()FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY- Specified by:
resetReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
resetReferences
in classReportComponent
-
getGlyphOrientation
public int getGlyphOrientation()Returns the glyph orientation. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.- Specified by:
getGlyphOrientation
in interfaceTextProperties
- Returns:
- glyph orientation
- See Also:
-
setGlyphOrientation
public void setGlyphOrientation(int orientation) Sets the orientation of the glyphs. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.- Specified by:
setGlyphOrientation
in interfaceTextProperties
- Parameters:
orientation
- Orientation to be set for the glyphs (i.e. the rotation of every individual character of the line of text)- See Also:
-
setGlyphOrientationFormula
Sets the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.- Specified by:
setGlyphOrientationFormula
in interfaceTextProperties
- Parameters:
formula
- the formula whose return value determines the glyph orientation
-
getGlyphOrientationFormula
Returns the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.- Specified by:
getGlyphOrientationFormula
in interfaceTextProperties
- Returns:
- the formula whose return value determines the glyph orientation
-
setTextRotation
public void setTextRotation(int rotation) Sets the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.- Specified by:
setTextRotation
in interfaceTextProperties
- Parameters:
rotation
- The new value of the property 'text rotation'. Rotation is done counter-clockwise.- Since:
- 5.4
- See Also:
-
getTextRotation
public int getTextRotation()Returns the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.- Specified by:
getTextRotation
in interfaceTextProperties
- Returns:
- The value of the property 'text rotation'.
- Since:
- 5.4
- See Also:
-
getTextRotationFormula
Returns the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.- Specified by:
getTextRotationFormula
in interfaceTextProperties
- Returns:
- formula whose return value determines the property 'text rotation'.
- See Also:
-
setTextRotationFormula
Sets the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.- Specified by:
setTextRotationFormula
in interfaceTextProperties
- Parameters:
formula
- formula whose return value determines the property 'text rotation'.- See Also:
-
setCanGrow
public void setCanGrow(boolean canGrow) Number and Currency Field Elements can be set can grow, however they then always have a maximum limit of 1 line, i.e. they grow until at least one line is visible. All other FieldElements are normal in regards to their "can grow" behavior.- Specified by:
setCanGrow
in interfaceGeneralProperties
- Overrides:
setCanGrow
in classElement
- Parameters:
canGrow
- whether or not this element should be able to "grow" vertically if its content exceeds its available space.- Since:
- 7.0
- See Also:
-
setCanGrowCount
public void setCanGrowCount(int limit) Number and Currency Field Elements can only be set to a can grow maximum limit of 1. All other FieldElements can be set normally.- Specified by:
setCanGrowCount
in interfaceGeneralProperties
- Overrides:
setCanGrowCount
in classElement
- Parameters:
limit
- maximum "can grow" limit- Throws:
IllegalArgumentException
- if this Element is a Number or Currency FieldElement and newFormula is not 1- Since:
- 7.0
- See Also:
-
getFirstLineIndentFormula
Returns the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
getFirstLineIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'first line indent'.
-
getLeftIndentFormula
Returns the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
getLeftIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'left indent'.
-
getLineSpacingAbsoluteFormula
Returns the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.- Specified by:
getLineSpacingAbsoluteFormula
in interfaceParagraphProperties
- Returns:
- Absolute distance between baselines in this paragraph, measured in twips
- See Also:
-
getLineSpacingRelativeFormula
Returns the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.- Specified by:
getLineSpacingRelativeFormula
in interfaceParagraphProperties
- Returns:
- formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph
- See Also:
-
getRightIndentFormula
Returns the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
getRightIndentFormula
in interfaceParagraphProperties
- Returns:
- The formula whose return value determines the property 'right indent'.
-
setFirstLineIndentFormula
Sets the formula whose return value determines the property 'first line indent'. This is the distance that the first line of the paragraph is indented from the left margin of the paragraph (in twips).- Specified by:
setFirstLineIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'first line indent'.
-
setLeftIndentFormula
Sets the formula whose return value determines the property 'left indent'. This is the distance that the the paragraph is indented from the left margin of the element (in twips).- Specified by:
setLeftIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'left indent'.
-
setLineSpacingAbsoluteFormula
Sets the formula whose return value determines the absolute distance between baselines of the lines in this paragraph, measured in twips.- Specified by:
setLineSpacingAbsoluteFormula
in interfaceParagraphProperties
- Parameters:
formula
- formula whose return value determines the absolute distance between baselines in this paragraph, measured in twips- See Also:
-
setLineSpacingRelativeFormula
Sets the formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph. The default line spacing is determined by font and font size, and is then multiplied by this formula's value.- Specified by:
setLineSpacingRelativeFormula
in interfaceParagraphProperties
- Parameters:
formula
- formula whose return value determines the factor by which the default line spacing is to be multiplied for this paragraph- See Also:
-
setRightIndentFormula
Sets the formula whose return value determines the property 'right indent'. This is the distance that the the paragraph is indented from the right margin of the element (in twips).- Specified by:
setRightIndentFormula
in interfaceParagraphProperties
- Parameters:
formula
- The formula whose return value determines the property 'right indent'.
-
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 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.
- Specified by:
parseElement
in interfaceNodeParser
- Overrides:
parseElement
in classAbstractValueElement
- Parameters:
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.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
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 Internal method for reading report XMLReceive notification of the end of an XML tag.
- Specified by:
parseEndElement
in interfaceNodeParser
- Overrides:
parseEndElement
in classReportComponent
- Parameters:
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.- Throws:
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)
- Specified by:
parseText
in interfaceNodeParser
- Overrides:
parseText
in classElement
- Parameters:
text
- text encountered and to be storedparserMap
- The map of current Parser.
-
getSubComponents
Returns allReportComponent
s that are descendants of this one. E.G. this will return all Element of aSection
. But it's as well useful forCrossTab
s orText
elements which have additional elements.- Specified by:
getSubComponents
in classReportComponent
- Returns:
- a list with all sub components which can be empty as well; will be
null
if the component has no descendants
-