bibliothek.gui.dock.util
Interface BackgroundComponent

All Superinterfaces:

UIValue<BackgroundPaint>

All Known Subinterfaces:

DisplayerBackgroundComponent, DockableBackgroundComponent, DockActionBackgroundComponent, DockTitleBackgroundComponent, FlapWindowBackgroundComponent, ScreenDockWindowBackgroundComponent, StationBackgroundComponent, TabPaneBackgroundComponent, TabPaneChildBackgroundComponent, TabPaneMenuBackgroundComponent, TabPaneTabBackgroundComponent

All Known Implementing Classes:

BackgroundAlgorithm, DisplayerScreenDockWindow.Background

public interface BackgroundComponent
extends UIValue<BackgroundPaint>

A BackgroundComponent is a Component whose background is painted by a BackgroundPaint.

Author:

Benjamin Sigg

Field Summary

static Path

KIND the type of this UIValue

Method Summary

Component	getComponent() Gets the Component which is represented by this
Transparency	getTransparency() Tells whether this component is transparent or not.
void	repaint() Informs this component that it should be repainted.
void	setTransparency(Transparency transparency) Informs this component whether it should be transparent or not.

Methods inherited from interface bibliothek.gui.dock.util.UIValue

set

Field Detail

KIND

static final Path KIND

the type of this UIValue

Method Detail

getComponent

Component getComponent()

Gets the Component which is represented by this

Returns:

the component, may not be null

setTransparency

void setTransparency(Transparency transparency)

Informs this component whether it should be transparent or not. A transparent component does not paint a background, while a non-transparent component paints every part of its background. This property is optional and not every component can fully support transparency:

• Root-components like a ScreenDockWindow usually do not support any transparency at all.
• Decorative components, like a DockTitle or a Tab, usually paint some parts of their background even if transparent.

It should be noted, that together with a BackgroundPaint, any component can be made to look as if transparent.

Parameters:

transparency - whether to paint a background or not

getTransparency

Transparency getTransparency()

Tells whether this component is transparent or not.

Returns:

how the background is painted

See Also:

setTransparency(Transparency)

repaint

void repaint()

Informs this component that it should be repainted.