bibliothek.gui.dock.station.screen
Class ScreenFullscreenAction

java.lang.Object
  bibliothek.gui.dock.action.actions.AbstractStandardDockAction
      bibliothek.gui.dock.action.actions.GroupedDockAction<K,D>
          bibliothek.gui.dock.action.actions.GroupedDropDownItemAction<K,SimpleButtonAction>
              bibliothek.gui.dock.action.actions.GroupedButtonDockAction<Boolean>
                  bibliothek.gui.dock.station.screen.ScreenFullscreenAction

All Implemented Interfaces:

ButtonDockAction, DockAction, DropDownItemAction, ListeningDockAction, StandardDockAction, StandardDropDownItemAction

public class ScreenFullscreenAction
extends GroupedButtonDockAction<Boolean>
implements ListeningDockAction

This DockAction is mainly used by the ScreenDockStation to allow it's children to go into fullscreen-mode.

Author:

Benjamin Sigg

Field Summary

Fields inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction

listeners

Constructor Summary

ScreenFullscreenAction(ScreenDockStation station)
Constructs the action and sets the station on which the Dockables will be made fullscreen.

Method Summary

void	action(Dockable dockable) Invoked when this action is triggered by the user.
protected Boolean	createGroupKey(Dockable dockable) Calculates the name of the group to which the dockable should be added.
void	setController(DockController controller) Called when a new controller has been set.

Methods inherited from class bibliothek.gui.dock.action.actions.GroupedButtonDockAction

createGroup, createView

Methods inherited from class bibliothek.gui.dock.action.actions.GroupedDropDownItemAction

isDropDownSelectable, isDropDownSelectable, isDropDownTriggerable, isDropDownTriggerable, setDropDownSelectable, setDropDownTriggerableNotSelected, setDropDownTriggerableSelected

Methods inherited from class bibliothek.gui.dock.action.actions.GroupedDockAction

bound, ensureGroup, getAccelerator, getDisabledIcon, getDisabledIcon, getGenerator, getGroup, getGroup, getIcon, getIcon, getText, getText, getTooltip, getTooltipText, getTooltipText, groupExists, isEnabled, isEnabled, isKnown, isRemoveEmptyGroups, removeGroup, setAccelerator, setDisabledIcon, setEnabled, setGenerator, setGroup, setIcon, setRemoveEmptyGroups, setText, setTooltip, trigger, unbound

Methods inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction

addDockActionListener, bind, fireActionDisabledIconChanged, fireActionEnabledChanged, fireActionIconChanged, fireActionTextChanged, fireActionTooltipTextChanged, getBoundDockables, isBound, removeDockActionListener, unbind

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.action.DockAction

bind, createView, trigger, unbind

Methods inherited from interface bibliothek.gui.dock.action.dropdown.DropDownItemAction

isDropDownSelectable, isDropDownTriggerable

Constructor Detail

ScreenFullscreenAction

public ScreenFullscreenAction(ScreenDockStation station)

Constructs the action and sets the station on which the Dockables will be made fullscreen.

Parameters:

station - the station

Method Detail

setController

public void setController(DockController controller)

Description copied from interface: ListeningDockAction

Called when a new controller has been set.

Specified by:

setController in interface ListeningDockAction

Parameters:

controller - the new controller

action

public void action(Dockable dockable)

Description copied from interface: ButtonDockAction

Invoked when this action is triggered by the user.

Specified by:

action in interface ButtonDockAction

Parameters:

dockable - The Dockable which is associated with this DockAction, and which shall be used for the current action.

createGroupKey

protected Boolean createGroupKey(Dockable dockable)

Description copied from class: GroupedDockAction

Calculates the name of the group to which the dockable should be added.
Every Dockable is member of one group. The membership determines text, icon, etc. for the dockable. Whenever a dockable is bound to this action, the group will be determined by this method. Later on, the group can be changed by the method setGroup.
The default implementation uses the generator of this action.

Overrides:

createGroupKey in class GroupedDockAction<Boolean,SimpleButtonAction>

Parameters:

dockable - The Dockable whose group has to be found

Returns:

the name of the dockable's group. That can be an existing or a non existing group. null is not a valid result.