UMLModelElementCommentDocument (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.uml.ui
Class UMLModelElementCommentDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.PlainDocument
          org.argouml.uml.ui.UMLPlainTextDocument
              org.argouml.uml.ui.UMLModelElementCommentDocument

All Implemented Interfaces:: Document, EventListener, PropertyChangeListener, Serializable, TargetListener, UMLDocument

public class UMLModelElementCommentDocument
extends UMLPlainTextDocument

This class provides a text field that can be used to display the text of all Comments associated with an annotated ModelElement. TODO: This could use more work. Currently it returns all Comment.name or Comment.body attributes concatenated together into a single read-only document.

Since:: 1 Nov 2005
See Also:: Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary
`UMLModelElementCommentDocument(boolean useBody)` Creates a UMLPlainTextDocument object that represents the text of a Comment associated with a ModelElement

Method Summary
`protected String`	`getProperty()` Get the text of all comments annotating this Model Element
`protected void`	`setProperty(String text)` Add a Comment with the given string TODO: Currently a no-op, doc is read only

Methods inherited from class org.argouml.uml.ui.UMLPlainTextDocument

getEventName, getTarget, insertString, isEditing, propertyChange, remove, setEditing, setEventName, setTarget, targetAdded, targetRemoved, targetSet

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.text.Document

addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, putProperty, removeDocumentListener, removeUndoableEditListener, render

Constructor Detail