bibliothek.gui.dock.common.intern
Class CSetting

java.lang.Object
  extended by bibliothek.gui.dock.frontend.Setting
      extended by bibliothek.gui.dock.common.intern.CSetting

@FrameworkOnly
public class CSetting
extends Setting

A Setting that stores also the contents of a CLocationModeManager.

Author:
Benjamin Sigg

Constructor Summary
CSetting()
           
 
Method Summary
 ModeSettings<Location,Location> getModes()
          Gets the set of modes.
 void read(DockSituation situation, PropertyTransformer transformer, boolean entry, DataInputStream in)
          Reads the properties of this setting.
 void readXML(DockSituation situation, PropertyTransformer transformer, boolean entry, XElement element)
          Reads the properties of this setting.
 void setModes(ModeSettings<Location,Location> modes)
          Sets the set of modes.
 void write(DockSituation situation, PropertyTransformer transformer, boolean entry, DataOutputStream out)
          Writes the properties of this setting into out.
 void writeXML(DockSituation situation, PropertyTransformer transformer, boolean entry, XElement element)
          Writes the properties of this setting in xml format.
 
Methods inherited from class bibliothek.gui.dock.frontend.Setting
addInvisible, fillMissing, getInvisibleCount, getInvisibleKey, getInvisibleLayout, getInvisibleLocation, getInvisibleRoot, getRoot, getRootKeys, putRoot
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CSetting

public CSetting()
Method Detail

setModes

public void setModes(ModeSettings<Location,Location> modes)
Sets the set of modes.

Parameters:
modes - the modes

getModes

public ModeSettings<Location,Location> getModes()
Gets the set of modes.

Returns:
the modes

write

public void write(DockSituation situation,
                  PropertyTransformer transformer,
                  boolean entry,
                  DataOutputStream out)
           throws IOException
Description copied from class: Setting
Writes the properties of this setting into out.

Overrides:
write in class Setting
Parameters:
situation - can be used to write DockLayouts
transformer - can be used to write DockablePropertys
entry - if true, then this setting is used as one of the settings a user can choose. If false then this setting is used as the final setting that is written when the application shuts down.
out - a stream to write into
Throws:
IOException - if an I/O-error occurs

writeXML

public void writeXML(DockSituation situation,
                     PropertyTransformer transformer,
                     boolean entry,
                     XElement element)
Description copied from class: Setting
Writes the properties of this setting in xml format.

Overrides:
writeXML in class Setting
Parameters:
situation - can be used to write DockLayouts
transformer - can be used to write DockablePropertys
entry - if true, then this setting is used as one of the settings a user can choose. If false then this setting is used as the final setting that is written when the application shuts down.
element - the element into which this setting writes, the attributes of element are not changed.

read

public void read(DockSituation situation,
                 PropertyTransformer transformer,
                 boolean entry,
                 DataInputStream in)
          throws IOException
Description copied from class: Setting
Reads the properties of this setting. Old properties are deleted without further notice.

Overrides:
read in class Setting
Parameters:
situation - can be used to read DockLayouts
transformer - can be used to read DockablePropertys
entry - if true, then this setting is used as one of the settings a user can choose. If false then this setting is used as the first setting that is read when the application starts up.
in - the stream to read from
Throws:
IOException - if an I/O-error occurs

readXML

public void readXML(DockSituation situation,
                    PropertyTransformer transformer,
                    boolean entry,
                    XElement element)
Description copied from class: Setting
Reads the properties of this setting. Old properties are deleted without further notice.

Overrides:
readXML in class Setting
Parameters:
situation - can be used to read DockLayouts
transformer - can be used to read DockablePropertys
entry - if true, then this setting is used as one of the settings a user can choose. If false then this setting is used as the first setting that is read when the application starts up.
element - the element which should be read