org.gvsig.tools.swing.impl

Class DefaultCompoundIcon

java.lang.Object

org.gvsig.tools.swing.impl.DefaultCompoundIcon

All Implemented Interfaces:

javax.swing.Icon, CompoundIcon

public class DefaultCompoundIcon
extends java.lang.Object
implements CompoundIcon

The CompoundIcon will paint two, or more, Icons as a single Icon. The Icons are painted in the order in which they are added. The Icons are layed out on the specified axis:

• X-Axis (horizontally)
• Y-Axis (vertically)
• Z-Axis (stacked)

Field Summary

Fields inherited from interface org.gvsig.tools.swing.api.CompoundIcon

STACKED

Constructor Summary

Constructors

Constructor and Description
DefaultCompoundIcon(javax.swing.Icon... icons) Convenience contructor for creating a CompoundIcon where the icons are layed out HORIZONTAL, the gap is 0 and the X/Y alignments will default to CENTER.
DefaultCompoundIcon(int orientation, javax.swing.Icon... icons) Convenience contructor for creating a CompoundIcon where the gap is 0 and the X/Y alignments will default to CENTER.
DefaultCompoundIcon(int orientation, int gap, javax.swing.Icon... icons) Convenience contructor for creating a CompoundIcon where the X/Y alignments will default to CENTER.
DefaultCompoundIcon(int orientation, int gap, int alignmentX, int alignmentY, javax.swing.Icon... icons) Create a CompoundIcon specifying all the properties.

Method Summary

Modifier and Type	Method and Description
float	getAlignmentX() Get the alignment of the icon on the x-axis
float	getAlignmentY() Get the alignment of the icon on the y-axis
int	getGap() Get the gap between each icon
javax.swing.Icon	getIcon(int index) Get the Icon at the specified index.
int	getIconCount() Get the number of Icons contained in this CompoundIcon.
int	getIconHeight() Gets the height of this icon.
int	getIconWidth() Gets the width of this icon.
int	getOrientation() Get the orientation along which each icon is painted.
void	paintIcon(java.awt.Component c, java.awt.Graphics g, int x, int y) Paint the icons of this compound icon at the specified location

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCompoundIcon

public DefaultCompoundIcon(javax.swing.Icon... icons)

Convenience contructor for creating a CompoundIcon where the icons are layed out HORIZONTAL, the gap is 0 and the X/Y alignments will default to CENTER.

Parameters:

icons - the Icons to be painted as part of the CompoundIcon

DefaultCompoundIcon

public DefaultCompoundIcon(int orientation,
                           javax.swing.Icon... icons)

Convenience contructor for creating a CompoundIcon where the gap is 0 and the X/Y alignments will default to CENTER.

Parameters:

orientation - the orientation used to lay out the icons for painting. Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

icons - the Icons to be painted as part of the CompoundIcon

DefaultCompoundIcon

public DefaultCompoundIcon(int orientation,
                           int gap,
                           javax.swing.Icon... icons)

Convenience contructor for creating a CompoundIcon where the X/Y alignments will default to CENTER.

Parameters:

orientation - the orientation used to lay out the icons for painting. Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

gap - the gap between the icons

icons - the Icons to be painted as part of the CompoundIcon

DefaultCompoundIcon

public DefaultCompoundIcon(int orientation,
                           int gap,
                           int alignmentX,
                           int alignmentY,
                           javax.swing.Icon... icons)

Create a CompoundIcon specifying all the properties.

Parameters:

orientation - the orientation used to lay out the icons for painting. Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

gap - the gap between the icons

alignmentX - the X alignment of the icons. Common values are LEFT, CENTER, RIGHT.

alignmentY - the Y alignment of the icons. Common values are TOP, CENTER, BOTTOM.

icons - the Icons to be painted as part of the CompoundIcon

Method Detail

getOrientation

public int getOrientation()

Get the orientation along which each icon is painted.

Specified by:

getOrientation in interface CompoundIcon

Returns:

the orientation

getGap

public int getGap()

Get the gap between each icon

Specified by:

getGap in interface CompoundIcon

Returns:

the gap in pixels

getAlignmentX

public float getAlignmentX()

Get the alignment of the icon on the x-axis

Specified by:

getAlignmentX in interface CompoundIcon

Returns:

the alignment

getAlignmentY

public float getAlignmentY()

Get the alignment of the icon on the y-axis

Specified by:

getAlignmentY in interface CompoundIcon

Returns:

the alignment

getIconCount

public int getIconCount()

Get the number of Icons contained in this CompoundIcon.

Specified by:

getIconCount in interface CompoundIcon

Returns:

the total number of Icons

getIcon

public javax.swing.Icon getIcon(int index)

Get the Icon at the specified index.

Specified by:

getIcon in interface CompoundIcon

Parameters:

index - the index of the Icon to be returned

Returns:

the Icon at the specifed index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

getIconWidth

public int getIconWidth()

Gets the width of this icon.

Specified by:

getIconWidth in interface javax.swing.Icon

Returns:

the width of the icon in pixels.

getIconHeight

public int getIconHeight()

Gets the height of this icon.

Specified by:

getIconHeight in interface javax.swing.Icon

Returns:

the height of the icon in pixels.

paintIcon

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

Paint the icons of this compound icon at the specified location

Specified by:

paintIcon in interface javax.swing.Icon

Parameters:

c - The component on which the icon is painted

g - the graphics context

x - the X coordinate of the icon's top-left corner

y - the Y coordinate of the icon's top-left corner