/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package com.sun.java.accessibility.extensions;

import javax.accessibility.*;

/**
 * <P>Class AccessibleExtendedRelation contains extensions to the class
 * AccessibleRelation that are currently not in a public API.
 *
 * <P>Class AccessibleRelation describes a relation between the
 * object that implements the AccessibleRelation and one or more other
 * objects.  The actual relations that an object has with other
 * objects are defined as an AccessibleRelationSet, which is a composed
 * set of AccessibleRelations.
 * <p>The toDisplayString method allows you to obtain the localized string
 * for a locale independent key from a predefined ResourceBundle for the
 * keys defined in this class.
 * <p>The constants in this class present a strongly typed enumeration
 * of common object roles. If the constants in this class are not sufficient
 * to describe the role of an object, a subclass should be generated
 * from this class and it should provide constants in a similar manner.
 *
 */

public abstract class AccessibleExtendedRelationConstants
    extends AccessibleRelation {

    /**
     * Indicates that one AccessibleText object is linked to the
     * target AccessibleText object(s). <p> A good example is a StarOffice
     * text window with the bottom of one page, a footer, a header,
     * and the top of another page all visible in the window.  There
     * should be a FLOWS_TO relation from the last chunk of AccessibleText
     * in the bottom of one page to the first AccessibleText object at the
     * top of the next page, skipping over the AccessibleText object(s)
     * that make up the header and footer. A corresponding FLOWS_FROM
     * relation would link the AccessibleText object in the next page to
     * the last one in the previous page.
     * @see AccessibleExtendedRole.FLOWS_FROM
     */
    public static final String FLOWS_TO = "flowsTo";

    /**
     * Indicates that one AccessibleText object is linked to the
     * target AccessibleText object(s).
     * @see AccessibleExtendedRole.FLOWS_TO
     */
    public static final String FLOWS_FROM = "flowsFrom";

    /**
     * Indicates a component is a subwindow of a target component
     */
    public static final String SUBWINDOW_OF = "subwindowOf";

    /**
     * Identifies that the linkage between one AccessibleText
     * object and the target AccessibleText object(s) has changed.
     * @see AccessibleExtendedRole.FLOWS_TO
     * @see AccessibleExtendedRole.FLOWS_FROM
     */
    public static final String FLOWS_TO_PROPERTY = "flowsToProperty";

    /**
     * Identifies that the linkage between one AccessibleText
     * object and the target AccessibleText object(s) has changed.
     * @see AccessibleExtendedRole.FLOWS_TO
     * @see AccessibleExtendedRole.FLOWS_FROM
     */
    public static final String FLOWS_FROM_PROPERTY = "flowsFromProperty";

    /**
     * Identifies the subwindow relationship between two components
     * has changed
     */
    public static final String SUBWINDOW_OF_PROPERTY = "subwindowOfProperty";

    public AccessibleExtendedRelationConstants(String s) {
        super(s);
    }

    public AccessibleExtendedRelationConstants(String key, Object target) {
        super(key, target);
    }
}