Class ModuleOption

  • All Implemented Interfaces:
    IModuleOption

    public class ModuleOption
    extends java.lang.Object
    implements IModuleOption
    Provide the way to do some setting about the module.
    • Field Detail

      • options

        protected java.util.Map<java.lang.String,​java.lang.Object> options
        Maps to store the key/value pairs.
    • Constructor Detail

      • ModuleOption

        public ModuleOption()
        Default constructor.
      • ModuleOption

        public ModuleOption​(java.util.Map options)
        Constructs the module options with mapping of the option settings.
        Parameters:
        options - the option settings to add
    • Method Detail

      • 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

        public java.lang.String getResourceFolder()
        Gets the resource folder.
        Returns:
        the resource folder
      • setResourceFolder

        public void setResourceFolder​(java.lang.String resourceFolder)
        Sets the resource folder
        Parameters:
        resourceFolder - the resource folder to set
      • setProperty

        public void setProperty​(java.lang.String key,
                                java.lang.Object value)
        Sets an option of this setting.
        Parameters:
        key - the option key
        value - the option value
      • getProperty

        public java.lang.Object getProperty​(java.lang.String key)
        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

        public IResourceLocator getResourceLocator()
        Gets the resource locator.
        Returns:
        the resource locator
      • setResourceLocator

        public void setResourceLocator​(IResourceLocator locator)
        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

        public java.lang.Object copy()
                              throws java.lang.CloneNotSupportedException
        Returns the copy of the current options.
        Returns:
        the copy of the current options
        Throws:
        java.lang.CloneNotSupportedException
      • getOptions

        public java.util.Map getOptions()
        Returns a read-only map for all options.
        Returns:
        the options
      • setOptions

        public void setOptions​(java.util.Map options)
        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 -