Class ModuleOption
java.lang.Object
org.eclipse.birt.report.model.api.ModuleOption
- All Implemented Interfaces:
IModuleOption
Provide the way to do some setting about the module.
-
Field Summary
FieldsModifier and TypeFieldDescriptionMaps to store the key/value pairs.Fields inherited from interface org.eclipse.birt.report.model.api.IModuleOption
BLANK_CREATION_KEY, CREATED_BY_KEY, LOCALE_KEY, MARK_LINE_NUMBER_KEY, PARSER_SEMANTIC_CHECK_KEY, READ_ONLY_MODULE_PROPERTIES, RESOURCE_FOLDER_KEY, RESOURCE_LOCATOR_KEY, SUPPORTED_UNKNOWN_VERSION_KEY, TO_LATEST_VERSION -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.ModuleOption(Map options) Constructs the module options with mapping of the option settings. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Clears all options for non-primitive values.copy()Returns the copy of the current options.com.ibm.icu.util.ULocaleGets the locale.Returns a read-only map for all options.getProperty(String key) Gets the value in this setting.Gets the resource folder.Gets the resource locator.booleanreturn whether support unknown versionbooleanDetermines whether to mark line number of element when opening/saving a module.voidsetLocale(com.ibm.icu.util.ULocale locale) Sets the locale.voidsetMarkLineNumber(boolean markLineNumber) Sets the marking line number control status.voidsetOptions(Map options) voidsetProperty(String key, Object value) Sets an option of this setting.voidsetResourceFolder(String resourceFolder) Sets the resource foldervoidsetResourceLocator(IResourceLocator locator) Sets the resource locator.voidsetSemanticCheck(boolean useSemanticCheck) Sets the semantic check control status.voidsetSupportedUnknownVersion(boolean isSupportedUnknownVersion) set whether support unknown versionvoidsetToLatestVersion(boolean toSet) Sets the flag that is used to update the design to the latest version when creates.booleanReturns the flag that indicates whether the report should be updated to the latest version when creates.booleanDetermines whether to do some semantic checks when opening a module.
-
Field Details
-
options
Maps to store the key/value pairs.
-
-
Constructor Details
-
ModuleOption
public ModuleOption()Default constructor. -
ModuleOption
Constructs the module options with mapping of the option settings.- Parameters:
options- the option settings to add
-
-
Method Details
-
useSemanticCheck
public boolean useSemanticCheck()Determines whether to do some semantic checks when opening a module.- Returns:
- true if user wants to do the checks, otherwise false
-
setSemanticCheck
public void setSemanticCheck(boolean useSemanticCheck) Sets the semantic check control status. True if user wants to do the semantic checks when opening a module, otherwise false.- Parameters:
useSemanticCheck- the control status
-
getResourceFolder
Gets the resource folder.- Returns:
- the resource folder
-
setResourceFolder
Sets the resource folder- Parameters:
resourceFolder- the resource folder to set
-
setProperty
Sets an option of this setting.- Parameters:
key- the option keyvalue- the option value
-
getProperty
Gets the value in this setting.- Parameters:
key- the key to search- Returns:
- the value in this setting if found, otherwise
null
-
markLineNumber
public boolean markLineNumber()Determines whether to mark line number of element when opening/saving a module. Note: if user switch semantic check off, this method will also return false.- Returns:
- true if user wants to mark line number of element and user switch semantic check on, otherwise false
-
setMarkLineNumber
public void setMarkLineNumber(boolean markLineNumber) Sets the marking line number control status. True if user wants to mark the line number of the element in xml source when opening/saving a module, otherwise false.- Parameters:
markLineNumber- the control status
-
getResourceLocator
Gets the resource locator.- Returns:
- the resource locator
-
setResourceLocator
Sets the resource locator.- Parameters:
locator- the resource locator to set
-
getLocale
public com.ibm.icu.util.ULocale getLocale()Gets the locale.- Returns:
- the locale
-
setLocale
public void setLocale(com.ibm.icu.util.ULocale locale) Sets the locale.- Parameters:
locale- the locale
-
setToLatestVersion
public void setToLatestVersion(boolean toSet) Sets the flag that is used to update the design to the latest version when creates.- Parameters:
toSet-
-
toLatestVersion
public boolean toLatestVersion()Returns the flag that indicates whether the report should be updated to the latest version when creates.- Returns:
-
copy
Returns the copy of the current options.- Returns:
- the copy of the current options
- Throws:
CloneNotSupportedException
-
getOptions
Returns a read-only map for all options.- Returns:
- the options
-
setOptions
- Parameters:
options-
-
close
public void close()Clears all options for non-primitive values.- Since:
- 4.7
-
isSupportedUnknownVersion
public boolean isSupportedUnknownVersion()return whether support unknown version- Returns:
-
setSupportedUnknownVersion
public void setSupportedUnknownVersion(boolean isSupportedUnknownVersion) set whether support unknown version- Parameters:
isSupportedUnknownVersion-
-