org.pushingpixels.substance.api.painter.decoration.FractionBasedDecorationPainter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of substance Show documentation
Show all versions of substance Show documentation
A fork of @kirilcool's substance project
/*
* Copyright (c) 2005-2010 Substance Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Substance Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.substance.api.painter.decoration;
import java.awt.*;
import java.awt.MultipleGradientPaint.CycleMethod;
import java.util.HashSet;
import java.util.Set;
import javax.swing.SwingUtilities;
import org.pushingpixels.substance.api.*;
import org.pushingpixels.substance.api.painter.FractionBasedPainter;
import org.pushingpixels.substance.api.painter.SubstancePainterUtils;
/**
* Decoration painter with fraction-based stops and a color query associated
* with each stop. This class allows creating multi-gradient decorations with
* exact control over which color is used at every gradient control point.
*
* @author Kirill Grouchnikov
*/
public class FractionBasedDecorationPainter extends FractionBasedPainter
implements SubstanceDecorationPainter {
private Set decoratedAreas;
/**
* Creates a new fraction-based decoration painter.
*
* @param displayName
* The display name of this painter.
* @param fractions
* The fractions of this painter. Must be strictly increasing,
* starting from 0.0 and ending at 1.0.
* @param colorQueries
* The color queries of this painter. Must have the same size as
* the fractions array, and all entries must be non-
* null.
*/
public FractionBasedDecorationPainter(String displayName,
float[] fractions, ColorSchemeSingleColorQuery[] colorQueries) {
this(displayName, fractions, colorQueries,
DecorationAreaType.PRIMARY_TITLE_PANE,
DecorationAreaType.SECONDARY_TITLE_PANE);
}
/**
* Creates a new fraction-based decoration painter.
*
* @param displayName
* The display name of this painter.
* @param fractions
* The fractions of this painter. Must be strictly increasing,
* starting from 0.0 and ending at 1.0.
* @param colorQueries
* The color queries of this painter. Must have the same size as
* the fractions array, and all entries must be non-
* null.
* @param decorationAreas
* Decoration areas that should be painted based on the color
* queries. All the rest will be filled with a solid color from
* the background color scheme of the matching decoration area.
*/
public FractionBasedDecorationPainter(String displayName,
float[] fractions, ColorSchemeSingleColorQuery[] colorQueries,
DecorationAreaType... decorationAreas) {
super(displayName, fractions, colorQueries);
this.decoratedAreas = new HashSet();
if (decorationAreas != null) {
for (DecorationAreaType decorationArea : decorationAreas) {
this.decoratedAreas.add(decorationArea);
}
}
}
@Override
public void paintDecorationArea(Graphics2D graphics, Component comp,
DecorationAreaType decorationAreaType, int width, int height,
SubstanceSkin skin) {
if (this.decoratedAreas.contains(decorationAreaType)) {
this.paintDecoratedBackground(graphics, comp, decorationAreaType,
width, height, skin
.getBackgroundColorScheme(decorationAreaType));
} else {
this.paintSolidBackground(graphics, comp, width, height, skin
.getBackgroundColorScheme(decorationAreaType));
}
}
private void paintDecoratedBackground(Graphics2D graphics, Component comp,
DecorationAreaType decorationAreaType, int width, int height,
SubstanceColorScheme scheme) {
Graphics2D g2d = (Graphics2D) graphics.create();
Color[] fillColors = new Color[this.fractions.length];
for (int i = 0; i < this.fractions.length; i++) {
ColorSchemeSingleColorQuery colorQuery = this.colorQueries[i];
fillColors[i] = colorQuery.query(scheme);
}
Component topMostWithSameDecorationAreaType = SubstancePainterUtils
.getTopMostParentWithDecorationAreaType(comp,
decorationAreaType);
Point inTopMost = SwingUtilities.convertPoint(comp, new Point(0, 0),
topMostWithSameDecorationAreaType);
int dy = inTopMost.y;
MultipleGradientPaint gradient = new LinearGradientPaint(0, 0, 0,
topMostWithSameDecorationAreaType.getHeight(), this.fractions,
fillColors, CycleMethod.REPEAT);
g2d.setPaint(gradient);
g2d.translate(0, -dy);
g2d
.fillRect(0, 0, width, topMostWithSameDecorationAreaType
.getHeight());
g2d.dispose();
}
private void paintSolidBackground(Graphics2D graphics, Component comp,
int width, int height, SubstanceColorScheme scheme) {
graphics.setColor(scheme.getMidColor());
graphics.fillRect(0, 0, width, height);
}
}