Class FormatValueHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.FormatValueHandle
Represents a format value in the style or the highlight rule.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContextFields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle -
Constructor Summary
ConstructorsConstructorDescriptionFormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context) Deprecated.FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context) Construct an handle to deal with the action structure. -
Method Summary
Modifier and TypeMethodDescriptionReturns the category of the format.com.ibm.icu.util.ULocaleGets the locale of the format.Returns the pattern of the format.voidsetCategory(String pattern) Sets the category of the format.voidsetLocale(com.ibm.icu.util.ULocale locale) Sets the locale of the format.voidsetPattern(String value) Sets the pattern of the format.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilentlyMethods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReferenceMethods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
FormatValueHandle
public FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context) Construct an handle to deal with the action structure.- Parameters:
element- the element that defined the action.context- context to the format value property.
-
FormatValueHandle
@Deprecated public FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context) Deprecated.Construct an handle to deal with the action structure.- Parameters:
element- the element that defined the action.context- context to the format value property
-
-
Method Details
-
getCategory
Returns the category of the format.- Returns:
- the category of the format
-
setCategory
Sets the category of the format.- Parameters:
pattern- the category of the format- Throws:
SemanticException- ifpatternis not one of the BIRT defined.
-
getPattern
Returns the pattern of the format.- Returns:
- the pattern of the format
-
setPattern
Sets the pattern of the format.- Parameters:
value- the pattern of the format
-
setLocale
Sets the locale of the format.- Parameters:
locale- the locale of the format.- Throws:
SemanticException
-
getLocale
public com.ibm.icu.util.ULocale getLocale()Gets the locale of the format.- Returns:
- the locale of the format.
-