org.wings.border.SBevelBorder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.border;

import java.awt.*;

/**
 * Draw a beveled border around a component.
 * RAISED
 * LOWERED
 *
 * @author Armin Haaf
 * @author Andre Lison
 */
public class SBevelBorder
        extends SAbstractBorder
{
    public static final int RAISED = 0;
    public static final int LOWERED = 1;

    private int bevelType = RAISED;

    /**
     * Creates a new beveled raised border.
     */
    public SBevelBorder() {
        setBevelType(RAISED);
    }

    /**
     * Creates a new beveled border with the given type.
     *
     * @param bevelType one of the following constants:
     *                  RAISED or LOWERED
     */
    public SBevelBorder(int bevelType) {
        setBevelType(bevelType);
    }

    /**
     * Creates a new beveled border with the given type and insets.
     *
     * @param bevelType one of the following constants:
     *                  RAISED or LOWERED
     * @param insets   (space between border and component) around
     */
    public SBevelBorder(int bevelType, Insets insets) {
        super(Color.GRAY, 2, insets);
        setBevelType(bevelType);
    }

    /**
     * Creates a new beveled border with the given type, insets and
     * border thickness
     *
     * @param bevelType one of the following constants:
     *                  RAISED or LOWERED
     * @param insets    padding (space between border and component) around
     * @param thickness the thickness of drawn line
     */
    public SBevelBorder(int bevelType, Insets insets, int thickness) {
        super(Color.GRAY, thickness, insets);
        setBevelType(bevelType);
    }

    /**
     * sets the bevel type.
     *
     * @param bevelType one of the following constants:
     *                  RAISED or LOWERED
     */
    public void setBevelType(int bevelType) {
        this.bevelType = bevelType;
        setStyle(bevelType == RAISED ? "outset" : "inset");
    }

    /**
     * returns the bevel type.
     *
     * @return the current bevel type
     * @see #setBevelType
     */
    public int getBevelType() {
        return bevelType;
    }
}