// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition          
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it. 
// =========================================================================

//  This file is part of the AIDA library
//  Copyright (C) 2002 by the AIDA team.  All rights reserved.
//  This library is free software and under the terms of the
//  GNU Library General Public License described in the LGPL.txt 
package hep.aida;


/**
 * Generic style for any "scene part" on the plot. Scene parts are independent
 * plottable objects like statistics and legend box, data area, title area etc etc.
 *
 * @author The AIDA team (http://aida.freehep.org/)
 *
 */

public interface IBoxStyle extends IBaseStyle {

  /**
   * Get the IFillStyle that controls the background of the scene part.
   * @return The background IFillStyle.
   *
   */
    public IFillStyle backgroundStyle();

    public boolean setBackgroundStyle(IFillStyle fillStyle);

  /**
   * Get the IFillStyle that controls the foreground of the scene part.
   * The foreground controls the color of what appears in front unless otherwise
   * specified by other styles. (Is this really needed?)
   * @return The foreground IFillStyle.
   *
   */
    public IFillStyle foregroundStyle();

    public boolean setForegroundStyle(IFillStyle fillStyle);

  /**
   * Get the border style of the scene part.
   * @return The border style.
   *
   */
    public IBorderStyle borderStyle();

    public boolean setBorderStyle(IBorderStyle borderStyle);

  /**
   * Set and get the x and y coordinate of the box's origin.
   *
   */
    public boolean setX(double x);

    public boolean setY(double y);

    public double x();

    public double y();

  /**
   * Set and get the height and the width of the box.
   *
   */
    public boolean setHeight(double height);

    public boolean setWidth(double width);

    public double height();

    public double width();

  /**
   * Get and specify the origin's definition.
   * The default is BOTTOM_LEFT.
   *
   */
    public boolean setPlacement(int originDefinition);

    public int placement();

  /**
   * Get and specify the definition of the units used for the size and origin's position.
   * The default is PIXELS.
   *
   */
    public boolean setUnits(int unitsDefinition);

    public int units();

  /**
   * Constants specifying position of the box's origin.
   *
   */
    public final static int BOTTOM_LEFT = 0, MIDDLE_LEFT = 1, TOP_LEFT = 2, TOP_CENTER = 3, TOP_RIGHT = 4, MIDDLE_RIGHT = 5, BOTTOM_RIGHT = 6, BOTTOM_CENTER = 7, CENTER = 8;
} // class or interface