de.griefed.serverpackcreator.swing.utilities

Class BackgroundPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.griefed.serverpackcreator.swing.utilities.BackgroundPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class BackgroundPanel
extends javax.swing.JPanel

Hey, Griefed here. I tried to add a tiled background image to the frame which holds the JTabbedPane, but after several failed attempts, I gave up and almost threw the idea out of the window. I wanted to set the background to a tiled image, because simply setting a colour seemed too boring, and I needed something in the background so the banner icon would be more clear to the eye. So, I activated my Google-Fu and encountered this holy grail of tiling images for Swing.
Links:
Background Panel by Rob Camick from October 12, 2008
BackgroundPanel.java
Seriously, give this man an award, because this class is a BEAST.

Rob, if you somehow ever get wind of your class being used here: Thank you, thank you, thank you, thank you, thank you so very much! You seriously made my day here.
Rob, you rule.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTUAL
static int	SCALED
static int	TILED

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 and Description
BackgroundPanel(java.awt.Image image) Constructor Set image as the background with the SCALED style.
BackgroundPanel(java.awt.Image image, int style) Constructor Set image as the background with the specified style.
BackgroundPanel(java.awt.Image image, int style, float alignmentX, float alignmentY) Constructor Set image as the background with the specified style and alignment.
BackgroundPanel(java.awt.Paint painter) Constructor Use the Paint interface to paint a background.

Method Summary

Modifier and Type	Method and Description
void	addComponent(javax.swing.JComponent component) Override method so we can make the component transparent.
void	addComponent(javax.swing.JComponent component, java.lang.Object constraints) Override method so we can make the component transparent.
java.awt.Dimension	getPreferredSize() Override to provide a preferred size equal to the image size.
protected void	paintComponent(java.awt.Graphics g) Add custom painting.
void	setImage(java.awt.Image image) Setter for the image used as the background.
void	setImageAlignmentX(float alignmentX) Setter for the horizontal alignment of the image when using ACTUAL style.
void	setImageAlignmentY(float alignmentY) Setter for the horizontal alignment of the image when using ACTUAL style.
void	setPaint(java.awt.Paint painter) Setter for the Paint object used to paint the background.
void	setStyle(int style) Setter the style used to paint the background image.
void	setTransparentAdd(boolean isTransparentAdd) Controls whether components added to this panel should automatically be made transparent.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, addImpl, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Field Detail

SCALED

public static final int SCALED

See Also:

Constant Field Values

TILED

public static final int TILED

See Also:

Constant Field Values

ACTUAL

public static final int ACTUAL

See Also:

Constant Field Values

Constructor Detail

BackgroundPanel

public BackgroundPanel(java.awt.Image image)

Constructor
Set image as the background with the SCALED style.

Parameters:

image - Pass an image to the constructor to be used in the new JPanel.

BackgroundPanel

public BackgroundPanel(java.awt.Image image,
                       int style)

Constructor
Set image as the background with the specified style.

Parameters:

image - Pass an image to the constructor to be used in the new JPanel.

style - The style with which the image should be painted. See SCALED, TILED, ACTUAL

BackgroundPanel

public BackgroundPanel(java.awt.Image image,
                       int style,
                       float alignmentX,
                       float alignmentY)

Constructor
Set image as the background with the specified style and alignment.

Parameters:

image - Pass an image to the constructor to be used in the new JPanel.

style - The style with which the image should be painted. See SCALED, TILED, ACTUAL

alignmentX - Alignment along the x-axis.

alignmentY - Alignment along the y-axis.

BackgroundPanel

public BackgroundPanel(java.awt.Paint painter)

Constructor
Use the Paint interface to paint a background.

Parameters:

painter - Pass a painter to be used as the background in the new JPanel.

Method Detail

setImage

public void setImage(java.awt.Image image)

Setter for the image used as the background.

Parameters:

image - Image to be set as the background.

setStyle

public void setStyle(int style)

Setter the style used to paint the background image.

Parameters:

style - Sets the style with which the image should be painted.

setImageAlignmentX

public void setImageAlignmentX(float alignmentX)

Setter for the horizontal alignment of the image when using ACTUAL style.

Parameters:

alignmentX - Sets the alignment along the x-axis.

setImageAlignmentY

public void setImageAlignmentY(float alignmentY)

Setter for the horizontal alignment of the image when using ACTUAL style.

Parameters:

alignmentY - Sets the alignment along the y-axis.

setPaint

public void setPaint(java.awt.Paint painter)

Setter for the Paint object used to paint the background.

Parameters:

painter - Sets the painter with which the background should be painted.

addComponent

public void addComponent(javax.swing.JComponent component)

Override method so we can make the component transparent.

Parameters:

component - JComponent to add to the panel.

addComponent

public void addComponent(javax.swing.JComponent component,
                         java.lang.Object constraints)

Override method so we can make the component transparent.

Parameters:

component - JComponent to add to the panel.

constraints - Constraints with which the panel should be added.

setTransparentAdd

public void setTransparentAdd(boolean isTransparentAdd)

Controls whether components added to this panel should automatically be made transparent. That is, setOpaque(false) will be invoked. The default is set to true.

Parameters:

isTransparentAdd - Whether to automatically make components transparent.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Add custom painting.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - Received from parent.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Override to provide a preferred size equal to the image size.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

Returns the dimension of the passed image.