javax.swing.text.html: class: CommentView

javax.swing.text.html
class: CommentView [javadoc | source]

java.lang.Object
   javax.swing.text.View
      javax.swing.text.ComponentView
         javax.swing.text.html.EditableView
            javax.swing.text.html.HiddenTagView
               javax.swing.text.html.CommentView

All Implemented Interfaces:
DocumentListener, SwingConstants

CommentView subclasses HiddenTagView to contain a JTextArea showing a comment. When the textarea is edited the comment is reset. As this inherits from EditableView if the JTextComponent is not editable, the textarea will not be visible.

author: Scott - Violet

Nested Class Summary:
static class	CommentView.CommentBorder

Field Summary
static final Border	CBorder
static final int	commentPadding
static final int	commentPaddingD

Fields inherited from javax.swing.text.html.HiddenTagView:
yAlign, isSettingAttributes, circleR, circleD, tagSize, padding, UnknownTagBorderColor, StartBorder, EndBorder

Fields inherited from javax.swing.text.View:
BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, X_AXIS, Y_AXIS, sharedBiasReturn

Constructor:
CommentView(Element e) { super(e); }

Method from javax.swing.text.html.CommentView Summary:
_updateModelFromText, createComponent, getRepresentedText, getTextComponent, resetBorder

Methods from javax.swing.text.html.HiddenTagView:
_setTextFromModel, _updateModelFromText, changedUpdate, changedUpdate, createComponent, getAlignment, getMaximumSpan, getMinimumSpan, getPreferredSpan, getRepresentedText, getTextComponent, insertUpdate, isEndTag, removeUpdate, resetBorder, setTextFromModel, updateModelFromText, updateYAlign

Methods from javax.swing.text.html.EditableView:
getMaximumSpan, getMinimumSpan, getPreferredSpan, isVisible, paint, setParent

Methods from javax.swing.text.ComponentView:
createComponent, getAlignment, getComponent, getMaximumSpan, getMinimumSpan, getPreferredSpan, modelToView, paint, setComponentParent, setParent, viewToModel

Methods from javax.swing.text.View:
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods from javax.swing.text.View:

append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.swing.text.html.CommentView Detail:
void _updateModelFromText() { JTextComponent textC = getTextComponent(); Document doc = getDocument(); if (textC != null && doc != null) { String text = textC.getText(); SimpleAttributeSet sas = new SimpleAttributeSet(); isSettingAttributes = true; try { sas.addAttribute(HTML.Attribute.COMMENT, text); ((StyledDocument)doc).setCharacterAttributes (getStartOffset(), getEndOffset() - getStartOffset(), sas, false); } finally { isSettingAttributes = false; } } } This is subclassed to put the text on the Comment attribute of the Element's AttributeSet.
protected Component createComponent() { Container host = getContainer(); if (host != null && !((JTextComponent)host).isEditable()) { return null; } JTextArea ta = new JTextArea(getRepresentedText()); Document doc = getDocument(); Font font; if (doc instanceof StyledDocument) { font = ((StyledDocument)doc).getFont(getAttributes()); ta.setFont(font); } else { font = ta.getFont(); } updateYAlign(font); ta.setBorder(CBorder); ta.getDocument().addDocumentListener(this); ta.setFocusable(isVisible()); return ta; }
String getRepresentedText() { AttributeSet as = getElement().getAttributes(); if (as != null) { Object comment = as.getAttribute(HTML.Attribute.COMMENT); if (comment instanceof String) { return (String)comment; } } return ""; }
JTextComponent getTextComponent() { return (JTextComponent)getComponent(); }
void resetBorder() { }