1 /*
   2  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
   4  */
   5 
   6 package com.sun.java.accessibility.extensions;
   7 
   8 import javax.accessibility.*;
   9 
  10 /**
  11  * <P>Class AccessibleExtendedRelation contains extensions to the class
  12  * AccessibleRelation that are currently not in a public API.
  13  *
  14  * <P>Class AccessibleRelation describes a relation between the
  15  * object that implements the AccessibleRelation and one or more other
  16  * objects.  The actual relations that an object has with other
  17  * objects are defined as an AccessibleRelationSet, which is a composed
  18  * set of AccessibleRelations.
  19  * <p>The toDisplayString method allows you to obtain the localized string
  20  * for a locale independent key from a predefined ResourceBundle for the
  21  * keys defined in this class.
  22  * <p>The constants in this class present a strongly typed enumeration
  23  * of common object roles. If the constants in this class are not sufficient
  24  * to describe the role of an object, a subclass should be generated
  25  * from this class and it should provide constants in a similar manner.
  26  *
  27  */
  28 
  29 public abstract class AccessibleExtendedRelationConstants
  30     extends AccessibleRelation {
  31 
  32     /**
  33      * Indicates that one AccessibleText object is linked to the
  34      * target AccessibleText object(s). <p> A good example is a StarOffice
  35      * text window with the bottom of one page, a footer, a header,
  36      * and the top of another page all visible in the window.  There
  37      * should be a FLOWS_TO relation from the last chunk of AccessibleText
  38      * in the bottom of one page to the first AccessibleText object at the
  39      * top of the next page, skipping over the AccessibleText object(s)
  40      * that make up the header and footer. A corresponding FLOWS_FROM
  41      * relation would link the AccessibleText object in the next page to
  42      * the last one in the previous page.
  43      * @see AccessibleExtendedRole.FLOWS_FROM
  44      */
  45     public static final String FLOWS_TO = "flowsTo";
  46 
  47     /**
  48      * Indicates that one AccessibleText object is linked to the
  49      * target AccessibleText object(s).
  50      * @see AccessibleExtendedRole.FLOWS_TO
  51      */
  52     public static final String FLOWS_FROM = "flowsFrom";
  53 
  54     /**
  55      * Indicates a component is a subwindow of a target component
  56      */
  57     public static final String SUBWINDOW_OF = "subwindowOf";
  58 
  59     /**
  60      * Identifies that the linkage between one AccessibleText
  61      * object and the target AccessibleText object(s) has changed.
  62      * @see AccessibleExtendedRole.FLOWS_TO
  63      * @see AccessibleExtendedRole.FLOWS_FROM
  64      */
  65     public static final String FLOWS_TO_PROPERTY = "flowsToProperty";
  66 
  67     /**
  68      * Identifies that the linkage between one AccessibleText
  69      * object and the target AccessibleText object(s) has changed.
  70      * @see AccessibleExtendedRole.FLOWS_TO
  71      * @see AccessibleExtendedRole.FLOWS_FROM
  72      */
  73     public static final String FLOWS_FROM_PROPERTY = "flowsFromProperty";
  74 
  75     /**
  76      * Identifies the subwindow relationship between two components
  77      * has changed
  78      */
  79     public static final String SUBWINDOW_OF_PROPERTY = "subwindowOfProperty";
  80 
  81     public AccessibleExtendedRelationConstants(String s) {
  82         super(s);
  83     }
  84 
  85     public AccessibleExtendedRelationConstants(String key, Object target) {
  86         super(key, target);
  87     }
  88 }