org.eclipse.birt.chart.model.attribute

Interface StringFormatSpecifier

All Superinterfaces:

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

All Known Implementing Classes:

StringFormatSpecifierImpl

public interface StringFormatSpecifier
extends FormatSpecifier

A representation of the model object 'String Format Specifier'. StringFormatSpecifier extends type FormatSpecifier to devote itself to formatting a string value.

The following features are supported:

• Pattern

See Also:

AttributePackage.getStringFormatSpecifier()

Method Summary

Modifier and Type	Method and Description
StringFormatSpecifier	copyInstance()
java.lang.String	format(java.lang.String dValue, com.ibm.icu.util.ULocale lo) Formats a value using the internally defined format specifier rules
java.lang.String	getPattern() Returns the value of the 'Pattern' attribute.
void	setPattern(java.lang.String value) Sets the value of the 'Pattern' attribute.

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

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

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

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getPattern

java.lang.String getPattern()

Returns the value of the 'Pattern' attribute. Attribute "Pattern" specifies the format pattern.

Returns:

the value of the 'Pattern' attribute.

See Also:

setPattern(String), AttributePackage.getStringFormatSpecifier_Pattern()

setPattern

void setPattern(java.lang.String value)

Sets the value of the 'Pattern' attribute.

Parameters:

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

See Also:

getPattern()

copyInstance

StringFormatSpecifier copyInstance()

Specified by:

copyInstance in interface FormatSpecifier

Specified by:

copyInstance in interface IChartObject

format

java.lang.String format(java.lang.String 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 string value provided