1 /* 2 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.java.accessibility.extensions; 27 28 import javax.accessibility.*; 29 30 /** 31 * <P>Class AccessibleExtendedRelation contains extensions to the class 32 * AccessibleRelation that are currently not in a public API. 33 * 34 * <P>Class AccessibleRelation describes a relation between the 35 * object that implements the AccessibleRelation and one or more other 36 * objects. The actual relations that an object has with other 37 * objects are defined as an AccessibleRelationSet, which is a composed 38 * set of AccessibleRelations. 39 * <p>The toDisplayString method allows you to obtain the localized string 40 * for a locale independent key from a predefined ResourceBundle for the 41 * keys defined in this class. 42 * <p>The constants in this class present a strongly typed enumeration 43 * of common object roles. If the constants in this class are not sufficient 44 * to describe the role of an object, a subclass should be generated 45 * from this class and it should provide constants in a similar manner. 46 * 47 */ 48 49 public abstract class AccessibleExtendedRelationConstants 50 extends AccessibleRelation { 51 52 /** 53 * Indicates that one AccessibleText object is linked to the 54 * target AccessibleText object(s). <p> A good example is a StarOffice 55 * text window with the bottom of one page, a footer, a header, 56 * and the top of another page all visible in the window. There 57 * should be a FLOWS_TO relation from the last chunk of AccessibleText 58 * in the bottom of one page to the first AccessibleText object at the 59 * top of the next page, skipping over the AccessibleText object(s) 60 * that make up the header and footer. A corresponding FLOWS_FROM 61 * relation would link the AccessibleText object in the next page to 62 * the last one in the previous page. 63 * @see AccessibleExtendedRole.FLOWS_FROM 64 */ 65 public static final String FLOWS_TO = "flowsTo"; 66 67 /** 68 * Indicates that one AccessibleText object is linked to the 69 * target AccessibleText object(s). 70 * @see AccessibleExtendedRole.FLOWS_TO 71 */ 72 public static final String FLOWS_FROM = "flowsFrom"; 73 74 /** 75 * Indicates a component is a subwindow of a target component 76 */ 77 public static final String SUBWINDOW_OF = "subwindowOf"; 78 79 /** 80 * Identifies that the linkage between one AccessibleText 81 * object and the target AccessibleText object(s) has changed. 82 * @see AccessibleExtendedRole.FLOWS_TO 83 * @see AccessibleExtendedRole.FLOWS_FROM 84 */ 85 public static final String FLOWS_TO_PROPERTY = "flowsToProperty"; 86 87 /** 88 * Identifies that the linkage between one AccessibleText 89 * object and the target AccessibleText object(s) has changed. 90 * @see AccessibleExtendedRole.FLOWS_TO 91 * @see AccessibleExtendedRole.FLOWS_FROM 92 */ 93 public static final String FLOWS_FROM_PROPERTY = "flowsFromProperty"; 94 95 /** 96 * Identifies the subwindow relationship between two components 97 * has changed 98 */ 99 public static final String SUBWINDOW_OF_PROPERTY = "subwindowOfProperty"; 100 101 public AccessibleExtendedRelationConstants(String s) { 102 super(s); 103 } 104 105 public AccessibleExtendedRelationConstants(String key, Object target) { 106 super(key, target); 107 } 108 }