Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.text

Interface AbstractDocument.Content

Known Implementing Classes:
GapContent, StringContent
public static interface AbstractDocument.Content
A sequence of data that can be edited. This is were the actual content in AbstractDocument's is stored.

Method Summary

Position
createPosition(int offset)
Creates a Position that keeps track of the location at offset.
void
getChars(int where, int len, Segment txt)
Fetches a piece of content and stores it in txt.
String
getString(int where, int len)
Returns a piece of content.
UndoableEdit
insertString(int where, String str)
Inserts a string into the content model.
int
length()
Returns the length of the content.
UndoableEdit
remove(int where, int nitems)
Removes a piece of content from the content model.

Method Details

createPosition

public Position createPosition(int offset)
            throws BadLocationException
Creates a Position that keeps track of the location at offset.
Returns:
a Position that keeps track of the location at offset.

getChars

public void getChars(int where,
                     int len,
                     Segment txt)
            throws BadLocationException
Fetches a piece of content and stores it in txt.
Parameters:
where - the start offset of the requested fragment
len - the length of the requested fragment
txt - the Segment where to fragment is stored into
Throws:
BadLocationException - if offset or offset + lenis not a valid location in this Content model

getString

public String getString(int where,
                        int len)
            throws BadLocationException
Returns a piece of content.
Parameters:
where - the start offset of the requested fragment
len - the length of the requested fragment
Returns:
the requested fragment
Throws:
BadLocationException - if offset or offset + lenis not a valid location in this Content model

insertString

public UndoableEdit insertString(int where,
                                 String str)
            throws BadLocationException
Inserts a string into the content model.
Parameters:
where - the offset at which to insert the string
str - the string to be inserted
Returns:
an UndoableEdit or null if undo is not supported by this Content model
Throws:
BadLocationException - if where is not a valid location in this Content model

length

public int length()
Returns the length of the content.
Returns:
the length of the content

remove

public UndoableEdit remove(int where,
                           int nitems)
            throws BadLocationException
Removes a piece of content from the content model.
Parameters:
where - the offset at which to remove content
nitems - the number of characters to be removed
Returns:
an UndoableEdit or null if undo is not supported by this Content model
Throws:
BadLocationException - if where is not a valid location in this Content model
AbstractDocument.java -- Copyright (C) 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About