edu.mit.blocks.renderable

Class Comment

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

edu.mit.blocks.renderable.Comment

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class Comment
extends javax.swing.JPanel

Comment stores and displays user-generated text that can be edited by the user. Comments begin in 'editable' state. Comments are associated with a parent source of type JComponent. It should "tag" along with that component. Note, however, that this feature should be ensured by the parent source. The parent source can guarantee this by invoking the methods setPosition, translatePosition, and setParent when appropriate. text : String //the text stored in this Comment and edited by the user

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Comment(Workspace workspace, java.lang.String initText, CommentSource source, java.awt.Color borderColor, double zoom) Constructs a Comment with belonging to source, with text of initText, and initial zoom The comment's borders will have the color borderColor.

Method Summary

Modifier and Type	Method and Description
void	delete() Handle the removal of this comment from its comment source
CommentArrow	getArrow() access to the comment arrow object
int	getCommentLabelWidth() Returns the width of the comment label for this comment
org.w3c.dom.Node	getSaveNode(org.w3c.dom.Document document) Returns the node for this comment.
java.lang.String	getText()
boolean	isConstrainComment() returns whether this comment should be constrained to its parent's bounds
static Comment	loadComment(Workspace workspace, org.w3c.dom.NodeList commentChildren, RenderableBlock rb) Loads the comment from a NodeList of comment parts
void	paint(java.awt.Graphics g) overrides javax.Swing.JPanel.paint()
void	reformComment() Recalculate the shape of this comment
void	setConstrainComment(boolean constrainComment) sets whether this comment should be constrained to its parent's bounds
void	setLocation(int x, int y) moves this to a new position at (x,y) but not outside of its parent Container
void	setLocation(java.awt.Point p) moves this to a new position at (x,y) but not outside of its parent Container
void	setParent(java.awt.Container newparent) Moves this comment from it's old parent Container to a new Container.
void	setParent(java.awt.Container newparent, java.lang.Object constraints) Moves this comment from it's old parent Container to a new Container with given constrain.
void	setText(java.lang.String text)
void	setVisible(boolean b) Over rides the standard setVisible to make sure the arrow's visibility is also set.
void	setZoomLevel(double newZoom) Set a new zoom level, changes font size, label size, location, shape of comment, and arrow for this comment
void	showOnTop() Bumps the comment to top of ZOrder of parent if parent exists
java.lang.String	toString() String representation of this
void	translatePosition(int dx, int dy)
void	update() Updates the comment and commentLabel
void	update(boolean visibleState) Sets the active state of the commentLabel and updates the comment and commentLabel

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

public Comment(Workspace workspace,
               java.lang.String initText,
               CommentSource source,
               java.awt.Color borderColor,
               double zoom)

Constructs a Comment with belonging to source, with text of initText, and initial zoom The comment's borders will have the color borderColor. Note that initializing a comment only constructs all of the necessary structures. To graphically display a comment, the implementor must then add the comment using the proper Swing methods OR through the convenience method Comment.setParent()

Parameters:

workspace - The workspace in use

initText - initial text of comment

source - where the comment is linked to.

borderColor - the color that the border of the comment should be

zoom - initial zoom

Method Detail

delete

public void delete()

Handle the removal of this comment from its comment source

getCommentLabelWidth

public int getCommentLabelWidth()

Returns the width of the comment label for this comment

Returns:

update

public void update()

Updates the comment and commentLabel

update

public void update(boolean visibleState)

Sets the active state of the commentLabel and updates the comment and commentLabel

Parameters:

visibleState -

setZoomLevel

public void setZoomLevel(double newZoom)

Set a new zoom level, changes font size, label size, location, shape of comment, and arrow for this comment

Parameters:

newZoom -

reformComment

public void reformComment()

Recalculate the shape of this comment

getSaveNode

public org.w3c.dom.Node getSaveNode(org.w3c.dom.Document document)

Returns the node for this comment.

Returns:

loadComment

public static Comment loadComment(Workspace workspace,
                                  org.w3c.dom.NodeList commentChildren,
                                  RenderableBlock rb)

Loads the comment from a NodeList of comment parts

Parameters:

workspace - The workspace in use

commentChildren -

rb -

Returns:

paint

public void paint(java.awt.Graphics g)

overrides javax.Swing.JPanel.paint()

Overrides:

paint in class javax.swing.JComponent

getText

public java.lang.String getText()

Returns:

this.text.trim()

setText

public void setText(java.lang.String text)

Parameters:

text -

setLocation

public void setLocation(int x,
                        int y)

moves this to a new position at (x,y) but not outside of its parent Container

Overrides:

setLocation in class java.awt.Component

setLocation

public void setLocation(java.awt.Point p)

moves this to a new position at (x,y) but not outside of its parent Container

Overrides:

setLocation in class java.awt.Component

translatePosition

public void translatePosition(int dx,
                              int dy)

Parameters:

dx -

dy -

setParent

public void setParent(java.awt.Container newparent)

Moves this comment from it's old parent Container to a new Container. Removal and addition applies only if the Containers are non-null

Parameters:

newparent -

setVisible

public void setVisible(boolean b)

Over rides the standard setVisible to make sure the arrow's visibility is also set.

Overrides:

setVisible in class javax.swing.JComponent

setParent

public void setParent(java.awt.Container newparent,
                      java.lang.Object constraints)

Moves this comment from it's old parent Container to a new Container with given constrain.

Parameters:

newparent -

constraints -

toString

public java.lang.String toString()

String representation of this

Overrides:

toString in class java.awt.Component

showOnTop

public void showOnTop()

Bumps the comment to top of ZOrder of parent if parent exists

getArrow

public CommentArrow getArrow()

access to the comment arrow object

Returns:

isConstrainComment

public boolean isConstrainComment()

returns whether this comment should be constrained to its parent's bounds

Returns:

the constrainComment

setConstrainComment

public void setConstrainComment(boolean constrainComment)

sets whether this comment should be constrained to its parent's bounds

Parameters:

constrainComment - the constrainComment to set