Package com.inet.report
Class AbstractValueElement
- java.lang.Object
-
- com.inet.report.ReportComponent
-
- com.inet.report.Element
-
- com.inet.report.AbstractFontElement
-
- com.inet.report.AbstractValueElement
-
- All Implemented Interfaces:
FontProperties,GeneralProperties,NodeParser,com.inet.report.ReferenceHolder,ValueProperties,java.io.Serializable,java.lang.Cloneable
- Direct Known Subclasses:
FieldElement,FieldPart
public abstract class AbstractValueElement extends AbstractFontElement implements ValueProperties
This class is an abstract implementation of the interfaceValueProperties.- Since:
- 6.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAbstractValueElement.DateTimePropsFOR INTERNAL USE ONLYstatic classAbstractValueElement.NumberPropsFOR INTERNAL USE ONLY-
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.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.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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FormulaFieldgetAllowFieldClippingFormula()Get the formula for the property 'allow field clipping'.intgetAmPmOrder()Returns the value of the property 'am pm order/type'.FormulaFieldgetAmPmOrderFormula()returns the formula of the property 'am pm order/type'.java.lang.StringgetAmString()Returns the value of the property 'am string'.FormulaFieldgetAmStringFormula()Returns the formula of the property 'am string'.intgetBooleanFormatOutputType()Returns the value of the property 'boolean format output type'.FormulaFieldgetBooleanFormatOutputTypeFormula()Returns the formula for the property 'boolean format output type'.intgetCurrencyPosition()Returns the value of the property 'currency position type'.FormulaFieldgetCurrencyPositionFormula()Returns the formula for the property 'currency position type'.java.lang.StringgetCurrencySeparator()Returns the separator between the number value and currency symbol.FormulaFieldgetCurrencySeparatorFormula()Returns the formula for the property 'currency separator'.java.lang.StringgetCurrencySymbol()Returns the value of the property 'currency symbol'.FormulaFieldgetCurrencySymbolFormula()Returns the formula for the property 'currency symbol'.intgetCurrencySymbolType()Returns the value of the property 'currency symbol type'.FormulaFieldgetCurrencySymbolTypeFormula()Returns the formula for the property 'currency symbol type'.intgetDateCalendarType()Returns the value of the property 'date calendar type'.FormulaFieldgetDateCalendarTypeFormula()Returns the formula of the property 'date calendar type'.intgetDateEraType()Returns the value of the property 'date era type'.FormulaFieldgetDateEraTypeFormula()Returns the formula of the property 'date era type'.java.lang.StringgetDateFirstSeparator()Returns the value of the property 'date first separator'.FormulaFieldgetDateFirstSeparatorFormula()Returns the formula for the property 'date first separator'.intgetDateFormatType()Returns the date format type set for this element.FormulaFieldgetDateFormatTypeFormula()Returns the formula for the property 'date format type'.intgetDateOrder()Returns the value of the property 'date order'.FormulaFieldgetDateOrderFormula()Returns the formula for the property 'date order'.java.lang.StringgetDatePrefixSeparator()Returns the value of the property 'date prefix separator'.FormulaFieldgetDatePrefixSeparatorFormula()Returns the formula for the property 'date prefix separator'.java.lang.StringgetDateSecondSeparator()Returns the value of the property 'date second separator'.FormulaFieldgetDateSecondSeparatorFormula()Returns the formula for the property 'date second separator'.java.lang.StringgetDateSuffixSeparator()Returns the value of the property 'date suffix separator'.FormulaFieldgetDateSuffixSeparatorFormula()Returns the formula for the property 'date suffix separator'.intgetDateTimeOrder()Returns the value of the property 'date time order'.FormulaFieldgetDateTimeOrderFormula()Returns the formula for the property 'date time order'.java.lang.StringgetDateTimeSeparator()Returns the value of the property 'date time separator'.FormulaFieldgetDateTimeSeparatorFormula()Returns the formula for the property 'date time separator'.FormulaFieldgetDateWindowsDefaultTypeFormula()Deprecated.As of i-net Crystal-Clear 8.0, usegetDateFormatTypeFormula()instead.intgetDayOfWeekEnclosure()Returns the value of the property 'day of week enclosure'.FormulaFieldgetDayOfWeekEnclosureFormula()Returns the formula for the property 'day of week enclosure'.intgetDayOfWeekPosition()Returns the value of the property 'day of week position'.FormulaFieldgetDayOfWeekPositionFormula()Returns the formula for the property 'day of week position'.java.lang.StringgetDayOfWeekSeparator()Returns the value of the property 'day of week separator'.FormulaFieldgetDayOfWeekSeparatorFormula()Returns the formula for the property 'day of week separator'.intgetDayOfWeekType()Returns the value of the property 'day of week type'.FormulaFieldgetDayOfWeekTypeFormula()Returns the formula for the property 'day of week type'.intgetDayType()Returns the value of the property 'day type'.FormulaFieldgetDayTypeFormula()Returns the formula for the property 'day type'.java.lang.StringgetDecimalSeparatorSymbol()Returns the value of the property 'decimal separators symbol'.FormulaFieldgetDecimalSeparatorSymbolFormula()Returns the formula for the property 'decimal separators symbol'.java.lang.StringgetHourMinuteSeparator()Returns the value of the property 'hour minute sepereator'.FormulaFieldgetHourMinuteSeparatorFormula()Returns the formula for the property 'hour minute sepereator'.intgetHourType()Returns the value of the property 'hour type'.FormulaFieldgetHourTypeFormula()Returns the formula for the property 'hour type'.FormulaFieldgetManualFormatFormula()Gets the formula of the property 'manual format'.java.lang.StringgetMinuteSecondSeparator()Returns the value of the property 'minute second separator'.FormulaFieldgetMinuteSecondSeparatorFormula()Returns the formula for the property 'minute second separator'.intgetMinuteType()Returns the value of the property 'minute type'.FormulaFieldgetMinuteTypeFormula()Returns the formula for the property 'minute type'.intgetMonthType()Returns the value of the property 'month type'.FormulaFieldgetMonthTypeFormula()Returns the formula for the property 'month type'.intgetNDecimalPlaces()Returns the value of the property 'n decimal places'.FormulaFieldgetNDecimalPlacesFormula()Returns the formula for the property 'n decimal places'.intgetNegativeType()Returns the value of the property 'negative type'.FormulaFieldgetNegativeTypeFormula()Returns the formula for the property 'negative type'.intgetNumberFormatType()Returns the number format type set for this element.FormulaFieldgetNumberFormatTypeFormula()Returns the formula which returns the number format type to use for this element.intgetNumeralLanguage()Returns the language of numerals for numbers, date, time and datetime values.java.lang.StringgetPmString()Returns the value of the property 'pm string'.FormulaFieldgetPmStringFormula()Returns the formula of the property 'pm string'.java.util.List<FormulaField>getPropertyFormulas()Returns a list with all property formulas that are set for this report element.FormulaFieldgetReverseSignForDisplayFormula()Returns the formula for the property 'use reverse sign for display'.intgetRounding()Returns which digit to round the number to.FormulaFieldgetRoundingFormula()Returns the formula which provides the digit to round the number to.intgetRoundingMode()Returns the rounding mode for this element.FormulaFieldgetRoundingModeFormula()Returns the formula for the rounding mode, can be null if the formula is not set.intgetSecondType()Returns the value of the property 'second type'.FormulaFieldgetSecondTypeFormula()Returns the formula for the property 'second type'.booleangetSuppressIfZero()Returns the value of the property 'suppress if zero'.FormulaFieldgetSuppressIfZeroFormula()Returns the formula for the property 'suppress if zero'.java.lang.StringgetThousandsSeparatorSymbol()Returns the value of the property 'thousands separator symbol'.FormulaFieldgetThousandsSeparatorSymbolFormula()Returns the formula for the property 'thousands separator symbol'.intgetTimeBase()Returns the value of the property 'time base'.FormulaFieldgetTimeBaseFormula()Returns the formula for the property 'time base'.intgetTimeFormatType()Returns the time format type to use for this element.FormulaFieldgetTimeFormatTypeFormula()Returns the formula determining the time format type to use for this element.booleangetUseLeadingZero()Returns the value of the property 'use leading zero'.FormulaFieldgetUseLeadingZeroFormula()Returns the formula for the property 'use leading zero'.booleangetUseOneCurrencySymbolPerPage()Returns the value of the property 'use one currency symbol per page'.FormulaFieldgetUseOneCurrencySymbolPerPageFormula()Returns the formula for the property 'use one currency symbol per page'.booleangetUseThousandsSeparator()Returns the value of the property 'use thousands separator'.FormulaFieldgetUseThousandsSeparatorFormula()Returns the formula for the property 'use thousands separator'.intgetYearType()Returns the value of the property 'year type'.FormulaFieldgetYearTypeFormula()Returns the formula for the property 'year type'.java.lang.StringgetZeroValueString()Returns the value of the property 'zero value string'.booleanisAllowFieldClipping()Returnstrueif allow field clipping is enabled, elsefalseis returned.booleanisReverseSignForDisplay()Checks the property 'use reverse sign for display'NodeParserparseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidsetAllowFieldClipping(boolean newValue)Sets the value of the property 'allow field clipping'.voidsetAllowFieldClippingFormula(FormulaField newField)Set the formula for the property 'allow field clipping'.voidsetAmPmOrder(int newValue)Sets the value of the property 'am pm order/type'.voidsetAmPmOrderFormula(FormulaField newFormula)Sets the formula for the property 'am pm order/type'.voidsetAmString(java.lang.String newValue)Sets the value of the property 'am string'.voidsetAmStringFormula(FormulaField newFormula)Sets the formula for the property 'am string'.voidsetBooleanFormatOutputType(int newValue)Sets the value of the property 'boolean format output type'.voidsetBooleanFormatOutputTypeFormula(FormulaField newFormula)Sets the formula for the property 'boolean format output type'.voidsetCurrencyPosition(int newValue)Sets the value of the property 'currency position type'.voidsetCurrencyPositionFormula(FormulaField newFormula)Sets the formula for the property 'currency position type'.voidsetCurrencySeparator(java.lang.String newCurrencySeparator)Sets the separator to be displayed between the number value and the currency value.voidsetCurrencySeparatorFormula(FormulaField newFormula)Sets the formula which should be used to retrieve the value for the separator between number value and currency symbol.voidsetCurrencySymbol(java.lang.String newValue)Sets the value of the property 'currency symbol'.voidsetCurrencySymbolFormula(FormulaField newFormula)Sets the formula for the property 'currency symbol'.voidsetCurrencySymbolType(int newValue)Sets the value of the property 'currency symbol type'.voidsetCurrencySymbolTypeFormula(FormulaField newFormula)Sets the formula for the property 'currency symbol type'.voidsetDateCalendarType(int newValue)Sets the value of the property 'date calendar type'.voidsetDateCalendarTypeFormula(FormulaField newFormula)Sets the formula for the property 'date calendar type'.voidsetDateEraType(int newValue)Sets the value of the property 'date era type'.voidsetDateEraTypeFormula(FormulaField newFormula)Sets the formula for the property 'date era type'.voidsetDateFirstSeparator(java.lang.String newValue)Sets the value of the property 'date first separator'.voidsetDateFirstSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'date first separator'.voidsetDateFormatType(int newValue)Sets the date format type to use for this element.voidsetDateFormatTypeFormula(FormulaField newFormula)Sets the formula for the property 'date format type'.voidsetDateOrder(int newValue)Sets the value of the property 'date order'.voidsetDateOrderFormula(FormulaField newFormula)Sets the formula for the property 'date order'.voidsetDatePrefixSeparator(java.lang.String newValue)Sets the value of the property 'date prefix separator'.voidsetDatePrefixSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'date prefix separator'.voidsetDateSecondSeparator(java.lang.String newValue)Sets the value of the property 'date second separator'.voidsetDateSecondSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'date second separator'.voidsetDateSuffixSeparator(java.lang.String newValue)Sets the value of the property 'date suffix separator'.voidsetDateSuffixSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'date suffix separator'.voidsetDateTimeOrder(int newValue)Sets the value of the property 'date time order'.voidsetDateTimeOrderFormula(FormulaField newFormula)Sets the formula for the property 'date time order'.voidsetDateTimeSeparator(java.lang.String newValue)Sets the value of the property 'date time separator'.voidsetDateTimeSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'date time separator'.voidsetDateWindowsDefaultTypeFormula(FormulaField newFormula)Deprecated.As of i-net Crystal-Clear 8.0, usesetDateFormatTypeFormula(FormulaField)instead.voidsetDayOfWeekEnclosure(int newValue)Sets the value of the property 'day of week enclosure'.voidsetDayOfWeekEnclosureFormula(FormulaField newFormula)Sets the formula for the property 'day of week enclosure'.voidsetDayOfWeekPosition(int newValue)Sets the value of the property 'day of week position'.voidsetDayOfWeekPositionFormula(FormulaField newFormula)Sets the formula for the property 'day of week position'.voidsetDayOfWeekSeparator(java.lang.String newValue)Sets the value of the property 'day of week separator'.voidsetDayOfWeekSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'day of week separator'.voidsetDayOfWeekType(int newValue)Sets the value of the property 'day of week type'.voidsetDayOfWeekTypeFormula(FormulaField newFormula)Sets the formula for the property 'day of week type'.voidsetDayType(int newValue)Sets the value of the property 'day type'.voidsetDayTypeFormula(FormulaField newFormula)Sets the formula for the property 'day type'.voidsetDecimalSeparatorSymbol(java.lang.String newValue)Sets the value of the property 'decimal separators symbol'.voidsetDecimalSeparatorSymbolFormula(FormulaField newFormula)Sets the formula for the property 'decimal separators symbol'.voidsetField(Field newField)Sets the field definition element (for example, DatabaseField element, prompt field element).voidsetHourMinuteSeparator(java.lang.String newValue)Sets the value of the property 'hour minute sepereator'.voidsetHourMinuteSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'hour minute sepereator'.voidsetHourType(int newValue)Sets the value of the property 'hour type'.voidsetHourTypeFormula(FormulaField newFormula)Sets the formula for the property 'hour type'.voidsetManualFormatFormula(FormulaField newFormula)Gets the formula of the property 'manual format'.voidsetMinuteSecondSeparator(java.lang.String newValue)Sets the value of the property 'minute second separator'.voidsetMinuteSecondSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'minute second separator'.voidsetMinuteType(int newValue)Sets the value of the property 'minute type'.voidsetMinuteTypeFormula(FormulaField newFormula)Sets the formula for the property 'minute type'.voidsetMonthType(int newValue)Sets the value of the property 'month type'.voidsetMonthTypeFormula(FormulaField newFormula)Sets the formula for the property 'month type'.voidsetNDecimalPlaces(int newValue)Sets the value of the property 'n decimal places'.voidsetNDecimalPlacesFormula(FormulaField newFormula)Sets the formula for the property 'n decimal places'.voidsetNegativeType(int newValue)Sets the value of the property 'negative type'.voidsetNegativeTypeFormula(FormulaField newFormula)Sets the formula for the property 'negative type'.voidsetNumberFormatType(int newValue)Sets the number format type to use for this element.voidsetNumberFormatTypeFormula(FormulaField newFormula)Sets the formula which returns the number format type to use for this element.voidsetNumeralLanguage(int language)Sets the language of the numerals in number, date, time or datetime values.voidsetPmString(java.lang.String newValue)Sets the value of the property 'pm string'.voidsetPmStringFormula(FormulaField newFormula)Sets the formula for the property 'pm string'.voidsetReverseSignForDisplay(boolean newValue)Sets the property 'use reverse sign for display'.voidsetReverseSignForDisplayFormula(FormulaField newFormula)Sets the formula for the property 'use reverse sign for display'.voidsetRounding(int newValue)Sets which digit to round the number to.voidsetRoundingFormula(FormulaField newFormula)Sets the formula which provides the digit to round the number to.voidsetRoundingMode(int newValue)Sets the rounding mode.voidsetRoundingModeFormula(FormulaField newFormula)Sets the formula for the property 'rounding mode'.voidsetSecondType(int newValue)Sets the value of the property 'second type'.voidsetSecondTypeFormula(FormulaField newFormula)Sets the formula for the property 'second type'.voidsetSuppressIfZero(boolean newValue)Sets the value of the property 'suppress if zero'.voidsetSuppressIfZeroFormula(FormulaField newFormula)Sets the formula for the property 'suppress if zero'.voidsetThousandsSeparatorSymbol(java.lang.String newValue)Sets the value of the property 'thousands separator symbol'.voidsetThousandsSeparatorSymbolFormula(FormulaField newFormula)Sets the formula for the property 'thousands separator symbol'.voidsetTimeBase(int newValue)Sets the value of the property 'time base'.voidsetTimeBaseFormula(FormulaField newFormula)Sets the formula for the property 'time base'.voidsetTimeFormatType(int systemDefaultTimeType)Sets the time format type to use for this element.voidsetTimeFormatTypeFormula(FormulaField newFormula)Sets the formula determining the time format type to use for this element.voidsetUseLeadingZero(boolean newValue)Sets the value of the property 'use leading zero'.voidsetUseLeadingZeroFormula(FormulaField newFormula)Sets the formula for the property 'use leading zero'.voidsetUseOneCurrencySymbolPerPage(boolean newValue)Sets the value of the property 'use one currency symbol per page'.voidsetUseOneCurrencySymbolPerPageFormula(FormulaField newFormula)Sets the formula for the property 'use one currency symbol per page'.voidsetUseThousandsSeparator(boolean newValue)Sets the value of the property 'use thousands separator'.voidsetUseThousandsSeparatorFormula(FormulaField newFormula)Sets the formula for the property 'use thousands separator'.voidsetYearType(int newValue)Sets the value of the property 'year type'.voidsetYearTypeFormula(FormulaField newFormula)Sets the formula for the property 'year type'.voidsetZeroValueString(java.lang.String newValue)Sets the value of the property 'zero value string'.-
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, copy, 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, paramString, parseText, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, 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, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, 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.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
-
-
-
Method Detail
-
getAmString
public final java.lang.String getAmString()
Returns the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.- Specified by:
getAmStringin interfaceValueProperties- Returns:
- The value of the property 'am string'.
- Since:
- 6.0
-
setAmString
public final void setAmString(java.lang.String newValue)
Sets the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.- Specified by:
setAmStringin interfaceValueProperties- Parameters:
newValue- The new value of the property 'am string'.- Since:
- 6.0
-
getAmStringFormula
public final FormulaField getAmStringFormula()
Returns the formula of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.- Specified by:
getAmStringFormulain interfaceValueProperties- Returns:
FormulaFieldif a formula for this property was defined elsenull.- Since:
- 6.0
-
setAmStringFormula
public final void setAmStringFormula(FormulaField newFormula)
Sets the formula for the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.- Specified by:
setAmStringFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'am string'.- Since:
- 6.0
-
getPmString
public final java.lang.String getPmString()
Returns the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.- Specified by:
getPmStringin interfaceValueProperties- Returns:
- The value of the property 'pm string'.
- Since:
- 6.0
-
setPmString
public final void setPmString(java.lang.String newValue)
Sets the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.- Specified by:
setPmStringin interfaceValueProperties- Parameters:
newValue- The new value of the property 'pm string'.- Since:
- 6.0
-
getPmStringFormula
public final FormulaField getPmStringFormula()
Returns the formula of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.- Specified by:
getPmStringFormulain interfaceValueProperties- Returns:
FormulaFieldif a formula for this property was defined elsenull.- Since:
- 6.0
-
setPmStringFormula
public final void setPmStringFormula(FormulaField newFormula)
Sets the formula for the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.- Specified by:
setPmStringFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'pm string'.- Since:
- 6.0
-
setTimeBase
public final void setTimeBase(int newValue)
Sets the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.- Specified by:
setTimeBasein interfaceValueProperties- Parameters:
newValue- The new value of the property 'time base'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TWELVE_HOURS,ValuePropertiesConstants.TWENTY_FOUR_HOURS
-
getTimeBase
public final int getTimeBase()
Returns the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.- Specified by:
getTimeBasein interfaceValueProperties- Returns:
- The value of the property 'time base'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TWELVE_HOURS,ValuePropertiesConstants.TWENTY_FOUR_HOURS
-
setTimeBaseFormula
public final void setTimeBaseFormula(FormulaField newFormula)
Sets the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.- Specified by:
setTimeBaseFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'time base'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TWELVE_HOURS,ValuePropertiesConstants.TWENTY_FOUR_HOURS
-
getTimeBaseFormula
public final FormulaField getTimeBaseFormula()
Returns the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.- Specified by:
getTimeBaseFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'time base'.- Since:
- 6.0
-
getAmPmOrder
public final int getAmPmOrder()
Returns the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.- Specified by:
getAmPmOrderin interfaceValueProperties- Returns:
- The current value of property.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.AM_PM_BEFORE,ValuePropertiesConstants.AM_PM_AFTER
-
setAmPmOrder
public final void setAmPmOrder(int newValue)
Sets the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.- Specified by:
setAmPmOrderin interfaceValueProperties- Parameters:
newValue- The new value for property.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.AM_PM_BEFORE,ValuePropertiesConstants.AM_PM_AFTER
-
getAmPmOrderFormula
public final FormulaField getAmPmOrderFormula()
returns the formula of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.- Specified by:
getAmPmOrderFormulain interfaceValueProperties- Returns:
FormulaFieldif a formula for this property was defined elsenull.- Since:
- 6.0
-
setAmPmOrderFormula
public final void setAmPmOrderFormula(FormulaField newFormula)
Sets the formula for the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.- Specified by:
setAmPmOrderFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'am pm order/type'. The result of the formula should either 0 or 1.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.AM_PM_BEFORE,ValuePropertiesConstants.AM_PM_AFTER
-
setHourType
public final void setHourType(int newValue)
Sets the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.- Specified by:
setHourTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'hour type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_HOUR,ValuePropertiesConstants.NUMERIC_HOUR,ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO
-
getHourType
public final int getHourType()
Returns the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.- Specified by:
getHourTypein interfaceValueProperties- Returns:
- The current value of the property 'hour type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_HOUR,ValuePropertiesConstants.NUMERIC_HOUR,ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO
-
setHourTypeFormula
public final void setHourTypeFormula(FormulaField newFormula)
Sets the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.- Specified by:
setHourTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'hour type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_HOUR,ValuePropertiesConstants.NUMERIC_HOUR,ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO
-
getHourTypeFormula
public final FormulaField getHourTypeFormula()
Returns the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.- Specified by:
getHourTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe current formula for the property 'hour type'.- Since:
- 6.0
-
setMinuteType
public final void setMinuteType(int newValue)
Sets the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.- Specified by:
setMinuteTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'minute type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO
-
getMinuteType
public final int getMinuteType()
Returns the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.- Specified by:
getMinuteTypein interfaceValueProperties- Returns:
- The current value of the property 'minute type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO
-
setMinuteTypeFormula
public final void setMinuteTypeFormula(FormulaField newFormula)
Sets the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.- Specified by:
setMinuteTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'minute type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE,ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO
-
getMinuteTypeFormula
public final FormulaField getMinuteTypeFormula()
Returns the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.- Specified by:
getMinuteTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'minute type'.- Since:
- 6.0
-
setSecondType
public final void setSecondType(int newValue)
Sets the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.- Specified by:
setSecondTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'second type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_NO_SECOND,ValuePropertiesConstants.NUMERIC_SECOND,ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO
-
getSecondType
public final int getSecondType()
Returns the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.- Specified by:
getSecondTypein interfaceValueProperties- Returns:
- The current value of the property 'second type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_NO_SECOND,ValuePropertiesConstants.NUMERIC_SECOND,ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO
-
setSecondTypeFormula
public final void setSecondTypeFormula(FormulaField newFormula)
Sets the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.- Specified by:
setSecondTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'second type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_NO_SECOND,ValuePropertiesConstants.NUMERIC_SECOND,ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO
-
getSecondTypeFormula
public final FormulaField getSecondTypeFormula()
Returns the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.- Specified by:
getSecondTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'second type'.- Since:
- 6.0
-
getHourMinuteSeparator
public final java.lang.String getHourMinuteSeparator()
Returns the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.- Specified by:
getHourMinuteSeparatorin interfaceValueProperties- Returns:
- The current value of the property 'hour minute sepereator'.
- Since:
- 6.1
-
setHourMinuteSeparator
public final void setHourMinuteSeparator(java.lang.String newValue)
Sets the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.- Specified by:
setHourMinuteSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'hour minute sepereator'.- Since:
- 6.1
-
setHourMinuteSeparatorFormula
public final void setHourMinuteSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.- Specified by:
setHourMinuteSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'hour minute sepereator'.- Since:
- 6.1
-
getHourMinuteSeparatorFormula
public final FormulaField getHourMinuteSeparatorFormula()
Returns the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.- Specified by:
getHourMinuteSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe current formula for the property 'hour minute sepereator'.- Since:
- 6.1
-
setMinuteSecondSeparator
public final void setMinuteSecondSeparator(java.lang.String newValue)
Sets the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.- Specified by:
setMinuteSecondSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'minute second separator'.- Since:
- 6.1
-
getMinuteSecondSeparator
public final java.lang.String getMinuteSecondSeparator()
Returns the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.- Specified by:
getMinuteSecondSeparatorin interfaceValueProperties- Returns:
- The current value of the property 'minute second separator'.
- Since:
- 6.1
-
setMinuteSecondSeparatorFormula
public final void setMinuteSecondSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.- Specified by:
setMinuteSecondSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'minute second separator'.- Since:
- 6.1
-
getMinuteSecondSeparatorFormula
public final FormulaField getMinuteSecondSeparatorFormula()
Returns the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.- Specified by:
getMinuteSecondSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'minute second separator'.- Since:
- 6.1
-
getDateFormatType
public final int getDateFormatType()
Returns the date format type set for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not have any effect.- Specified by:
getDateFormatTypein interfaceValueProperties- Returns:
- The date format type set for this element.
- See Also:
ValueProperties.USE_SYSTEM_LONG_DATE,ValueProperties.USE_SYSTEM_MEDIUM_DATE,ValueProperties.USE_SYSTEM_SHORT_DATE,ValueProperties.NOT_USING_SYSTEM_DEFAULTS
-
setDateFormatType
public final void setDateFormatType(int newValue)
Sets the date format type to use for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.- Specified by:
setDateFormatTypein interfaceValueProperties- Parameters:
newValue- The date format type set for this element- See Also:
ValueProperties.USE_SYSTEM_LONG_DATE,ValueProperties.USE_SYSTEM_MEDIUM_DATE,ValueProperties.USE_SYSTEM_SHORT_DATE,ValueProperties.NOT_USING_SYSTEM_DEFAULTS
-
getDateFormatTypeFormula
public final FormulaField getDateFormatTypeFormula()
Returns the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.- Specified by:
getDateFormatTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date format type'.
-
setDateFormatTypeFormula
public final void setDateFormatTypeFormula(FormulaField newFormula)
Sets the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.- Specified by:
setDateFormatTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date format type'. The result of the formula should be 0 (long), 1 (short), 2 (custom), or 3 (medium).- See Also:
ValueProperties.USE_SYSTEM_LONG_DATE,ValueProperties.USE_SYSTEM_MEDIUM_DATE,ValueProperties.USE_SYSTEM_SHORT_DATE,ValueProperties.NOT_USING_SYSTEM_DEFAULTS
-
getDateWindowsDefaultTypeFormula
@Deprecated public final FormulaField getDateWindowsDefaultTypeFormula()
Deprecated.As of i-net Crystal-Clear 8.0, usegetDateFormatTypeFormula()instead.FOR INTERNAL USE ONLY
-
setDateWindowsDefaultTypeFormula
@Deprecated public final void setDateWindowsDefaultTypeFormula(FormulaField newFormula)
Deprecated.As of i-net Crystal-Clear 8.0, usesetDateFormatTypeFormula(FormulaField)instead.FOR INTERNAL USE ONLY
-
getTimeFormatType
public int getTimeFormatType()
Returns the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.- Specified by:
getTimeFormatTypein interfaceValueProperties- Returns:
- the time format type set for this element.
- See Also:
ValueProperties.USE_SYSTEM_LONG_TIME,ValueProperties.USE_SYSTEM_MEDIUM_TIME,ValueProperties.USE_SYSTEM_SHORT_TIME,ValueProperties.USE_CUSTOM_FORMAT
-
setTimeFormatType
public void setTimeFormatType(int systemDefaultTimeType)
Sets the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.- Specified by:
setTimeFormatTypein interfaceValueProperties- Parameters:
systemDefaultTimeType- the time format type set for this element- See Also:
ValueProperties.USE_SYSTEM_LONG_TIME,ValueProperties.USE_SYSTEM_MEDIUM_TIME,ValueProperties.USE_SYSTEM_SHORT_TIME,ValueProperties.USE_CUSTOM_FORMAT
-
getTimeFormatTypeFormula
public FormulaField getTimeFormatTypeFormula()
Returns the formula determining the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.- Specified by:
getTimeFormatTypeFormulain interfaceValueProperties- Returns:
- the formula determining the time format type set for this element
-
setTimeFormatTypeFormula
public void setTimeFormatTypeFormula(FormulaField newFormula)
Sets the formula determining the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.- Specified by:
setTimeFormatTypeFormulain interfaceValueProperties- Parameters:
newFormula- the formula determining the time format type set for this element
-
getNumberFormatType
public int getNumberFormatType()
Returns the number format type set for this element. Use this property to specify whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.- Specified by:
getNumberFormatTypein interfaceValueProperties- Returns:
- The number format type set for this element.
- See Also:
ValueProperties.NUMBER_FORMAT_INTEGER,ValueProperties.NUMBER_FORMAT_FRACTIONAL,ValueProperties.NUMBER_FORMAT_PERCENT,ValueProperties.NUMBER_FORMAT_CURRENCY,ValueProperties.USE_CUSTOM_FORMAT
-
setNumberFormatType
public void setNumberFormatType(int newValue)
Sets the number format type to use for this element. Use this property to specify whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.- Specified by:
setNumberFormatTypein interfaceValueProperties- Parameters:
newValue- The number format type to set for this element- See Also:
ValueProperties.NUMBER_FORMAT_INTEGER,ValueProperties.NUMBER_FORMAT_FRACTIONAL,ValueProperties.NUMBER_FORMAT_PERCENT,ValueProperties.NUMBER_FORMAT_CURRENCY,ValueProperties.USE_CUSTOM_FORMAT
-
getNumberFormatTypeFormula
public FormulaField getNumberFormatTypeFormula()
Returns the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.- Specified by:
getNumberFormatTypeFormulain interfaceValueProperties- Returns:
- The formula field which returns the number format type to use for this element.
- See Also:
ValueProperties.NUMBER_FORMAT_INTEGER,ValueProperties.NUMBER_FORMAT_FRACTIONAL,ValueProperties.NUMBER_FORMAT_PERCENT,ValueProperties.NUMBER_FORMAT_CURRENCY,ValueProperties.USE_CUSTOM_FORMAT
-
setNumberFormatTypeFormula
public void setNumberFormatTypeFormula(FormulaField newFormula)
Sets the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.- Specified by:
setNumberFormatTypeFormulain interfaceValueProperties- Parameters:
newFormula- The formula field which returns the number format type to use for this element- See Also:
ValueProperties.NUMBER_FORMAT_INTEGER,ValueProperties.NUMBER_FORMAT_FRACTIONAL,ValueProperties.NUMBER_FORMAT_PERCENT,ValueProperties.NUMBER_FORMAT_CURRENCY,ValueProperties.USE_CUSTOM_FORMAT
-
getDateCalendarType
public final int getDateCalendarType()
Returns the value of the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
getDateCalendarTypein interfaceValueProperties- Returns:
- The value of the property 'date calendar type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.GREGORIAN_CALENDAR,ValuePropertiesConstants.GREGORIAN_US_CALENDAR,ValuePropertiesConstants.JAPANESE_CALENDAR,ValuePropertiesConstants.TAIWANESE_CALENDAR,ValuePropertiesConstants.KOREAN_CALENDAR,ValuePropertiesConstants.HIJRI_CALENDAR,ValuePropertiesConstants.THAI_CALENDAR
-
setDateCalendarType
public final void setDateCalendarType(int newValue)
Sets the value of the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
setDateCalendarTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'date calendar type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.GREGORIAN_CALENDAR,ValuePropertiesConstants.GREGORIAN_US_CALENDAR,ValuePropertiesConstants.JAPANESE_CALENDAR,ValuePropertiesConstants.TAIWANESE_CALENDAR,ValuePropertiesConstants.KOREAN_CALENDAR,ValuePropertiesConstants.HIJRI_CALENDAR,ValuePropertiesConstants.THAI_CALENDAR
-
getDateCalendarTypeFormula
public final FormulaField getDateCalendarTypeFormula()
Returns the formula of the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
getDateCalendarTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date calendar type'.- Since:
- 6.0
-
setDateCalendarTypeFormula
public final void setDateCalendarTypeFormula(FormulaField newFormula)
Sets the formula for the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
setDateCalendarTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula of the property 'date calendar type'. The result of the formula should be in range from 1 to 7.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.GREGORIAN_CALENDAR,ValuePropertiesConstants.GREGORIAN_US_CALENDAR,ValuePropertiesConstants.JAPANESE_CALENDAR,ValuePropertiesConstants.TAIWANESE_CALENDAR,ValuePropertiesConstants.KOREAN_CALENDAR,ValuePropertiesConstants.HIJRI_CALENDAR,ValuePropertiesConstants.THAI_CALENDAR
-
getDateEraType
public final int getDateEraType()
Returns the value of the property 'date era type'.- Specified by:
getDateEraTypein interfaceValueProperties- Returns:
- The value of the property 'date era type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_ERA,ValuePropertiesConstants.LONG_ERA,ValuePropertiesConstants.NO_ERA
-
setDateEraType
public final void setDateEraType(int newValue)
Sets the value of the property 'date era type'.- Specified by:
setDateEraTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'date era type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_ERA,ValuePropertiesConstants.LONG_ERA,ValuePropertiesConstants.NO_ERA
-
getDateEraTypeFormula
public final FormulaField getDateEraTypeFormula()
Returns the formula of the property 'date era type'.- Specified by:
getDateEraTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'date era type'.- Since:
- 6.0
-
setDateEraTypeFormula
public final void setDateEraTypeFormula(FormulaField newFormula)
Sets the formula for the property 'date era type'.- Specified by:
setDateEraTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date era type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_ERA,ValuePropertiesConstants.LONG_ERA,ValuePropertiesConstants.NO_ERA
-
getDayType
public final int getDayType()
Returns the value of the property 'day type'. Use this property to specify the day representation of a custom date format.- Specified by:
getDayTypein interfaceValueProperties- Returns:
- The value of the property 'day type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_DAY,ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY,ValuePropertiesConstants.NO_DAY
-
setDayType
public final void setDayType(int newValue)
Sets the value of the property 'day type'. Use this property to specify the day representation of a custom date format.- Specified by:
setDayTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'day type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_DAY,ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY,ValuePropertiesConstants.NO_DAY
-
getDayTypeFormula
public final FormulaField getDayTypeFormula()
Returns the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.- Specified by:
getDayTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'day type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_DAY,ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY,ValuePropertiesConstants.NO_DAY
-
setDayTypeFormula
public final void setDayTypeFormula(FormulaField newFormula)
Sets the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.- Specified by:
setDayTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'day type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NUMERIC_DAY,ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY,ValuePropertiesConstants.NO_DAY
-
setMonthType
public final void setMonthType(int newValue)
Sets the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.- Specified by:
setMonthTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'month type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH,ValuePropertiesConstants.LONG_MONTH,ValuePropertiesConstants.NO_MONTH,ValuePropertiesConstants.NUMERIC_MONTH,ValuePropertiesConstants.SHORT_MONTH
-
getMonthType
public final int getMonthType()
Returns the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.- Specified by:
getMonthTypein interfaceValueProperties- Returns:
- The current value of the property 'month type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH,ValuePropertiesConstants.LONG_MONTH,ValuePropertiesConstants.NO_MONTH,ValuePropertiesConstants.NUMERIC_MONTH,ValuePropertiesConstants.SHORT_MONTH
-
setMonthTypeFormula
public final void setMonthTypeFormula(FormulaField newFormula)
Sets the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.- Specified by:
setMonthTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'month type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH,ValuePropertiesConstants.LONG_MONTH,ValuePropertiesConstants.NO_MONTH,ValuePropertiesConstants.NUMERIC_MONTH,ValuePropertiesConstants.SHORT_MONTH
-
getMonthTypeFormula
public final FormulaField getMonthTypeFormula()
Returns the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.- Specified by:
getMonthTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'month type'.- Since:
- 6.0
-
setYearType
public final void setYearType(int newValue)
Sets the value of the property 'year type'. Use this property to specify the year representation of a custom date format.- Specified by:
setYearTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'year type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_YEAR,ValuePropertiesConstants.LONG_YEAR,ValuePropertiesConstants.NO_YEAR
-
getYearType
public final int getYearType()
Returns the value of the property 'year type'. Use this property to specify the year representation of a custom date format.- Specified by:
getYearTypein interfaceValueProperties- Returns:
- The value of the property 'year type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_YEAR,ValuePropertiesConstants.LONG_YEAR,ValuePropertiesConstants.NO_YEAR
-
setYearTypeFormula
public final void setYearTypeFormula(FormulaField newFormula)
Sets the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.- Specified by:
setYearTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'year type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_YEAR,ValuePropertiesConstants.LONG_YEAR,ValuePropertiesConstants.NO_YEAR
-
getYearTypeFormula
public final FormulaField getYearTypeFormula()
Returns the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.- Specified by:
getYearTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'year type'.- Since:
- 6.0
-
getDayOfWeekPosition
public final int getDayOfWeekPosition()
Returns the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.- Specified by:
getDayOfWeekPositionin interfaceValueProperties- Returns:
- The value of the property 'day of week position'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_DAY_OF_WEEK,ValuePropertiesConstants.TRAILING_DAY_OF_WEEK
-
setDayOfWeekPosition
public final void setDayOfWeekPosition(int newValue)
Sets the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.- Specified by:
setDayOfWeekPositionin interfaceValueProperties- Parameters:
newValue- The new value of the property 'day of week position'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_DAY_OF_WEEK,ValuePropertiesConstants.TRAILING_DAY_OF_WEEK
-
getDayOfWeekPositionFormula
public final FormulaField getDayOfWeekPositionFormula()
Returns the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.- Specified by:
getDayOfWeekPositionFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'day of week position'.- Since:
- 6.0
-
setDayOfWeekPositionFormula
public final void setDayOfWeekPositionFormula(FormulaField newFormula)
Sets the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.- Specified by:
setDayOfWeekPositionFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'day of week position'. The result of the formula should be in range from 0 to 1.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_DAY_OF_WEEK,ValuePropertiesConstants.TRAILING_DAY_OF_WEEK
-
getDayOfWeekEnclosure
public final int getDayOfWeekEnclosure()
Returns the value of the property 'day of week enclosure'.- Specified by:
getDayOfWeekEnclosurein interfaceValueProperties- Returns:
- The current value of the property 'day of week enclosure'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_SQUARED
-
setDayOfWeekEnclosure
public final void setDayOfWeekEnclosure(int newValue)
Sets the value of the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.- Specified by:
setDayOfWeekEnclosurein interfaceValueProperties- Parameters:
newValue- The value of the property 'day of week enclosure'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE,ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_SQUARED
-
getDayOfWeekEnclosureFormula
public final FormulaField getDayOfWeekEnclosureFormula()
Returns the formula for the property 'day of week enclosure'.- Specified by:
getDayOfWeekEnclosureFormulain interfaceValueProperties- Returns:
- The formula for the property 'day of week enclosure'.
- Since:
- 6.0
-
setDayOfWeekEnclosureFormula
public final void setDayOfWeekEnclosureFormula(FormulaField newFormula)
Sets the formula for the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.- Specified by:
setDayOfWeekEnclosureFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'week day enclosure'.- Since:
- 6.0
-
setDayOfWeekSeparator
public final void setDayOfWeekSeparator(java.lang.String newValue)
Sets the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.- Specified by:
setDayOfWeekSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'day of week separator'.- Since:
- 6.1
-
getDayOfWeekSeparator
public final java.lang.String getDayOfWeekSeparator()
Returns the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.- Specified by:
getDayOfWeekSeparatorin interfaceValueProperties- Returns:
- The current value of the property 'day of week separator'.
- Since:
- 6.1
-
setDayOfWeekSeparatorFormula
public final void setDayOfWeekSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.- Specified by:
setDayOfWeekSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'day of week separator'.- Since:
- 6.1
-
getDayOfWeekSeparatorFormula
public final FormulaField getDayOfWeekSeparatorFormula()
Returns the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.- Specified by:
getDayOfWeekSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'day of week separator'.- Since:
- 6.1
-
getDayOfWeekType
public final int getDayOfWeekType()
Returns the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.- Specified by:
getDayOfWeekTypein interfaceValueProperties- Returns:
- The value of the property 'day of week type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_DAY_OF_WEEK,ValuePropertiesConstants.LONG_DAY_OF_WEEK,ValuePropertiesConstants.NO_DAY_OF_WEEK
-
setDayOfWeekType
public final void setDayOfWeekType(int newValue)
Sets the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.- Specified by:
setDayOfWeekTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'day of week type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_DAY_OF_WEEK,ValuePropertiesConstants.LONG_DAY_OF_WEEK,ValuePropertiesConstants.NO_DAY_OF_WEEK
-
getDayOfWeekTypeFormula
public final FormulaField getDayOfWeekTypeFormula()
Returns the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.- Specified by:
getDayOfWeekTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'day of week type'.- Since:
- 6.0
-
setDayOfWeekTypeFormula
public final void setDayOfWeekTypeFormula(FormulaField newFormula)
Sets the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.- Specified by:
setDayOfWeekTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'day of week type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.SHORT_DAY_OF_WEEK,ValuePropertiesConstants.LONG_DAY_OF_WEEK,ValuePropertiesConstants.NO_DAY_OF_WEEK
-
getDateOrder
public final int getDateOrder()
Returns the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.- Specified by:
getDateOrderin interfaceValueProperties- Returns:
- The value of the property 'date order'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.YEAR_MONTH_DAY,ValuePropertiesConstants.DAY_MONTH_YEAR,ValuePropertiesConstants.MONTH_DAY_YEAR
-
setDateOrder
public final void setDateOrder(int newValue)
Sets the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.- Specified by:
setDateOrderin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date order'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.YEAR_MONTH_DAY,ValuePropertiesConstants.DAY_MONTH_YEAR,ValuePropertiesConstants.MONTH_DAY_YEAR
-
getDateOrderFormula
public final FormulaField getDateOrderFormula()
Returns the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.- Specified by:
getDateOrderFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date order'.- Since:
- 6.0
-
setDateOrderFormula
public final void setDateOrderFormula(FormulaField newFormula)
Sets the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.- Specified by:
setDateOrderFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date order'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.YEAR_MONTH_DAY,ValuePropertiesConstants.DAY_MONTH_YEAR,ValuePropertiesConstants.MONTH_DAY_YEAR
-
getDatePrefixSeparator
public final java.lang.String getDatePrefixSeparator()
Returns the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.- Specified by:
getDatePrefixSeparatorin interfaceValueProperties- Returns:
- The value of the property 'date prefix separator'.
- Since:
- 6.1
-
setDatePrefixSeparator
public final void setDatePrefixSeparator(java.lang.String newValue)
Sets the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.- Specified by:
setDatePrefixSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date prefix separator'.- Since:
- 6.1
-
getDatePrefixSeparatorFormula
public final FormulaField getDatePrefixSeparatorFormula()
Returns the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.- Specified by:
getDatePrefixSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date prefix separator'.- Since:
- 6.1
-
setDatePrefixSeparatorFormula
public final void setDatePrefixSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.- Specified by:
setDatePrefixSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date prefix separator'.- Since:
- 6.1
-
getDateFirstSeparator
public final java.lang.String getDateFirstSeparator()
Returns the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.- Specified by:
getDateFirstSeparatorin interfaceValueProperties- Returns:
- The value of the property 'date firts separator'.
- Since:
- 6.1
-
setDateFirstSeparator
public final void setDateFirstSeparator(java.lang.String newValue)
Sets the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.- Specified by:
setDateFirstSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date first separator'.- Since:
- 6.1
-
getDateFirstSeparatorFormula
public final FormulaField getDateFirstSeparatorFormula()
Returns the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.- Specified by:
getDateFirstSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'date first separator'.- Since:
- 6.1
-
setDateFirstSeparatorFormula
public final void setDateFirstSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.- Specified by:
setDateFirstSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date first separator'.- Since:
- 6.1
-
getDateSecondSeparator
public final java.lang.String getDateSecondSeparator()
Returns the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.- Specified by:
getDateSecondSeparatorin interfaceValueProperties- Returns:
- The value of the property 'date second separator'.
- Since:
- 6.1
-
setDateSecondSeparator
public final void setDateSecondSeparator(java.lang.String newValue)
Sets the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.- Specified by:
setDateSecondSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date second separator'.- Since:
- 6.1
-
getDateSecondSeparatorFormula
public final FormulaField getDateSecondSeparatorFormula()
Returns the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.- Specified by:
getDateSecondSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date second separator'.- Since:
- 6.1
-
setDateSecondSeparatorFormula
public final void setDateSecondSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.- Specified by:
setDateSecondSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date second separator'.- Since:
- 6.1
-
getDateSuffixSeparator
public final java.lang.String getDateSuffixSeparator()
Returns the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.- Specified by:
getDateSuffixSeparatorin interfaceValueProperties- Returns:
- The value of the property 'date suffix separator'.
- Since:
- 6.1
-
setDateSuffixSeparator
public final void setDateSuffixSeparator(java.lang.String newValue)
Sets the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.- Specified by:
setDateSuffixSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date suffix separator'.- Since:
- 6.1
-
getDateSuffixSeparatorFormula
public final FormulaField getDateSuffixSeparatorFormula()
Returns the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.- Specified by:
getDateSuffixSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'date suffix separator'.- Since:
- 6.1
-
setDateSuffixSeparatorFormula
public final void setDateSuffixSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.- Specified by:
setDateSuffixSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date suffix separator'.- Since:
- 6.1
-
setDateTimeOrder
public final void setDateTimeOrder(int newValue)
Sets the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.- Specified by:
setDateTimeOrderin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date time order'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DATE_TIME_ORDER,ValuePropertiesConstants.TIME_DATE_ORDER,ValuePropertiesConstants.DATE_ONLY_ORDER,ValuePropertiesConstants.TIME_ONLY_ORDER
-
getDateTimeOrder
public final int getDateTimeOrder()
Returns the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.- Specified by:
getDateTimeOrderin interfaceValueProperties- Returns:
- The value of the property 'date time order'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DATE_TIME_ORDER,ValuePropertiesConstants.TIME_DATE_ORDER,ValuePropertiesConstants.DATE_ONLY_ORDER,ValuePropertiesConstants.TIME_ONLY_ORDER
-
setDateTimeOrderFormula
public final void setDateTimeOrderFormula(FormulaField newFormula)
Sets the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.- Specified by:
setDateTimeOrderFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date time order'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DATE_TIME_ORDER,ValuePropertiesConstants.TIME_DATE_ORDER,ValuePropertiesConstants.DATE_ONLY_ORDER,ValuePropertiesConstants.TIME_ONLY_ORDER
-
getDateTimeOrderFormula
public final FormulaField getDateTimeOrderFormula()
Returns the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.- Specified by:
getDateTimeOrderFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'date time order'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.DATE_TIME_ORDER,ValuePropertiesConstants.TIME_DATE_ORDER,ValuePropertiesConstants.DATE_ONLY_ORDER,ValuePropertiesConstants.TIME_ONLY_ORDER
-
setDateTimeSeparator
public final void setDateTimeSeparator(java.lang.String newValue)
Sets the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.- Specified by:
setDateTimeSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'date time separator'.- Since:
- 6.1
-
getDateTimeSeparator
public final java.lang.String getDateTimeSeparator()
Returns the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.- Specified by:
getDateTimeSeparatorin interfaceValueProperties- Returns:
- The value of the property 'date time separator'.
- Since:
- 6.1
-
setDateTimeSeparatorFormula
public final void setDateTimeSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.- Specified by:
setDateTimeSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'date time separator'.- Since:
- 6.1
-
getDateTimeSeparatorFormula
public final FormulaField getDateTimeSeparatorFormula()
Returns the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.- Specified by:
getDateTimeSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'date time separator'.- Since:
- 6.1
-
getBooleanFormatOutputType
public final int getBooleanFormatOutputType()
Returns the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.- Specified by:
getBooleanFormatOutputTypein interfaceValueProperties- Returns:
- The value of the property 'boolean format output type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TRUE_OR_FALSE,ValuePropertiesConstants.T_OR_F,ValuePropertiesConstants.YES_OR_NO,ValuePropertiesConstants.Y_OR_N,ValuePropertiesConstants.ONE_OR_ZERO
-
setBooleanFormatOutputType
public final void setBooleanFormatOutputType(int newValue)
Sets the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.- Specified by:
setBooleanFormatOutputTypein interfaceValueProperties- Parameters:
newValue- The new value for the property 'boolean format output type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TRUE_OR_FALSE,ValuePropertiesConstants.T_OR_F,ValuePropertiesConstants.YES_OR_NO,ValuePropertiesConstants.Y_OR_N,ValuePropertiesConstants.ONE_OR_ZERO
-
setBooleanFormatOutputTypeFormula
public final void setBooleanFormatOutputTypeFormula(FormulaField newFormula)
Sets the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.- Specified by:
setBooleanFormatOutputTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'boolean format output type'. The result of the formula should be in range from 0 to 4.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.TRUE_OR_FALSE,ValuePropertiesConstants.T_OR_F,ValuePropertiesConstants.YES_OR_NO,ValuePropertiesConstants.Y_OR_N,ValuePropertiesConstants.ONE_OR_ZERO
-
getBooleanFormatOutputTypeFormula
public final FormulaField getBooleanFormatOutputTypeFormula()
Returns the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or false.- Specified by:
getBooleanFormatOutputTypeFormulain interfaceValueProperties- Returns:
- FormulaField The formula for the property 'boolean format output type'.
-
getCurrencyPosition
public int getCurrencyPosition()
Returns the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.- Specified by:
getCurrencyPositionin interfaceValueProperties- Returns:
- The value of the property 'currency position type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE
-
setCurrencyPosition
public final void setCurrencyPosition(int newValue)
Sets the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency outside negative.- Specified by:
setCurrencyPositionin interfaceValueProperties- Parameters:
newValue- The new value of the property 'currency position type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE
-
getCurrencyPositionFormula
public final FormulaField getCurrencyPositionFormula()
Returns the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.- Specified by:
getCurrencyPositionFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'currency position type'.- Since:
- 6.0
-
setCurrencyPositionFormula
public final void setCurrencyPositionFormula(FormulaField newFormula)
Sets the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.- Specified by:
setCurrencyPositionFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'currency position type', where the result of the formula should be in range 0 to 3.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE,ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE
-
setCurrencySymbol
public void setCurrencySymbol(java.lang.String newValue)
Sets the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.- Specified by:
setCurrencySymbolin interfaceValueProperties- Parameters:
newValue- The new value of the property 'currency symbol'.- Since:
- 6.0
-
getCurrencySymbol
public java.lang.String getCurrencySymbol()
Returns the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.- Specified by:
getCurrencySymbolin interfaceValueProperties- Returns:
- The value of the property 'currency symbol'.
- Since:
- 6.0
-
setCurrencySymbolFormula
public final void setCurrencySymbolFormula(FormulaField newFormula)
Sets the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.- Specified by:
setCurrencySymbolFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'currency symbol'.- Since:
- 6.0
-
getCurrencySymbolFormula
public final FormulaField getCurrencySymbolFormula()
Returns the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.- Specified by:
getCurrencySymbolFormulain interfaceValueProperties- Returns:
- Formula field for the property "currency symbol"
- Since:
- 6.0
-
setCurrencySymbolType
public void setCurrencySymbolType(int newValue)
Sets the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.- Specified by:
setCurrencySymbolTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'currency symbol type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_SYMBOL,ValuePropertiesConstants.FIXED_SYMBOL,ValuePropertiesConstants.FLOATING_SYMBOL
-
getCurrencySymbolType
public int getCurrencySymbolType()
Returns the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.- Specified by:
getCurrencySymbolTypein interfaceValueProperties- Returns:
- The value of the property 'currency symbol type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_SYMBOL,ValuePropertiesConstants.FIXED_SYMBOL,ValuePropertiesConstants.FLOATING_SYMBOL
-
setCurrencySymbolTypeFormula
public final void setCurrencySymbolTypeFormula(FormulaField newFormula)
Sets the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.- Specified by:
setCurrencySymbolTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'currency symbol type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NO_SYMBOL,ValuePropertiesConstants.FIXED_SYMBOL,ValuePropertiesConstants.FLOATING_SYMBOL
-
getCurrencySymbolTypeFormula
public FormulaField getCurrencySymbolTypeFormula()
Returns the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.- Specified by:
getCurrencySymbolTypeFormulain interfaceValueProperties- Returns:
- Formula Field for the property "currency symbol type"
- Since:
- 6.0
-
setUseOneCurrencySymbolPerPage
public final void setUseOneCurrencySymbolPerPage(boolean newValue)
Sets the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.- Specified by:
setUseOneCurrencySymbolPerPagein interfaceValueProperties- Parameters:
newValue- The new value of the property 'use one currency symbol per page'.- Since:
- 6.0
-
getUseOneCurrencySymbolPerPage
public final boolean getUseOneCurrencySymbolPerPage()
Returns the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.- Specified by:
getUseOneCurrencySymbolPerPagein interfaceValueProperties- Returns:
- The value of the property 'use one currency symbol per page'.
- Since:
- 6.0
-
setUseOneCurrencySymbolPerPageFormula
public final void setUseOneCurrencySymbolPerPageFormula(FormulaField newFormula)
Sets the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.- Specified by:
setUseOneCurrencySymbolPerPageFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'use one currency symbol per page'.- Since:
- 6.0
-
getUseOneCurrencySymbolPerPageFormula
public final FormulaField getUseOneCurrencySymbolPerPageFormula()
Returns the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.- Specified by:
getUseOneCurrencySymbolPerPageFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'use one currency symbol per page'.- Since:
- 6.0
-
getNDecimalPlaces
public final int getNDecimalPlaces()
Returns the value of the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.- Specified by:
getNDecimalPlacesin interfaceValueProperties- Returns:
- The value of the property 'n decimal places'.
- See Also:
ValueProperties.getRounding(),ValueProperties.setNumberFormatType(int)
-
setNDecimalPlaces
public final void setNDecimalPlaces(int newValue)
Sets the value of the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.- Specified by:
setNDecimalPlacesin interfaceValueProperties- Parameters:
newValue- The new value of the property 'n decimal places'.- See Also:
ValueProperties.getRounding(),ValueProperties.setNumberFormatType(int)
-
getNDecimalPlacesFormula
public final FormulaField getNDecimalPlacesFormula()
Returns the formula for the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.- Specified by:
getNDecimalPlacesFormulain interfaceValueProperties- Returns:
- FormulaField The formula of the property 'n decimal places'.
- See Also:
ValueProperties.setNumberFormatType(int)
-
setNDecimalPlacesFormula
public final void setNDecimalPlacesFormula(FormulaField newFormula)
Sets the formula for the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.- Specified by:
setNDecimalPlacesFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'n decimal places'.- See Also:
ValueProperties.setNumberFormatType(int)
-
getDecimalSeparatorSymbol
public final java.lang.String getDecimalSeparatorSymbol()
Returns the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.- Specified by:
getDecimalSeparatorSymbolin interfaceValueProperties- Returns:
- The value of the property 'decimal separators symbol'.
- Since:
- 6.1
-
setDecimalSeparatorSymbol
public final void setDecimalSeparatorSymbol(java.lang.String newValue)
Sets the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.- Specified by:
setDecimalSeparatorSymbolin interfaceValueProperties- Parameters:
newValue- The new value of the property 'decimal separators symbol'.- Since:
- 6.1
-
getDecimalSeparatorSymbolFormula
public final FormulaField getDecimalSeparatorSymbolFormula()
Returns the formula for the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.- Specified by:
getDecimalSeparatorSymbolFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'decimal separators symbol'.- Since:
- 6.1
-
setDecimalSeparatorSymbolFormula
public final void setDecimalSeparatorSymbolFormula(FormulaField newFormula)
Sets the formula for the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.- Specified by:
setDecimalSeparatorSymbolFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'decimal separators symbol'.- Since:
- 6.1
-
setReverseSignForDisplay
public final void setReverseSignForDisplay(boolean newValue)
Sets the property 'use reverse sign for display'.- Specified by:
setReverseSignForDisplayin interfaceValueProperties- Parameters:
newValue- New value for the property 'use reverse sign for display'.
-
isReverseSignForDisplay
public final boolean isReverseSignForDisplay()
Checks the property 'use reverse sign for display'- Specified by:
isReverseSignForDisplayin interfaceValueProperties- Returns:
- Whether the property 'use reverse sign for display' is on or off.
- Since:
- 7.0
-
getReverseSignForDisplayFormula
public final FormulaField getReverseSignForDisplayFormula()
Returns the formula for the property 'use reverse sign for display'.- Specified by:
getReverseSignForDisplayFormulain interfaceValueProperties- Returns:
- FormulaField The formula of the property 'use reverse sign for display'.
-
setReverseSignForDisplayFormula
public final void setReverseSignForDisplayFormula(FormulaField newFormula)
Sets the formula for the property 'use reverse sign for display'.- Specified by:
setReverseSignForDisplayFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'use reverse sign for display'.
-
setSuppressIfZero
public final void setSuppressIfZero(boolean newValue)
Sets the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.- Specified by:
setSuppressIfZeroin interfaceValueProperties- Parameters:
newValue- The new value of the property 'suppress if zero'.- Since:
- 6.0
-
getSuppressIfZero
public final boolean getSuppressIfZero()
Returns the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.- Specified by:
getSuppressIfZeroin interfaceValueProperties- Returns:
- The value of the property 'suppress if zero'.
- Since:
- 6.0
-
setSuppressIfZeroFormula
public final void setSuppressIfZeroFormula(FormulaField newFormula)
Sets the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.- Specified by:
setSuppressIfZeroFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'suppress if zero'.- Since:
- 6.0
-
getSuppressIfZeroFormula
public final FormulaField getSuppressIfZeroFormula()
Returns the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.- Specified by:
getSuppressIfZeroFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'suppress if zero'.- Since:
- 6.0
-
setUseThousandsSeparator
public final void setUseThousandsSeparator(boolean newValue)
Sets the value of the property 'use thousands separator'. When this property is enabled a sepearator sysmbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.- Specified by:
setUseThousandsSeparatorin interfaceValueProperties- Parameters:
newValue- The new value of the property 'use thousands separator'.- Since:
- 6.1
-
getUseThousandsSeparator
public final boolean getUseThousandsSeparator()
Returns the value of the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.- Specified by:
getUseThousandsSeparatorin interfaceValueProperties- Returns:
- The value of the property 'use thousands separator'.
- Since:
- 6.1
-
setUseThousandsSeparatorFormula
public final void setUseThousandsSeparatorFormula(FormulaField newFormula)
Sets the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.- Specified by:
setUseThousandsSeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'use thousands separator'.- Since:
- 6.1
-
getUseThousandsSeparatorFormula
public final FormulaField getUseThousandsSeparatorFormula()
Returns the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.- Specified by:
getUseThousandsSeparatorFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'use thousands separator'.- Since:
- 6.1
-
setThousandsSeparatorSymbol
public final void setThousandsSeparatorSymbol(java.lang.String newValue)
Sets the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.- Specified by:
setThousandsSeparatorSymbolin interfaceValueProperties- Parameters:
newValue- The new value of the property 'thousands separator symbol'.- Since:
- 6.1
-
getThousandsSeparatorSymbol
public final java.lang.String getThousandsSeparatorSymbol()
Returns the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.- Specified by:
getThousandsSeparatorSymbolin interfaceValueProperties- Returns:
- The value of the property 'thousands separator symbol'.
- Since:
- 6.1
-
setThousandsSeparatorSymbolFormula
public final void setThousandsSeparatorSymbolFormula(FormulaField newFormula)
Sets the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.- Specified by:
setThousandsSeparatorSymbolFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'thousands separator symbol'.- Since:
- 6.1
-
getThousandsSeparatorSymbolFormula
public final FormulaField getThousandsSeparatorSymbolFormula()
Returns the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.- Specified by:
getThousandsSeparatorSymbolFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'thousands separator symbol'.- Since:
- 6.1
-
setRounding
public void setRounding(int newValue)
Sets which digit to round the number to. In order to round after the decimal point, use negative numbers. Otherwise use positive numbers. Examples would be "-6" for rounding to millionth, "2" for rounding to hundreds, "0" for rounding to whole numbers.- Specified by:
setRoundingin interfaceValueProperties- Parameters:
newValue- position of digit to round to: negative numbers for after the decimal point, positive for before
-
getRounding
public int getRounding()
Returns which digit to round the number to. Examples would be "-6" for rounding to millionth, "2" for rounding to hundreds, "0" for rounding to whole numbers.- Specified by:
getRoundingin interfaceValueProperties- Returns:
- digits position of digit to round to: negative numbers for after the decimal point, positive for before
-
setRoundingFormula
public void setRoundingFormula(FormulaField newFormula)
Sets the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.- Specified by:
setRoundingFormulain interfaceValueProperties- Parameters:
newFormula- formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
-
getRoundingFormula
public FormulaField getRoundingFormula()
Returns the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.- Specified by:
getRoundingFormulain interfaceValueProperties- Returns:
- The formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
-
setRoundingMode
public final void setRoundingMode(int newValue)
Sets the rounding mode. The default mode is ROUND_HALF_EVEN. This property has only an effect if 'use system default' is disabled.- Specified by:
setRoundingModein interfaceValueProperties- Parameters:
newValue- the rounding mode to be used for rounding numbers.- See Also:
ValueProperties.ROUND_CEILING,ValueProperties.ROUND_DOWN,ValueProperties.ROUND_FLOOR,ValueProperties.ROUND_HALF_DOWN,ValueProperties.ROUND_HALF_EVEN,ValueProperties.ROUND_HALF_UP,ValueProperties.ROUND_UP,ValueProperties.getRoundingMode(),ValueProperties.setRoundingModeFormula(com.inet.report.FormulaField)
-
getRoundingMode
public final int getRoundingMode()
Returns the rounding mode for this element.- Specified by:
getRoundingModein interfaceValueProperties- Returns:
- the current rounding mode
- See Also:
ValueProperties.ROUND_CEILING,ValueProperties.ROUND_DOWN,ValueProperties.ROUND_FLOOR,ValueProperties.ROUND_HALF_DOWN,ValueProperties.ROUND_HALF_EVEN,ValueProperties.ROUND_HALF_UP,ValueProperties.ROUND_UP,ValueProperties.setRoundingMode(int)
-
setRoundingModeFormula
public final void setRoundingModeFormula(FormulaField newFormula)
Sets the formula for the property 'rounding mode'. When property 'use system default' is disabled, you can set the rounding algorithm.- Specified by:
setRoundingModeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'rounding type'. The result of the formula should be in range from 0 to 7.- See Also:
ValueProperties.ROUND_CEILING,ValueProperties.ROUND_DOWN,ValueProperties.ROUND_FLOOR,ValueProperties.ROUND_HALF_DOWN,ValueProperties.ROUND_HALF_EVEN,ValueProperties.ROUND_HALF_UP,ValueProperties.ROUND_UP,ValueProperties.setRoundingMode(int)
-
getRoundingModeFormula
public final FormulaField getRoundingModeFormula()
Returns the formula for the rounding mode, can be null if the formula is not set.- Specified by:
getRoundingModeFormulain interfaceValueProperties- Returns:
- the formula or null if not set.
- See Also:
ValueProperties.setRoundingModeFormula(com.inet.report.FormulaField)
-
setNegativeType
public void setNegativeType(int newValue)
Sets the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.- Specified by:
setNegativeTypein interfaceValueProperties- Parameters:
newValue- The new value of the property 'negative type'.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NOT_NEGATIVE,ValuePropertiesConstants.LEADING_MINUS,ValuePropertiesConstants.TRAILING_MINUS,ValuePropertiesConstants.BRACKETED
-
getNegativeType
public int getNegativeType()
Returns the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.- Specified by:
getNegativeTypein interfaceValueProperties- Returns:
- The current value of the property 'negative type'.
- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NOT_NEGATIVE,ValuePropertiesConstants.LEADING_MINUS,ValuePropertiesConstants.TRAILING_MINUS,ValuePropertiesConstants.BRACKETED
-
setNegativeTypeFormula
public void setNegativeTypeFormula(FormulaField newFormula)
Sets the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.- Specified by:
setNegativeTypeFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'negative type'. The result of the formula should be in range from 0 to 3.- Since:
- 6.0
- See Also:
ValuePropertiesConstants.NOT_NEGATIVE,ValuePropertiesConstants.LEADING_MINUS,ValuePropertiesConstants.TRAILING_MINUS,ValuePropertiesConstants.BRACKETED
-
getNegativeTypeFormula
public FormulaField getNegativeTypeFormula()
Returns the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.- Specified by:
getNegativeTypeFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'negative type'.- Since:
- 6.0
-
setUseLeadingZero
public final void setUseLeadingZero(boolean newValue)
Sets the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).- Specified by:
setUseLeadingZeroin interfaceValueProperties- Parameters:
newValue- The new value of the property 'use leading zero'.- Since:
- 6.0
-
getUseLeadingZero
public final boolean getUseLeadingZero()
Returns the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).- Specified by:
getUseLeadingZeroin interfaceValueProperties- Returns:
- The value of the property 'use leading zero'.
- Since:
- 6.0
-
setUseLeadingZeroFormula
public final void setUseLeadingZeroFormula(FormulaField newFormula)
Sets the formula for the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).- Specified by:
setUseLeadingZeroFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'use leading zero'.- Since:
- 6.0
-
getUseLeadingZeroFormula
public final FormulaField getUseLeadingZeroFormula()
Returns the formula for the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).- Specified by:
getUseLeadingZeroFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula for the property 'use leading zero'.- Since:
- 6.0
-
setZeroValueString
public final void setZeroValueString(java.lang.String newValue)
Sets the value of the property 'zero value string'. If the value isnullthen there will be no custom zero value.- Specified by:
setZeroValueStringin interfaceValueProperties- Parameters:
newValue- The new value of the property 'zero value string'.- Since:
- 6.0
-
getZeroValueString
public final java.lang.String getZeroValueString()
Returns the value of the property 'zero value string'.- Specified by:
getZeroValueStringin interfaceValueProperties- Returns:
- The value of the property 'zero value string'.
- Since:
- 6.0
-
setNumeralLanguage
public final void setNumeralLanguage(int language)
Sets the language of the numerals in number, date, time or datetime values.- Specified by:
setNumeralLanguagein interfaceValueProperties- Parameters:
language- one of the language constant values or -1 for the default of the current report and locale.- See Also:
Engine.setLocale(java.util.Locale),Engine.setNumeralLanguage(int),ValueProperties.getNumeralLanguage(),ValueProperties.NUMERAL_LANGUAGE_EUROPEAN,ValueProperties.NUMERAL_LANGUAGE_ARABIC,ValueProperties.NUMERAL_LANGUAGE_EASTERN_ARABIC,ValueProperties.NUMERAL_LANGUAGE_DEVANAGARI,ValueProperties.NUMERAL_LANGUAGE_BENGALI,ValueProperties.NUMERAL_LANGUAGE_GURMUKHI,ValueProperties.NUMERAL_LANGUAGE_GUJARATI,ValueProperties.NUMERAL_LANGUAGE_ORIYA,ValueProperties.NUMERAL_LANGUAGE_TAMIL,ValueProperties.NUMERAL_LANGUAGE_TELUGU,ValueProperties.NUMERAL_LANGUAGE_KANNADA,ValueProperties.NUMERAL_LANGUAGE_MALAYALAM,ValueProperties.NUMERAL_LANGUAGE_THAI,ValueProperties.NUMERAL_LANGUAGE_LAO,ValueProperties.NUMERAL_LANGUAGE_TIBETAN,ValueProperties.NUMERAL_LANGUAGE_MYANMAR,ValueProperties.NUMERAL_LANGUAGE_ETHIOPIC,ValueProperties.NUMERAL_LANGUAGE_KHMER,ValueProperties.NUMERAL_LANGUAGE_MONGOLIAN
-
getNumeralLanguage
public final int getNumeralLanguage()
Returns the language of numerals for numbers, date, time and datetime values.- Specified by:
getNumeralLanguagein interfaceValueProperties- Returns:
- One of the language constant or -1 for the report and locale default.
- See Also:
ValueProperties.setNumeralLanguage(int)
-
setAllowFieldClipping
public final void setAllowFieldClipping(boolean newValue)
Sets the value of the property 'allow field clipping'. When this property is enabled and the number value of the field is larger then the clip rectangle then the value is cutting. If it is disable then only a count of number sign '#' are printed in the clip rectangle.- Specified by:
setAllowFieldClippingin interfaceValueProperties- Parameters:
newValue- The new value of the property.- Since:
- 6.0
- See Also:
isAllowFieldClipping(),setAllowFieldClippingFormula(FormulaField)
-
isAllowFieldClipping
public final boolean isAllowFieldClipping()
Returnstrueif allow field clipping is enabled, elsefalseis returned.- Specified by:
isAllowFieldClippingin interfaceValueProperties- Returns:
- whether field clipping is allowed for this field.
- Since:
- 7.0
-
setAllowFieldClippingFormula
public final void setAllowFieldClippingFormula(FormulaField newField)
Set the formula for the property 'allow field clipping'.- Specified by:
setAllowFieldClippingFormulain interfaceValueProperties- Parameters:
newField- Formula Field to set for the property "allow field clipping"- Since:
- 6.0
- See Also:
setAllowFieldClipping(boolean),getAllowFieldClippingFormula()
-
getAllowFieldClippingFormula
public final FormulaField getAllowFieldClippingFormula()
Get the formula for the property 'allow field clipping'.- Specified by:
getAllowFieldClippingFormulain interfaceValueProperties- Returns:
- Formula Field for the property "allow field clipping"
- Since:
- 6.0
- See Also:
setAllowFieldClipping(boolean),setAllowFieldClippingFormula(com.inet.report.FormulaField)
-
getCurrencySeparator
public final java.lang.String getCurrencySeparator()
Returns the separator between the number value and currency symbol. The default value for this property is an space character.- Specified by:
getCurrencySeparatorin interfaceValueProperties- Returns:
- The separator to be displayed between the number value and the currency value.
- Since:
- 7.0
-
setCurrencySeparator
public final void setCurrencySeparator(java.lang.String newCurrencySeparator)
Sets the separator to be displayed between the number value and the currency value.- Specified by:
setCurrencySeparatorin interfaceValueProperties- Parameters:
newCurrencySeparator- The separator to be used between number value and currency symbol.- Since:
- 7.0
-
getCurrencySeparatorFormula
public final FormulaField getCurrencySeparatorFormula()
Returns the formula for the property 'currency separator'. If this formula is notnullit will be used to get the separator between the number value and the currency symbol otherwise the value ofValueProperties.getCurrencySeparator()will be used.- Specified by:
getCurrencySeparatorFormulain interfaceValueProperties- Returns:
- The formula which will be used to get the separator between the
number value and the currency symbol or
nullif only the value ofValueProperties.getCurrencySeparator()should be used. - Since:
- 7.0
-
setCurrencySeparatorFormula
public final void setCurrencySeparatorFormula(FormulaField newFormula)
Sets the formula which should be used to retrieve the value for the separator between number value and currency symbol. The formula passed has to return a value of type string.- Specified by:
setCurrencySeparatorFormulain interfaceValueProperties- Parameters:
newFormula- The formula which should be used for the property 'currency separator' ornullif no formula should be used.- Since:
- 7.0
-
setField
public final void setField(Field newField)
Sets the field definition element (for example, DatabaseField element, prompt field element).
-
getPropertyFormulas
public java.util.List<FormulaField> 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()- Overrides:
getPropertyFormulasin classAbstractFontElement- Returns:
- List of property formulas
-
getManualFormatFormula
public FormulaField getManualFormatFormula()
Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.- Specified by:
getManualFormatFormulain interfaceValueProperties- Returns:
FormulaFieldThe formula of the property 'manual format'.- Since:
- 6.1
-
setManualFormatFormula
public void setManualFormatFormula(FormulaField newFormula)
Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.- Specified by:
setManualFormatFormulain interfaceValueProperties- Parameters:
newFormula- The new formula for the property 'manual format'.- Since:
- 6.1
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap) throws FatalParserException
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:
parseElementin interfaceNodeParser- Overrides:
parseElementin classAbstractFontElement- 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.
-
-