bibliothek.extension.gui.dock.theme.eclipse.displayer
Class EclipseDockableDisplayer

java.lang.Object
  bibliothek.gui.dock.station.stack.tab.AbstractTabPane<T,M,I>
      bibliothek.gui.dock.station.stack.CombinedStackDockComponent<EclipseTab,EclipseMenu,EclipseTabInfo>
          bibliothek.extension.gui.dock.theme.eclipse.stack.EclipseTabPane
              bibliothek.extension.gui.dock.theme.eclipse.displayer.EclipseDockableDisplayer

All Implemented Interfaces:

BorderedComponent, DockableDisplayer, StackDockComponent, TabPane

Deprecated. this class gets replaced by EclipseDockableDisplayer2, it is no longer used by the framework and only remains for backwards compatibility. This class will be removed in a future release.

@Deprecated
@Todo(priority=MINOR,
      target=VERSION_1_1_2,
      compatibility=BREAK_MINOR,
      description="Replace this class with EclipseDockableDisplayer2")
public class EclipseDockableDisplayer
extends EclipseTabPane
implements DockableDisplayer

This displayer paints a tab instead of a DockTitle (if the framework sets a title, then this title is ignored).

Author:

Janni Kovacs

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.station.stack.CombinedStackDockComponent

CombinedStackDockComponent.Meta

Nested classes/interfaces inherited from interface bibliothek.gui.dock.station.DockableDisplayer

DockableDisplayer.Location

Field Summary

Fields inherited from interface bibliothek.gui.dock.station.stack.tab.TabPane

LAYOUT_MANAGER

Constructor Summary

EclipseDockableDisplayer(EclipseTheme theme, DockStation station, Dockable dockable)
Deprecated. Creates a new DockableDisplayer.

Method Summary

void	addDockableDisplayerListener(DockableDisplayerListener listener) Deprecated. Adds listener to this displayer.
protected BackgroundAlgorithm	createBackground(CombinedStackDockComponent<EclipseTab,EclipseMenu,EclipseTabInfo> self) Deprecated. Creates the background algorithm that is used for this component.
protected BorderForwarder	createBorderModifier(JComponent target) Deprecated. Creates the BorderForwarder that is used to set the border of this panel.
protected BorderForwarder	createContentBorderModifier(Dockable dockable, JComponent target) Deprecated. Creates a BorderForwarder for the content component for the tab of dockable
protected DockableDisplayerListener[]	displayerListeners() Deprecated. Gets all DockableDisplayerListener known to this displayer.
Dockable	getDockable() Deprecated. Gets the Dockable which is shown on this displayer.
Insets	getDockableInsets() Deprecated. Gets an estimate of the insets around the Dockable of this displayer compared to the whole size of this displayer.
Dimension	getMinimumSize() Deprecated. Gets the minimal size that TabPane.getAvailableArea() should return.
DockElementRepresentative	getMoveableElement() Deprecated. Gets a representation of the Dockable that can be used for grabbing and moving around the displayer.
Dimension	getNecessarySize() Deprecated.
Dimension	getPreferredSize() Deprecated. Gets the preferred size that TabPane.getAvailableArea() should return.
DockStation	getStation() Deprecated. Gets the station on which this pane lies.
DockTitle	getTitle() Deprecated. Gets the title which is shown on this displayer.
DockableDisplayer.Location	getTitleLocation() Deprecated. Gets the location of the title in respect to the Dockable.
DisplayerCombinerTarget	prepareCombination(CombinerSource source, Enforcement force) Deprecated. This method tells how this displayer would like to combine itself with a Dockable that is dropped over it.
void	removeDockableDisplayerListener(DockableDisplayerListener listener) Deprecated. Removes listener from this displayer.
void	setController(DockController controller) Deprecated. Connects this pane with controller.
void	setDockable(Dockable dockable) Deprecated. Sets the Dockable which should be shown on this displayer.
void	setStation(DockStation station) Deprecated. Sets the station on which this displayer is shown.
void	setTitle(DockTitle title) Deprecated. Sets the title of this displayer.
void	setTitleLocation(DockableDisplayer.Location location) Deprecated. Sets the location of the title in respect to the Dockable.
boolean	titleContains(int x, int y) Deprecated. Tells whether the point x/y is inside the title of this displayer or not.

Methods inherited from class bibliothek.extension.gui.dock.theme.eclipse.stack.EclipseTabPane

createContentPane, createLayerAt, getContentInsets, getLayerAt, getPainter, getTabPainter, getTheme, hasBorder, indexOfVisible, isSingleTabComponent, menuRemoved, newMenu, newTab, setContentBorderAt, setInfoComponent, setPainter, tabRemoved, updateFullBorder, updateTabPainter

Methods inherited from class bibliothek.gui.dock.station.stack.CombinedStackDockComponent

addStackDockComponentListener, addTab, addToMenu, clearTabs, createDefaultRepresentation, fireTabChanged, getAvailableArea, getBoundsAt, getComponent, getConfiguration, getContentAt, getDockableAt, getInfoHandler, getMenuHandler, getMinimumSize, getOnTab, getPreferredSize, getSelectedBounds, getSelectedIndex, getTabAt, getTabCount, getTabHandler, getZOrder, insertTab, moveTab, putOnTab, putTab, remove, removeAll, removeFromMenu, removeStackDockComponentListener, removeTab, repaint, revalidate, setComponentAt, setEnabledAt, setIconAt, setSelectedBounds, setSelectedDockable, setSelectedIndex, setTitleAt, setTooltipAt, setZOrder

Methods inherited from class bibliothek.gui.dock.station.stack.tab.AbstractTabPane

addTabPaneListener, createMenu, destroyMenu, discardComponentsAndRebuild, doLayout, fireAdded, fireControllerChanged, fireInfoComponentChanged, fireRemoved, fireSelectionChanged, getController, getDockable, getDockableCount, getDockables, getDockTabPlacement, getInfoComponent, getLayoutManager, getMenu, getMenuList, getMenus, getSelectedDockable, getTab, getTabs, getTabsList, getVisibleTab, getVisibleTabCount, indexOf, indexOfVisible, insert, listeners, move, putInMenu, removeTabPaneListener, setDockTabPlacement, setLayoutManager

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.station.DockableDisplayer

getComponent, getController

Methods inherited from interface bibliothek.extension.gui.dock.theme.eclipse.stack.tab.BorderedComponent

getDockTabPlacement

Methods inherited from interface bibliothek.gui.dock.station.stack.StackDockComponent

getDockTabPlacement, setDockTabPlacement

Constructor Detail

EclipseDockableDisplayer

public EclipseDockableDisplayer(EclipseTheme theme,
                                DockStation station,
                                Dockable dockable)

Deprecated.

Creates a new DockableDisplayer.

Parameters:

theme - the theme which creates this displayer, not null

station - the parent of this displayer, not null

dockable - the element shown on this displayer, may be null

Method Detail

getMoveableElement

public DockElementRepresentative getMoveableElement()

Deprecated.

Description copied from interface: DockableDisplayer

Gets a representation of the Dockable that can be used for grabbing and moving around the displayer. The result of this method should be the first match of this list:

1. A DockTitle
2. Any kind of DockElementRepresentative
3. The Dockable itself
4. null

Changes of the result of this method should be communicated through the DockableDisplayerListeners.

Specified by:

getMoveableElement in interface DockableDisplayer

Returns:

an element for moving around this displayer, can be null

getMinimumSize

public Dimension getMinimumSize()

Deprecated.

Description copied from class: AbstractTabPane

Gets the minimal size that TabPane.getAvailableArea() should return.

Overrides:

getMinimumSize in class AbstractTabPane<EclipseTab,EclipseMenu,EclipseTabInfo>

Returns:

the minimal size

getPreferredSize

public Dimension getPreferredSize()

Deprecated.

Description copied from class: AbstractTabPane

Gets the preferred size that TabPane.getAvailableArea() should return.

Overrides:

getPreferredSize in class AbstractTabPane<EclipseTab,EclipseMenu,EclipseTabInfo>

Returns:

the preferred size

addDockableDisplayerListener

public void addDockableDisplayerListener(DockableDisplayerListener listener)

Deprecated.

Description copied from interface: DockableDisplayer

Adds listener to this displayer.

Specified by:

addDockableDisplayerListener in interface DockableDisplayer

Parameters:

listener - the new listener, not null

removeDockableDisplayerListener

public void removeDockableDisplayerListener(DockableDisplayerListener listener)

Deprecated.

Description copied from interface: DockableDisplayer

Removes listener from this displayer.

Specified by:

removeDockableDisplayerListener in interface DockableDisplayer

Parameters:

listener - the listener to remove

displayerListeners

protected DockableDisplayerListener[] displayerListeners()

Deprecated.

Gets all DockableDisplayerListener known to this displayer.

Returns:

the list of listeners

setDockable

public void setDockable(Dockable dockable)

Deprecated.

Description copied from interface: DockableDisplayer

Sets the Dockable which should be shown on this displayer. A value of null means that no Dockable should be visible at all.

Specified by:

setDockable in interface DockableDisplayer

Parameters:

dockable - the child, can be null

setController

public void setController(DockController controller)

Deprecated.

Description copied from class: AbstractTabPane

Connects this pane with controller.

Specified by:

setController in interface DockableDisplayer

Specified by:

setController in interface StackDockComponent

Overrides:

setController in class EclipseTabPane

Parameters:

controller - the realm in which this pane works, may be null

titleContains

public boolean titleContains(int x,
                             int y)

Deprecated.

Description copied from interface: DockableDisplayer

Tells whether the point x/y is inside the title of this displayer or not.

Specified by:

titleContains in interface DockableDisplayer

Parameters:

x - the x-coordinate, relatively to this component

y - the y-coordinate, relatively to this component

Returns:

true if the title contains the point

createBackground

protected BackgroundAlgorithm createBackground(CombinedStackDockComponent<EclipseTab,EclipseMenu,EclipseTabInfo> self)

Deprecated.

Description copied from class: CombinedStackDockComponent

Creates the background algorithm that is used for this component. This method may be called by the constructor.

Overrides:

createBackground in class CombinedStackDockComponent<EclipseTab,EclipseMenu,EclipseTabInfo>

Parameters:

self - this

Returns:

the new algorithm, not null

getDockableInsets

public Insets getDockableInsets()

Deprecated.

Description copied from interface: DockableDisplayer

Gets an estimate of the insets around the Dockable of this displayer compared to the whole size of this displayer.

Specified by:

getDockableInsets in interface DockableDisplayer

Returns:

the estimate of the insets

getDockable

public Dockable getDockable()

Deprecated.

Description copied from interface: DockableDisplayer

Gets the Dockable which is shown on this displayer.

Specified by:

getDockable in interface DockableDisplayer

Returns:

the child, can be null

getStation

public DockStation getStation()

Deprecated.

Description copied from class: EclipseTabPane

Gets the station on which this pane lies.

Specified by:

getStation in interface DockableDisplayer

Overrides:

getStation in class EclipseTabPane

Returns:

the station

getTitle

public DockTitle getTitle()

Deprecated.

Description copied from interface: DockableDisplayer

Gets the title which is shown on this displayer.

Specified by:

getTitle in interface DockableDisplayer

Returns:

the title, can be null

getTitleLocation

public DockableDisplayer.Location getTitleLocation()

Deprecated.

Description copied from interface: DockableDisplayer

Gets the location of the title in respect to the Dockable.

Specified by:

getTitleLocation in interface DockableDisplayer

Returns:

the location

setStation

public void setStation(DockStation station)

Deprecated.

Description copied from interface: DockableDisplayer

Sets the station on which this displayer is shown. That property must be set by the station itself. Note that there is no guarantee, that a station sets this property.

Specified by:

setStation in interface DockableDisplayer

Parameters:

station - the station or null

setTitle

public void setTitle(DockTitle title)

Deprecated.

Description copied from interface: DockableDisplayer

Sets the title of this displayer. If the title is set to null, no title is visible. The displayer will change the orientation of the title.

Specified by:

setTitle in interface DockableDisplayer

Parameters:

title - the title or null

setTitleLocation

public void setTitleLocation(DockableDisplayer.Location location)

Deprecated.

Description copied from interface: DockableDisplayer

Sets the location of the title in respect to the Dockable.

Specified by:

setTitleLocation in interface DockableDisplayer

Parameters:

location - the location, a value of null is transformed into the default-value

getNecessarySize

public Dimension getNecessarySize()

Deprecated.

prepareCombination

public DisplayerCombinerTarget prepareCombination(CombinerSource source,
                                                  Enforcement force)

Deprecated.

Description copied from interface: DockableDisplayer

This method tells how this displayer would like to combine itself with a Dockable that is dropped over it. This method is usually called by a Combiner or by a DockStation, but other modules may call this method as well.

Specified by:

prepareCombination in interface DockableDisplayer

Parameters:

source - information about the dockable that is dropped, the location of the mouse, etc...

force - tells how much the caller would like the result not to be null, if the force property is high, then the result should more likely not be null. Note that a result of null is always a valid result, even if the caller does not like it.

Returns:

the operation that could be performed or null if this displayer does not have any specific information

createBorderModifier

protected BorderForwarder createBorderModifier(JComponent target)

Deprecated.

Description copied from class: EclipseTabPane

Creates the BorderForwarder that is used to set the border of this panel.

Overrides:

createBorderModifier in class EclipseTabPane

Parameters:

target - the target component, not null

Returns:

the new forwarder, not null

createContentBorderModifier

protected BorderForwarder createContentBorderModifier(Dockable dockable,
                                                      JComponent target)

Deprecated.

Description copied from class: CombinedStackDockComponent

Creates a BorderForwarder for the content component for the tab of dockable

Overrides:

createContentBorderModifier in class EclipseTabPane

Parameters:

dockable - the item that is shown

target - the component which is influenced

Returns:

the forwarder or null