bibliothek.gui.dock.common.mode

Class CMaximizedMode

java.lang.Object

bibliothek.gui.dock.facile.mode.AbstractLocationMode<M>

bibliothek.gui.dock.facile.mode.MaximizedMode<CMaximizedModeArea>

bibliothek.gui.dock.common.mode.CMaximizedMode

All Implemented Interfaces:

CLocationMode, LocationMode, Mode<Location>, Iterable<CMaximizedModeArea>

public class CMaximizedMode
extends MaximizedMode<CMaximizedModeArea>
implements CLocationMode

Manages CMaximizedModeAreas.

Author:

Benjamin Sigg

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.facile.mode.AbstractLocationMode

AbstractLocationMode.DockableHandle

Field Summary

Fields inherited from class bibliothek.gui.dock.facile.mode.MaximizedMode

ICON_IDENTIFIER, IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
CMaximizedMode(CControl control) Creates a new mode.

Method Summary

Modifier and Type	Method and Description
LocationModePerspective	createPerspective() Gets an object that represents this type of mode in a CPerspective.
CLocation	getCLocation(Dockable dockable) Gets the location of dockable which is in this mode.
CLocation	getCLocation(Dockable dockable, Location location) Gets the location of dockable which might or might not be a child of this mode.
MaximizedModeArea	getMaximizeArea(Dockable dockable, Location history) Gets the area to which dockable should be maximized.
boolean	isBasicMode() Tells whether this mode is a basic mode or not.
boolean	respectWorkingAreas(DockStation station) Tells whether Dockables which have this mode applied should respect the settings for CWorkingAreas.

Methods inherited from class bibliothek.gui.dock.facile.mode.MaximizedMode

applyDone, applyStarting, current, ensureNotHidden, getExtendedMode, getMaximizeArea, getMaximizeArea, getMaximizingElement, getMaximizingElement, getNextMaximizeArea, getSettingFactory, getUniqueIdentifier, getUnmaximizedMode, isCurrentMode, isDefaultMode, isRepresenting, maximize, maximize, process, readSetting, runApply, setManager, switchMode, unmaximize, unmaximize, unmaximize, writeSetting

Methods inherited from class bibliothek.gui.dock.facile.mode.AbstractLocationMode

add, addLocationModeListener, apply, aside, createHandle, get, get, get, get, getActionsFor, getController, getDefaultArea, getManager, getRepresentation, getRepresentationIds, isModeAvailable, isModeHidden, iterator, listeners, remove, removeLocationModeListener, setActionProvider, setController, setDefaultArea, setShouldAutoFocus, shouldAutoFocus

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.facile.mode.LocationMode

addLocationModeListener, aside, ensureNotHidden, getExtendedMode, getManager, getRepresentation, getRepresentationIds, isCurrentMode, isRepresenting, removeLocationModeListener, setController, setManager, shouldAutoFocus

Methods inherited from interface bibliothek.gui.dock.support.mode.Mode

apply, current, getActionsFor, getSettingFactory, getUniqueIdentifier, isDefaultMode, readSetting, writeSetting

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CMaximizedMode

public CMaximizedMode(CControl control)

Creates a new mode.

Parameters:

control - the control in whose realm this mode works.

Method Detail

getCLocation

public CLocation getCLocation(Dockable dockable)

Description copied from interface: CLocationMode

Gets the location of dockable which is in this mode.

Specified by:

getCLocation in interface CLocationMode

Parameters:

dockable - the element whose location is asked

Returns:

the location or null if it cannot be determined

getCLocation

public CLocation getCLocation(Dockable dockable,
                              Location location)

Description copied from interface: CLocationMode

Gets the location of dockable which might or might not be a child of this mode.

Specified by:

getCLocation in interface CLocationMode

Parameters:

dockable - the element

location - the location dockable is supposed to be in if in this mode.

Returns:

the location or null if it cannot be determined

isBasicMode

public boolean isBasicMode()

Description copied from interface: CLocationMode

Tells whether this mode is a basic mode or not. There are basic and advanced modes. A basic and an advanced mode may share the same representation (the same DockStations), but if in doubt the basic mode has more weight.

Specified by:

isBasicMode in interface CLocationMode

Returns:

true if this is a basic mode

respectWorkingAreas

public boolean respectWorkingAreas(DockStation station)

Description copied from interface: CLocationMode

Tells whether Dockables which have this mode applied should respect the settings for CWorkingAreas.

Specified by:

respectWorkingAreas in interface CLocationMode

Parameters:

station - the station which is the parent of the Dockables

Returns:

true if the settings should be respected, false otherwise

createPerspective

public LocationModePerspective createPerspective()

Description copied from interface: CLocationMode

Gets an object that represents this type of mode in a CPerspective.

Specified by:

createPerspective in interface CLocationMode

Returns:

the perspective version of this

getMaximizeArea

public MaximizedModeArea getMaximizeArea(Dockable dockable,
                                         Location history)

Description copied from class: MaximizedMode

Gets the area to which dockable should be maximized. This can be MaximizedMode.getMaximizeArea(Dockable), or some other station.

Overrides:

getMaximizeArea in class MaximizedMode<CMaximizedModeArea>

Parameters:

dockable - the element that is maximized

history - the history of the last place where dockable was maximized, might be null

Returns:

the preferred area to maximize dockable