bibliothek.gui.dock.common.perspective
Class CWorkingPerspective

java.lang.Object
  extended by bibliothek.gui.dock.common.perspective.AbstractCDockablePerspective
      extended by bibliothek.gui.dock.common.perspective.SingleCDockablePerspective
          extended by bibliothek.gui.dock.common.perspective.CGridPerspective
              extended by bibliothek.gui.dock.common.perspective.CWorkingPerspective
All Implemented Interfaces:
CDockablePerspective, CElementPerspective, CStationPerspective

public class CWorkingPerspective
extends CGridPerspective

A representation of a CWorkingArea. When using this perspective to handle the children of a CWorkingArea the following rules must be followed:

Author:
Benjamin Sigg

Nested Class Summary
 
Nested classes/interfaces inherited from class bibliothek.gui.dock.common.perspective.CGridPerspective
CGridPerspective.CommonSplitDockPerspective
 
Nested classes/interfaces inherited from class bibliothek.gui.dock.common.perspective.SingleCDockablePerspective
SingleCDockablePerspective.Intern
 
Constructor Summary
CWorkingPerspective(java.lang.String id, Path typeId)
          Creates a new working area.
 
Method Summary
protected  CGridPerspective.CommonSplitDockPerspective create()
          Called the first time SingleCDockablePerspective.intern() is called, this method creates the intern representation of this SingleCDockablePerspective.
 boolean isAutoUnset()
          Tells whether the working-area of children is automatically set to null when the children are removed from this station.
 void setAutoUnset(boolean autoUnset)
          Tells this station to set the working-area to null when a child of this station is removed.
 
Methods inherited from class bibliothek.gui.dock.common.perspective.CGridPerspective
asStation, getFactoryID, getMaximized, getPlaceholders, getRoot, getTypeId, grid, gridAdd, gridClear, gridDeploy, gridHorizontal, gridPlaceholder, gridPrepare, gridSelect, gridVertical, intern, isAutoDeploy, isWorkingArea, maximize, maximize, maybeDeploy, setAutoDeploy, setPerspective, setPlaceholders, setWorkingArea
 
Methods inherited from class bibliothek.gui.dock.common.perspective.SingleCDockablePerspective
asDockable, getUniqueId
 
Methods inherited from class bibliothek.gui.dock.common.perspective.AbstractCDockablePerspective
getLocationHistory, getParent, getWorkingArea, setWorkingArea
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.common.perspective.CStationPerspective
getUniqueId
 
Methods inherited from interface bibliothek.gui.dock.common.perspective.CElementPerspective
asDockable
 

Constructor Detail

CWorkingPerspective

public CWorkingPerspective(java.lang.String id,
                           Path typeId)
Creates a new working area.

Parameters:
id - the unique identifier of this area
typeId - the type of this station, can be null
Method Detail

setAutoUnset

public void setAutoUnset(boolean autoUnset)
Tells this station to set the working-area to null when a child of this station is removed. The default value of this property is false.

Parameters:
autoUnset - whether the working-area should be automatically set to null

isAutoUnset

public boolean isAutoUnset()
Tells whether the working-area of children is automatically set to null when the children are removed from this station.

Returns:
whether the working-area is set to null

create

protected CGridPerspective.CommonSplitDockPerspective create()
Description copied from class: SingleCDockablePerspective
Called the first time SingleCDockablePerspective.intern() is called, this method creates the intern representation of this SingleCDockablePerspective.

Overrides:
create in class CGridPerspective
Returns:
the internal representation of this