Package ca.corbett.extras

Class CustomizableDesktopPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

javax.swing.JDesktopPane

ca.corbett.extras.CustomizableDesktopPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class CustomizableDesktopPane
extends JDesktopPane

A customized JDesktopPane that allows setting a customized background instead of the default one provided by Java. The background can be set as a solid color or as a color gradient. An optional logo image can also be displayed with configurable positioning and transparency.

Author:

scorbo2

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CustomizableDesktopPane.LogoPlacement	Provides a way to choose where the logo image should be displayed, if at all.

Nested classes/interfaces inherited from class javax.swing.JDesktopPane

JDesktopPane.AccessibleJDesktopPane

Nested classes/interfaces inherited from class javax.swing.JLayeredPane

JLayeredPane.AccessibleJLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDesktopPane

LIVE_DRAG_MODE, OUTLINE_DRAG_MODE

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
CustomizableDesktopPane(Gradient gradient)	Creates a new CustomizableDesktopPane with the specified initial GradientConfig and no logo image.
CustomizableDesktopPane(Color bgColor)	Creates a new CustomizableDesktopPane with the specified initial solid background color and no logo image.
CustomizableDesktopPane(BufferedImage image, CustomizableDesktopPane.LogoPlacement placement, float alpha, Gradient gradient)	Creates a new CustomizableDesktopPane with the specified logo image and placement, and the specified initial GradientConfig.
CustomizableDesktopPane(BufferedImage image, CustomizableDesktopPane.LogoPlacement placement, float alpha, Color bgColor)	Creates a new CustomizableDesktopPane with the specified logo image and placement, and the specified initial solid background color.

Method Summary

Modifier and Type	Method	Description
Color	getBgSolidColor()	Returns the currently set solid background color, or null if the background is currently set to a gradient.
Gradient	getGradientConfig()	Returns the currently set gradient config for the background, or null if the background is currently set to a solid color.
void	paintComponent(Graphics g)	Overridden to allow rendering of our custom desktop background.
void	setBgSolidColor(Color bgColor)	Sets the solid color to use for drawing the desktop background.
void	setGradientConfig(Gradient conf)	Sets the GradientConfig to use for drawing the desktop background.
void	setLogoImagePlacement(CustomizableDesktopPane.LogoPlacement placement)	Sets the LogoPlacement for use with the logo image.
void	setLogoImageTransparency(float alpha)	Adjusts the transparency of the logo image, if a logo image is being shown.

Methods inherited from class javax.swing.JDesktopPane

addImpl, getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, paramString, remove, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI

Methods inherited from class javax.swing.JLayeredPane

getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

CustomizableDesktopPane

public CustomizableDesktopPane(Gradient gradient)

Creates a new CustomizableDesktopPane with the specified initial GradientConfig and no logo image.

Parameters:

gradient - The GradientConfig to use initially for drawing the background.

CustomizableDesktopPane

public CustomizableDesktopPane(Color bgColor)

Creates a new CustomizableDesktopPane with the specified initial solid background color and no logo image.

CustomizableDesktopPane

public CustomizableDesktopPane(BufferedImage image,
 CustomizableDesktopPane.LogoPlacement placement,
 float alpha,
 Gradient gradient)

Creates a new CustomizableDesktopPane with the specified logo image and placement, and the specified initial GradientConfig. The GradientConfig can be modified later via setGradientConfig(), but the logo image cannot be changed once set.

Parameters:

image - The logo image to render in the background.

placement - Where on the desktop the logo image should be rendered.

alpha - The transparency value to use for the logo image (0=invisible, 1=opaque).

gradient - The GradientConfig to use initially for drawing the background.

CustomizableDesktopPane

public CustomizableDesktopPane(BufferedImage image,
 CustomizableDesktopPane.LogoPlacement placement,
 float alpha,
 Color bgColor)

Creates a new CustomizableDesktopPane with the specified logo image and placement, and the specified initial solid background color.

Method Details

setLogoImageTransparency

public void setLogoImageTransparency(float alpha)

Adjusts the transparency of the logo image, if a logo image is being shown.

Parameters:

alpha - The transparency value for the logo image (0=invisible, 1=opaque).

setGradientConfig

public void setGradientConfig(Gradient conf)

Sets the GradientConfig to use for drawing the desktop background.

Parameters:

conf - The new GradientConfig to use.

getGradientConfig

public Gradient getGradientConfig()

Returns the currently set gradient config for the background, or null if the background is currently set to a solid color.

setBgSolidColor

public void setBgSolidColor(Color bgColor)

Sets the solid color to use for drawing the desktop background.

getBgSolidColor

public Color getBgSolidColor()

Returns the currently set solid background color, or null if the background is currently set to a gradient.

setLogoImagePlacement

public void setLogoImagePlacement(CustomizableDesktopPane.LogoPlacement placement)

Sets the LogoPlacement for use with the logo image.

Parameters:

placement - The new position for the logo image.

paintComponent

public void paintComponent(Graphics g)

Overridden to allow rendering of our custom desktop background.

Overrides:

paintComponent in class JComponent

Parameters:

g - The Graphics object to use for rendering.