Oxygen XML Editor 12.2 Author API

ro.sync.exml.workspace.api.options
Class WSOptionsStorageImpl

java.lang.Object
  extended by ro.sync.exml.workspace.api.options.WSOptionsStorageImpl
All Implemented Interfaces:
WSOptionsStorage

public class WSOptionsStorageImpl
extends java.lang.Object
implements WSOptionsStorage

Options storage implementation.


Constructor Summary
WSOptionsStorageImpl()
           
 
Method Summary
 void addOptionListener(WSOptionListener listener)
          Adds an OptionListener to the current set of options.
 java.lang.String getOption(java.lang.String key, java.lang.String defaultValue)
          Provides the value of the option associated with the specified key.
 void removeAllListeners()
          Removes all options listeners.
 void removeOptionListener(WSOptionListener listener)
          Removes an option listener from the current set of option listeners.
 void setOption(java.lang.String key, java.lang.String value)
          Modifies the value of an option.
 void setOptionsDoctypePrefix(java.lang.String optionsDoctypePrefix)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSOptionsStorageImpl

public WSOptionsStorageImpl()
Method Detail

addOptionListener

public void addOptionListener(WSOptionListener listener)
Description copied from interface: WSOptionsStorage
Adds an OptionListener to the current set of options. The listener is notified when the value of its associated option changes.

Specified by:
addOptionListener in interface WSOptionsStorage
Parameters:
listener - The OptionListener to be added.
See Also:
OptionsStorage.addOptionListener(ro.sync.ecss.extensions.api.OptionListener)

getOption

public java.lang.String getOption(java.lang.String key,
                                  java.lang.String defaultValue)
Description copied from interface: WSOptionsStorage
Provides the value of the option associated with the specified key.

Specified by:
getOption in interface WSOptionsStorage
Parameters:
key - The key that uniquely identifies an option.
defaultValue - The default value for the specified option.
Returns:
The value of the specified option or the default value if the option has not been set yet.
See Also:
OptionsStorage.getOption(java.lang.String, java.lang.String)

removeOptionListener

public void removeOptionListener(WSOptionListener listener)
Description copied from interface: WSOptionsStorage
Removes an option listener from the current set of option listeners.

Specified by:
removeOptionListener in interface WSOptionsStorage
Parameters:
listener - The OptionListener to be removed.
See Also:
OptionsStorage.removeOptionListener(ro.sync.ecss.extensions.api.OptionListener)

setOption

public void setOption(java.lang.String key,
                      java.lang.String value)
Description copied from interface: WSOptionsStorage
Modifies the value of an option. If the supplied value is null The option will be removed from storage.

Specified by:
setOption in interface WSOptionsStorage
Parameters:
key - The key of the option whose value is to be modified.
value - The new value of the option. If null the option will be removed from the storage.
See Also:
OptionsStorage.setOption(java.lang.String, java.lang.String)

removeAllListeners

public void removeAllListeners()
Removes all options listeners.


setOptionsDoctypePrefix

public void setOptionsDoctypePrefix(java.lang.String optionsDoctypePrefix)
Parameters:
optionsDoctypePrefix - The document type prefix used to build the options keys. This should not be null.

Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.