1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
/* * @(#)Element.java 1.24 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.text; /** * Interface to describe a structural piece of a document. It * is intended to capture the spirit of an SGML element. * * @author Timothy Prinzing * @version 1.24 11/17/05 */ public interface Element { /** * Fetches the document associated with this element. * * @return the document */ public Document getDocument(); /** * Fetches the parent element. If the element is a root level * element returns <code>null</code>. * * @return the parent element */ public Element getParentElement(); /** * Fetches the name of the element. If the element is used to * represent some type of structure, this would be the type * name. * * @return the element name */ public String getName(); /** * Fetches the collection of attributes this element contains. * * @return the attributes for the element */ public AttributeSet getAttributes(); /** * Fetches the offset from the beginning of the document * that this element begins at. If this element has * children, this will be the offset of the first child. * As a document position, there is an implied forward bias. * * @return the starting offset >= 0 and < getEndOffset(); * @see Document * @see AbstractDocument */ public int getStartOffset(); /** * Fetches the offset from the beginning of the document * that this element ends at. If this element has * children, this will be the end offset of the last child. * As a document position, there is an implied backward bias. * <p> * All the default <code>Document</code> implementations * descend from <code>AbstractDocument</code>. * <code>AbstractDocument</code> models an implied break at the end of * the document. As a result of this, it is possible for this to * return a value greater than the length of the document. * * @return the ending offset > getStartOffset() and * <= getDocument().getLength() + 1 * @see Document * @see AbstractDocument */ public int getEndOffset(); /** * Gets the child element index closest to the given offset. * The offset is specified relative to the beginning of the * document. Returns <code>-1</code> if the * <code>Element</code> is a leaf, otherwise returns * the index of the <code>Element</code> that best represents * the given location. Returns <code>0</code> if the location * is less than the start offset. Returns * <code>getElementCount() - 1</code> if the location is * greater than or equal to the end offset. * * @param offset the specified offset >= 0 * @return the element index >= 0 */ public int getElementIndex(int offset); /** * Gets the number of child elements contained by this element. * If this element is a leaf, a count of zero is returned. * * @return the number of child elements >= 0 */ public int getElementCount(); /** * Fetches the child element at the given index. * * @param index the specified index >= 0 * @return the child element */ public Element getElement(int index); /** * Is this element a leaf element? An element that * <i>may</i> have children, even if it currently * has no children, would return <code>false</code>. * * @return true if a leaf element else false */ public boolean isLeaf(); }