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:

See Also:
AttributePackage.getNumberFormatSpecifier()

Method Summary
 NumberFormatSpecifier copyInstance()
          A convenient method to get an instance copy.
 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

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

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

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

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

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

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

void unsetMultiplier()
Unsets the value of the 'Multiplier' attribute.

See Also:
isSetMultiplier(), getMultiplier(), setMultiplier(double)

isSetMultiplier

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

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

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

void unsetFractionDigits()
Unsets the value of the 'Fraction Digits' attribute.

See Also:
isSetFractionDigits(), getFractionDigits(), setFractionDigits(int)

isSetFractionDigits

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

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

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

copyInstance

NumberFormatSpecifier copyInstance()
A convenient method to get an instance copy. This is much faster than the ECoreUtil.copy().

Specified by:
copyInstance in interface FormatSpecifier


Copyright © 2005-2008 Actuate Corp. All rights reserved.