Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.tools.swing.api;

import javax.swing.Icon;

/**

 *

 * @author jjdelcerro

 */

public interface CompoundIcon extends Icon {

    public static final int STACKED = -1;

    /**

     * Get the alignment of the icon on the x-axis

     *

     * @return the alignment

     */

    float getAlignmentX();

    /**

     * Get the alignment of the icon on the y-axis

     *

     * @return the alignment

     */

    float getAlignmentY();

    /**

     * Get the gap between each icon

     *

     * @return the gap in pixels

     */

    int getGap();

    /**

     * Get the Icon at the specified index.

     *

     * @param index the index of the Icon to be returned

     * @return the Icon at the specifed index

     * @exception IndexOutOfBoundsException if the index is out of range

     */

    Icon getIcon(int index);

    /**

     * Get the number of Icons contained in this CompoundIcon.

     *

     * @return the total number of Icons

     */

    int getIconCount();

    /**

     * Get the orientation along which each icon is painted.

     *

     * @return the orientation

     */

    int getOrientation();

}