001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.editor.highlighting;
043:
044: /**
045: * The container of highlighted areas and their attributes.
046: *
047: * @author vita
048: */
049: public interface HighlightsContainer {
050:
051: /**
052: * The attribute key for highlights that need to span across a whole line.
053: *
054: * <p>Typically highlights only affect rendering of a small part of text
055: * (perhaps just several characters). Some layers, however, need to highlight
056: * a whole line in an editor window regardless of how much text the line
057: * contains. The highlighting of a line with a caret is an example of such a layer.
058: *
059: * <p>If you want a highlight that spans accross the whole editor pane you
060: * can add this attribute key to the highlight's <code>AttributeSet</code>
061: * and set its value to <code>Boolean.TRUE</code>. The highlighted area must
062: * contain the new-line character at the end of the line.
063: */
064: static final String ATTR_EXTENDS_EOL = new String(
065: "org.netbeans.spi.editor.highlighting.HighlightsContainer.ATTR_EXTENDS_EOL"); //NOI18N
066:
067: /**
068: * The attribute key for highlights that need to show up on empty lines.
069: *
070: * <p>If you use this key for a highlight which contains the new-line character
071: * at the end of an empty line and set the value of this attribute to
072: * <code>Boolean.TRUE</code> then the highlight will be drawn as
073: * a half-character-wide stripe at the beginning of the line.
074: */
075: static final String ATTR_EXTENDS_EMPTY_LINE = new String(
076: "org.netbeans.spi.editor.highlighting.HighlightsContainer.ATTR_EXTENDS_EMPTY_LINE"); //NOI18N
077:
078: /**
079: * Provides the list of highlighted areas that should be used for rendering
080: * a document.
081: *
082: * <p>The returned highlighted areas (highlights) must obey the following rules:
083: * <ul>
084: * <li>The starting and ending offsets of each highlight should be
085: * within the range specified by the <code>startOffset</code> and <code>endOffset</code>
086: * parameters. Any highlights outside of this range will be clipped by the
087: * rendering infrastructure.
088: * <li>The highlights must not overlap. The infrastructure may ignore or trim
089: * any overlapping highlights.
090: * <li>The list of highlights must be sorted by their
091: * starting offsets ascendingly (i.e. the smallest offset first).
092: * </ul>
093: *
094: * <p>The editor infrastructure will log any problems it may encounter with
095: * provided implementations of this interface. Although the infrastructure
096: * will try to do its best to render all highlights supplied by the implementors,
097: * if the above rules are violated the results can't be garanteed.
098: *
099: * @param startOffset The starting offset of the area which the caller
100: * attempts to repaint (or create views for). The staring offset is always >=0.
101: * @param endOffset The ending offset of the rendered area. The <code>Integer.MAX_VALUE</code>
102: * can be passed in if the end offset is unknown to the caller.
103: * The highlights container is then expected to return all highlights
104: * up to the end of the document.
105: *
106: * @return non-null iterator of highlights sorted by offsets.
107: */
108: HighlightsSequence getHighlights(int startOffset, int endOffset);
109:
110: /**
111: * Adds a listener to this highlights container.
112: *
113: * @param listener The listener to add.
114: */
115: void addHighlightsChangeListener(HighlightsChangeListener listener);
116:
117: /**
118: * Removes a listener from this highlights container.
119: *
120: * @param listener The listener to remove.
121: */
122: void removeHighlightsChangeListener(
123: HighlightsChangeListener listener);
124:
125: }
|