com.jgoodies.uifextras.util
Class GradientSeparator

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by com.jgoodies.uifextras.util.GradientSeparator
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable

public final class GradientSeparator
extends JComponent

A component that paints a horizontal or vertical gradient background. The gradient consists of two sections that are specified by three colors: start, middle and stop.

The location of the middle color can be defined by a float value in the interval [0, 1], with 0f for the left hand side, 0.5f for the center, and 1f for the right hand side.

Version:
$Revision: 1.6 $
Author:
Karsten Lentzsch
See Also:
Serialized Form

Nested Class Summary
 
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
static float BOTTOM
          Bottom middle color proportion in vertical gradients.
static float CENTER
          Centered middle color proportion in vertical gradients.
static int HORIZONTAL
          Constant for horizontal gradients.
static float LEFT
          Left hand middle color proportion in horizontal gradients.
static float MIDDLE
          Middle middle color proportion in horizontal gradients.
static float RIGHT
          Right hand middle color proportion in horizontal gradients.
static float TOP
          Top middle color proportion in vertical gradients.
static int VERTICAL
          Constant for vertical gradients.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
GradientSeparator(int orientation, Color startColor, Color middleColor, Color stopColor, float middleProportion)
          Constructs a GradientSeparator with the specified orientation, gradient colors, and gradient middle location.
 
Method Summary
static GradientSeparator createHorizontalGradient(Color color)
          Creates and returns a GradientSeparator with a centered horizontal gradient that has the specified color in the middle and is transparent on both sides.
static GradientSeparator createHorizontalGradient(Color startColor, Color middleColor)
          Creates and returns a GradientSeparator with a two-section horizontal gradient described by two colors.
static GradientSeparator createHorizontalGradient(Color startColor, Color middleColor, Color stopColor)
          Creates and returns a GradientSeparator with a two-section horizontal gradient described by three colors.
static GradientSeparator createSingleHorizontalGradient(Color startColor, Color stopColor)
          Creates and returns a GradientSeparator with a single horizontal gradient described by two colors.
static GradientSeparator createSingleVerticalGradient(Color startColor, Color stopColor)
          Creates and returns a GradientSeparator with a single vertical gradient described by two colors.
static GradientSeparator createVerticalGradient(Color baseColor)
          Creates and returns a GradientSeparator with a two-section vertical gradient that has the specified color in the center and is transparent on both ends.
static GradientSeparator createVerticalGradient(Color startColor, Color middleColor)
          Creates and returns a GradientSeparator with a two-section vertical gradient described by two colors.
static GradientSeparator createVerticalGradient(Color startColor, Color middleColor, Color stopColor)
          Creates and returns a GradientSeparator with a two-section vertical gradient described by three colors.
protected  void paintComponent(Graphics g)
          Paints a background composed of two gradients.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI
 
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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

HORIZONTAL

public static final int HORIZONTAL
Constant for horizontal gradients.

See Also:
Constant Field Values

VERTICAL

public static final int VERTICAL
Constant for vertical gradients.

See Also:
Constant Field Values

LEFT

public static final float LEFT
Left hand middle color proportion in horizontal gradients.

See Also:
Constant Field Values

TOP

public static final float TOP
Top middle color proportion in vertical gradients.

See Also:
Constant Field Values

MIDDLE

public static final float MIDDLE
Middle middle color proportion in horizontal gradients.

See Also:
Constant Field Values

CENTER

public static final float CENTER
Centered middle color proportion in vertical gradients.

See Also:
Constant Field Values

RIGHT

public static final float RIGHT
Right hand middle color proportion in horizontal gradients.

See Also:
Constant Field Values

BOTTOM

public static final float BOTTOM
Bottom middle color proportion in vertical gradients.

See Also:
Constant Field Values
Constructor Detail

GradientSeparator

public GradientSeparator(int orientation,
                         Color startColor,
                         Color middleColor,
                         Color stopColor,
                         float middleProportion)
Constructs a GradientSeparator with the specified orientation, gradient colors, and gradient middle location.

Method Detail

createSingleHorizontalGradient

public static GradientSeparator createSingleHorizontalGradient(Color startColor,
                                                               Color stopColor)
Creates and returns a GradientSeparator with a single horizontal gradient described by two colors.


createHorizontalGradient

public static GradientSeparator createHorizontalGradient(Color color)
Creates and returns a GradientSeparator with a centered horizontal gradient that has the specified color in the middle and is transparent on both sides.


createHorizontalGradient

public static GradientSeparator createHorizontalGradient(Color startColor,
                                                         Color middleColor)
Creates and returns a GradientSeparator with a two-section horizontal gradient described by two colors.


createHorizontalGradient

public static GradientSeparator createHorizontalGradient(Color startColor,
                                                         Color middleColor,
                                                         Color stopColor)
Creates and returns a GradientSeparator with a two-section horizontal gradient described by three colors.


createSingleVerticalGradient

public static GradientSeparator createSingleVerticalGradient(Color startColor,
                                                             Color stopColor)
Creates and returns a GradientSeparator with a single vertical gradient described by two colors.


createVerticalGradient

public static GradientSeparator createVerticalGradient(Color baseColor)
Creates and returns a GradientSeparator with a two-section vertical gradient that has the specified color in the center and is transparent on both ends.


createVerticalGradient

public static GradientSeparator createVerticalGradient(Color startColor,
                                                       Color middleColor)
Creates and returns a GradientSeparator with a two-section vertical gradient described by two colors.


createVerticalGradient

public static GradientSeparator createVerticalGradient(Color startColor,
                                                       Color middleColor,
                                                       Color stopColor)
Creates and returns a GradientSeparator with a two-section vertical gradient described by three colors.


paintComponent

protected void paintComponent(Graphics g)
Paints a background composed of two gradients.

Overrides:
paintComponent in class JComponent


Copyright © 2000-2008 JGoodies Karsten Lentzsch. All Rights Reserved.