/*
 * @(#)JPTConstants.java    2.4.0  5 July 2005
 *
 * Copyright 2005
 * College of Computer and Information Science
 * Northeastern University
 * Boston, MA  02115
 *
 * The Java Power Tools software may be used for educational
 * purposes as long as this copyright notice is retained intact
 * at the top of all source files.
 *
 * To discuss possible commercial use of this software, 
 * contact Richard Rasala at Northeastern University, 
 * College of Computer and Information Science,
 * 617-373-2462 or rasala@ccs.neu.edu.
 *
 * The Java Power Tools software has been designed and built
 * in collaboration with Viera Proulx and Jeff Raab.
 *
 * Should this software be modified, the words "Modified from 
 * Original" must be included as a comment below this notice.
 *
 * All publication rights are retained.  This software or its 
 * documentation may not be published in any media either
 * in whole or in part without explicit permission.
 *
 * This software was created with support from Northeastern 
 * University and from NSF grant DUE-9950829.
 */

package edu.neu.ccs.util;

import edu.neu.ccs.XObject;

import java.awt.BorderLayout;
import javax.swing.*;

/**
 * <P>Interface that provides common shared 
 * constant values for classes in the JPT.</P>
 *
 * @author  Jeff Raab
 * @author  Richard Rasala
 * @version 2.4.0
 * @since   1.0
 */
public interface JPTConstants extends SwingConstants {

    /** 
     * Value designating a request for 
     * the default value of a property. 
     */
    public static final int DEFAULT = -1;

    /** 
     * Value designating the top 
     * of a border style layout. 
     */
    public static final int ABOVE = TOP;

    /** 
     * Value designating the bottom 
     * of a border style layout. 
     */
    public static final int BELOW = BOTTOM;
    
    /**
     * Value designating top-left justification.
     *
     * @since 1.1
     */
    public static final int TOP_LEFT = 5;
    
    /**
     * Value designating top-right justification.
     *
     * @since 1.1
     */
    public static final int TOP_RIGHT = 6;
    
    /**
     * Value designating bottom-right justification.
     *
     * @since 1.1
     */
    public static final int BOTTOM_RIGHT = 7;
    
    /**
     * Value designating bottom-left justification.
     *
     * @since 1.1
     */
    public static final int BOTTOM_LEFT = 8;
    
    /** Value designating a mandatory input operation. */
    public static final int MANDATORY = 0;
    
    /** 
     * Value designating an input operation 
     * that may be cancelled on error. 
     */
    public static final int OPTIONAL = 1;
    
    /** 
     * Bound property name for 
     * the input properties of an object. 
     */
    public static final String INPUT_PROPERTIES =
        "input.properties";
        
    /** 
     * Bound property name for 
     * the orientation of a linear container.
     */
    public static final String ORIENTATION = "orientation";

    /** 
     * Bound property name for 
     * the alignment of a decoration for a component.
     */
    public static final String ALIGNMENT = "alignment";
    
    /** Bound property name for the set font property. */
    public static final String FONT = "set.font";
    
    /**
     * <p>Bound property name for the value property
     * that indicates that a value has been set.</p>
     *
     * <p>Copied from <code>edu.neu.ccs.XObject</code>.</p>
     */
    public static final String VALUE = XObject.VALUE;

}