Java example source code file (ToolBarSeparatorPainter.java)

This example Java source code file (ToolBarSeparatorPainter.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

abstractregionpainter, awt, dimension, gui, inset, insets, jcomponent, object, override, paintcontext, space, swing, toolbarseparatorpainter

The ToolBarSeparatorPainter.java Java example source code

/*
 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.swing.plaf.nimbus;

import javax.swing.plaf.nimbus.AbstractRegionPainter.PaintContext.CacheMode;
import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Insets;
import javax.swing.JComponent;

/**
 * A special painter implementation for tool bar separators in Nimbus.
 * The designer tool doesn't have support for painters which render
 * repeated patterns, but that's exactly what the toolbar separator design
 * is for Nimbus. This custom painter is designed to handle this situation.
 * When support is added to the design tool / code generator to deal with
 * repeated patterns, then we can remove this class.
 * <p>
 */
final class ToolBarSeparatorPainter extends AbstractRegionPainter {
    private static final int SPACE = 3;
    private static final int INSET = 2;

    @Override
    protected PaintContext getPaintContext() {
        //the paint context returned will have a few dummy values. The
        //implementation of doPaint doesn't bother with the "decode" methods
        //but calculates where to paint the circles manually. As such, we
        //only need to indicate in our PaintContext that we don't want this
        //to ever be cached
        return new PaintContext(
                new Insets(1, 0, 1, 0),
                new Dimension(38, 7),
                false, CacheMode.NO_CACHING, 1, 1);
    }

    @Override
    protected void doPaint(Graphics2D g, JComponent c, int width, int height, Object[] extendedCacheKeys) {
        //it is assumed that in the normal orientation the separator renders
        //horizontally. Other code rotates it as necessary for a vertical
        //separator.
        g.setColor(c.getForeground());
        int y = height / 2;
        for (int i=INSET; i<=width-INSET; i+=SPACE) {
            g.fillRect(i, y, 1, 1);
        }
    }
}