org.eclipse.birt.chart.model.attribute
Interface NumberFormatSpecifier

All Superinterfaces:

org.eclipse.emf.ecore.EObject, FormatSpecifier, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

NumberFormatSpecifierImpl

public interface NumberFormatSpecifier

extends FormatSpecifier

A representation of the model object 'Number Format Specifier'. This type holds the format specifier properties for a numeric label.

The following features are supported:

• Prefix
• Suffix
• Multiplier
• Fraction Digits

See Also:

AttributePackage.getNumberFormatSpecifier()

Method Summary

java.lang.String	format(double dValue, java.util.Locale lo) Deprecated.
java.lang.String	format(double dValue, com.ibm.icu.util.ULocale lo) Formats a value using the internally defined format specifier rules
int	getFractionDigits() Returns the value of the 'Fraction Digits' attribute.
double	getMultiplier() Returns the value of the 'Multiplier' attribute.
java.lang.String	getPrefix() Returns the value of the 'Prefix' attribute.
java.lang.String	getSuffix() Returns the value of the 'Suffix' attribute.
boolean	isSetFractionDigits() Returns whether the value of the 'Fraction Digits' attribute is set.
boolean	isSetMultiplier() Returns whether the value of the 'Multiplier' attribute is set.
void	setFractionDigits(int value) Sets the value of the 'Fraction Digits' attribute.
void	setMultiplier(double value) Sets the value of the 'Multiplier' attribute.
void	setPrefix(java.lang.String value) Sets the value of the ' Prefix' attribute.
void	setSuffix(java.lang.String value) Sets the value of the ' Suffix' attribute.
void	unsetFractionDigits() Unsets the value of the 'Fraction Digits' attribute.
void	unsetMultiplier() Unsets the value of the 'Multiplier' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getPrefix

public java.lang.String getPrefix()

Returns the value of the 'Prefix' attribute. Specifies the prefix to be added to label.

Returns:

the value of the 'Prefix' attribute.

See Also:

setPrefix(String), AttributePackage.getNumberFormatSpecifier_Prefix()

setPrefix

public void setPrefix(java.lang.String value)

Sets the value of the ' Prefix' attribute.

Parameters:

value - the new value of the 'Prefix' attribute.

See Also:

getPrefix()

getSuffix

public java.lang.String getSuffix()

Returns the value of the 'Suffix' attribute. Specifies the suffix to be added to label.

Returns:

the value of the 'Suffix' attribute.

See Also:

setSuffix(String), AttributePackage.getNumberFormatSpecifier_Suffix()

setSuffix

public void setSuffix(java.lang.String value)

Sets the value of the ' Suffix' attribute.

Parameters:

value - the new value of the 'Suffix' attribute.

See Also:

getSuffix()

getMultiplier

public double getMultiplier()

Returns the value of the 'Multiplier' attribute. Specifies the multiplier.

Returns:

the value of the 'Multiplier' attribute.

See Also:

isSetMultiplier(), unsetMultiplier(), setMultiplier(double), AttributePackage.getNumberFormatSpecifier_Multiplier()

setMultiplier

public void setMultiplier(double value)

Sets the value of the 'Multiplier' attribute.

Parameters:

value - the new value of the 'Multiplier' attribute.

See Also:

isSetMultiplier(), unsetMultiplier(), getMultiplier()

unsetMultiplier

public void unsetMultiplier()

Unsets the value of the 'Multiplier' attribute.

See Also:

isSetMultiplier(), getMultiplier(), setMultiplier(double)

isSetMultiplier

public boolean isSetMultiplier()

Returns whether the value of the 'Multiplier' attribute is set.

Returns:

whether the value of the 'Multiplier' attribute is set.

See Also:

unsetMultiplier(), getMultiplier(), setMultiplier(double)

getFractionDigits

public int getFractionDigits()

Returns the value of the 'Fraction Digits' attribute. Defines the number of fractional digits to be shown.

Returns:

the value of the 'Fraction Digits' attribute.

See Also:

isSetFractionDigits(), unsetFractionDigits(), setFractionDigits(int), AttributePackage.getNumberFormatSpecifier_FractionDigits()

setFractionDigits

public void setFractionDigits(int value)

Sets the value of the 'Fraction Digits' attribute.

Parameters:

value - the new value of the 'Fraction Digits' attribute.

See Also:

isSetFractionDigits(), unsetFractionDigits(), getFractionDigits()

unsetFractionDigits

public void unsetFractionDigits()

Unsets the value of the 'Fraction Digits' attribute.

See Also:

isSetFractionDigits(), getFractionDigits(), setFractionDigits(int)

isSetFractionDigits

public boolean isSetFractionDigits()

Returns whether the value of the 'Fraction Digits' attribute is set.

Returns:

whether the value of the 'Fraction Digits' attribute is set.

See Also:

unsetFractionDigits(), getFractionDigits(), setFractionDigits(int)

format

public java.lang.String format(double dValue,
                               java.util.Locale lo)

Deprecated.

Formats a value using the internally defined format specifier rules

Parameters:

dValue -

Returns:

A formatted string representation of the numerical value provided

format

public java.lang.String format(double dValue,
                               com.ibm.icu.util.ULocale lo)

Formats a value using the internally defined format specifier rules

Parameters:

dValue -

Returns:

A formatted string representation of the numerical value provided

Since:

2.1