org.pushingpixels.substance.internal.utils.icon

Class TransitionAwareIcon

java.lang.Object

org.pushingpixels.substance.internal.utils.icon.TransitionAwareIcon

All Implemented Interfaces:

javax.swing.Icon

public class TransitionAwareIcon
extends java.lang.Object
implements javax.swing.Icon

Icon with transition-aware capabilities. Has a delegate that does the actual painting based on the transition color schemes. This class is used heavily on Substance-provided icons, such as title pane button icons, arrow icons on scroll bars and combos etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TransitionAwareIcon.ColorSchemeAssociationKindDelegate
static interface	TransitionAwareIcon.Delegate The delegate needs to implement the method in this interface based on the provided color scheme.
static interface	TransitionAwareIcon.TransitionAwareUIDelegate

Field Summary

Fields

Modifier and Type	Field and Description
protected TransitionAwareIcon.ColorSchemeAssociationKindDelegate	colorSchemeAssociationKindDelegate
protected TransitionAwareIcon.Delegate	delegate Delegate to compute the actual icons.
protected java.lang.String	uniqueIconTypeId

Constructor Summary

Constructors

Constructor and Description
TransitionAwareIcon(javax.swing.AbstractButton button, TransitionAwareIcon.Delegate delegate, java.lang.String uniqueIconTypeId)
TransitionAwareIcon(javax.swing.JComponent comp, TransitionAwareIcon.TransitionAwareUIDelegate transitionAwareUIDelegate, TransitionAwareIcon.Delegate delegate, TransitionAwareIcon.ColorSchemeAssociationKindDelegate colorSchemeAssociationKindDelegate, java.lang.String uniqueIconTypeId) Creates a new transition-aware icon.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIconHeight()
int	getIconWidth()
void	paintIcon(java.awt.Component c, java.awt.Graphics g, int x, int y)

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected TransitionAwareIcon.Delegate delegate

Delegate to compute the actual icons.

colorSchemeAssociationKindDelegate

protected TransitionAwareIcon.ColorSchemeAssociationKindDelegate colorSchemeAssociationKindDelegate

uniqueIconTypeId

protected java.lang.String uniqueIconTypeId

Constructor Detail

TransitionAwareIcon

public TransitionAwareIcon(javax.swing.AbstractButton button,
                   TransitionAwareIcon.Delegate delegate,
                   java.lang.String uniqueIconTypeId)

TransitionAwareIcon

public TransitionAwareIcon(javax.swing.JComponent comp,
                   TransitionAwareIcon.TransitionAwareUIDelegate transitionAwareUIDelegate,
                   TransitionAwareIcon.Delegate delegate,
                   TransitionAwareIcon.ColorSchemeAssociationKindDelegate colorSchemeAssociationKindDelegate,
                   java.lang.String uniqueIconTypeId)

Creates a new transition-aware icon.

Parameters:

comp - Associated component.

delegate - Delegate to compute the actual icons.

Method Detail

getIconHeight

public int getIconHeight()

Specified by:

getIconHeight in interface javax.swing.Icon

getIconWidth

public int getIconWidth()

Specified by:

getIconWidth in interface javax.swing.Icon

paintIcon

public void paintIcon(java.awt.Component c,
             java.awt.Graphics g,
             int x,
             int y)

Specified by:

paintIcon in interface javax.swing.Icon