bibliothek.gui.dock.common.perspective

Class CContentPerspective

java.lang.Object

bibliothek.gui.dock.common.perspective.CContentPerspective

public class CContentPerspective
extends Object

A representation of a CContentArea. Please note that CContentPerspective is only a wrapper around a CPerspective, two CContentPerspective represent the same CContentArea if they have the same identifier.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
CContentPerspective(CPerspective perspective, String id) Creates a new perspective.

Method Summary

Modifier and Type	Method and Description
protected void	ensureType(String id, Class<?> type) Searches the CStationPerspective with unique identifier id and makes sure the station is either null or of type type.
CGridPerspective	getCenter() Gets the station that is shown in the middle of the content-area.
CMinimizePerspective	getEast() Gets the station that is shown at the east side of the content-area.
String	getId() Gets the unique identifier of this perspective
CMinimizePerspective	getNorth() Gets the station that is shown at the north side of the content-area.
CPerspective	getPerspective() Gets the CPerspective in whose realm this CContentPerspective works.
CMinimizePerspective	getSouth() Gets the station that is shown at the south side of the content-area.
CMinimizePerspective	getWest() Gets the station that is shown at the west side of the content-area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CContentPerspective

public CContentPerspective(CPerspective perspective,
                           String id)

Creates a new perspective. Clients should use CPerspective.getContentArea() to obtain a CContentPerspective.

Parameters:

perspective - a map containing the stations which are used by this perspective

id - the unique identifier of this perspective

Method Detail

ensureType

protected void ensureType(String id,
                          Class<?> type)

Searches the CStationPerspective with unique identifier id and makes sure the station is either null or of type type.

Parameters:

id - the unique identifier of the station

type - the type of the station

Throws:

IllegalStateException - if the station has the wrong type

getId

public String getId()

Gets the unique identifier of this perspective

Returns:

the unique identifier

getPerspective

public CPerspective getPerspective()

Gets the CPerspective in whose realm this CContentPerspective works.

Returns:

the perspective, not null

getCenter

public CGridPerspective getCenter()

Gets the station that is shown in the middle of the content-area.

Returns:

the center

getNorth

public CMinimizePerspective getNorth()

Gets the station that is shown at the north side of the content-area.

Returns:

the minimize-area at the top side

getSouth

public CMinimizePerspective getSouth()

Gets the station that is shown at the south side of the content-area.

Returns:

the minimize-area at the bottom side

getEast

public CMinimizePerspective getEast()

Gets the station that is shown at the east side of the content-area.

Returns:

the minimize-area at the right side

getWest

public CMinimizePerspective getWest()

Gets the station that is shown at the west side of the content-area.

Returns:

the minimize-area at the left side