bibliothek.gui.dock.station.flap
Class FlapDockProperty

java.lang.Object
  extended by bibliothek.gui.dock.layout.AbstractDockableProperty
      extended by bibliothek.gui.dock.station.flap.FlapDockProperty
All Implemented Interfaces:
DockableProperty

public class FlapDockProperty
extends AbstractDockableProperty

FlapDockProperties are used on the FlapDockStation to determine the location of a Dockable.

Author:
Benjamin Sigg

Field Summary
static FlapDockProperty FIRST
          The location of the first Dockable.
static FlapDockProperty LAST
          The location of the last Dockable.
 
Constructor Summary
FlapDockProperty()
          Constructs a FlapDockProperty
FlapDockProperty(int index)
          Constructs a FlapDockProperty
 
Method Summary
 String getFactoryID()
          Gest the unique name of the DockablePropertyFactory which can create this type of DockableProperty.
 int getIndex()
          Gets the location of the Dockable on its FlapDockStation.
 void load(DataInputStream in)
          Reads the contents of this DockableProperty from a stream.
 void load(XElement element)
          Reads the contents of this DockableProperty from an xml element.
 void setIndex(int index)
          Sets the location of the Dockable on its FlapDockStation.
 void store(DataOutputStream out)
          Stores the contents of this DockableProperty in a stream.
 void store(XElement element)
          Stores the contents of this property as xml element.
 
Methods inherited from class bibliothek.gui.dock.layout.AbstractDockableProperty
getSuccessor, setSuccessor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FIRST

public static final FlapDockProperty FIRST
The location of the first Dockable.


LAST

public static final FlapDockProperty LAST
The location of the last Dockable.

Constructor Detail

FlapDockProperty

public FlapDockProperty()
Constructs a FlapDockProperty


FlapDockProperty

public FlapDockProperty(int index)
Constructs a FlapDockProperty

Parameters:
index - the location of the Dockable
See Also:
setIndex(int)
Method Detail

setIndex

public void setIndex(int index)
Sets the location of the Dockable on its FlapDockStation.

Parameters:
index - the location

getIndex

public int getIndex()
Gets the location of the Dockable on its FlapDockStation.

Returns:
the location
See Also:
setIndex(int)

getFactoryID

public String getFactoryID()
Description copied from interface: DockableProperty
Gest the unique name of the DockablePropertyFactory which can create this type of DockableProperty.

Returns:
the id
See Also:
DockablePropertyFactory

store

public void store(DataOutputStream out)
           throws IOException
Description copied from interface: DockableProperty
Stores the contents of this DockableProperty in a stream. The successor (if there is one) must not be saved.

Parameters:
out - the stream to write in
Throws:
IOException - if anything unexpected happens

store

public void store(XElement element)
Description copied from interface: DockableProperty
Stores the contents of this property as xml element.

Parameters:
element - the element into which to write, the attributes of this element should not be changed

load

public void load(DataInputStream in)
          throws IOException
Description copied from interface: DockableProperty
Reads the contents of this DockableProperty from a stream. The property can assume that a property with the same type has written into the stream.

Parameters:
in - the stream to read
Throws:
IOException - if anything unexpected happens

load

public void load(XElement element)
Description copied from interface: DockableProperty
Reads the contents of this DockableProperty from an xml element.

Parameters:
element - the element that was written earlier by this property