org.das2.graph

Class DasAnnotation

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.das2.graph.DasCanvasComponent

org.das2.graph.DasAnnotation

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, Editable

public class DasAnnotation
extends DasCanvasComponent

This makes a DasCanvasComponent for GrannyTextRenderer, and optionally adds an arrow to point at things. TODO: See http://autoplot.org//developer.annotations

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DasAnnotation.DatumPairPointDescriptor create a PointDescriptor using and x and y Datum.
static interface	DasAnnotation.PointDescriptor something to point at

Nested classes/interfaces inherited from class org.das2.graph.DasCanvasComponent

DasCanvasComponent.CanvasComponentAction

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ANCHORBORDERTYPE
static java.lang.String	PROP_ANCHOROFFSET
static java.lang.String	PROP_ANCHORPOSITION
static java.lang.String	PROP_ANCHORTYPE
static java.lang.String	PROP_ARROWSTYLE
static java.lang.String	PROP_BORDERTYPE
static java.lang.String	PROP_FONT_SIZE the font size in pixels.
static java.lang.String	PROP_OVERRIDECOLORS
static java.lang.String	PROP_POINTATX
static java.lang.String	PROP_POINTATY
static java.lang.String	PROP_SHOWARROW
static java.lang.String	PROP_TEXT
static java.lang.String	PROP_TEXTCOLOR
static java.lang.String	PROP_URL
static java.lang.String	PROP_XRANGE
static java.lang.String	PROP_YRANGE

Fields inherited from class org.das2.graph.DasCanvasComponent

mouseAdapter, PROPERTIES_ACTION

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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
DasAnnotation(java.lang.String string) Create the annotation

Method Summary

Modifier and Type	Method and Description
boolean	acceptContext(int x, int y) returns true if the component is suitable context for the point.
boolean	contains(int x, int y) This item should only accept mouse events on the bubble
java.awt.Shape	getActiveRegion() returns the active region of the canvas component, which is not necessarily the bounds.
BorderType	getAnchorBorderType()
java.lang.String	getAnchorOffset()
AnchorPosition	getAnchorPosition() get the location within the box where the annotation will be drawn.
AnchorType	getAnchorType()
Arrow.HeadStyle	getArrowStyle() get the arrow style
BorderType	getBorderType() the border type
float	getFontSize() the font size in points.
DasAnnotation.PointDescriptor	getPointAt() return the thing we are pointing at.
Datum	getPointAtX()
Datum	getPointAtY()
java.lang.String	getText() get the text, which can be Granny Text.
java.awt.Color	getTextColor()
java.lang.String	getUrl()
DatumRange	getXrange()
DatumRange	getYrange()
protected void	installComponent() currently does nothing.
boolean	isOverrideColors()
boolean	isShowArrow()
void	paintComponent(java.awt.Graphics g1)
void	resize() Called by the DasCanvas layout manager to request this component to set its bounds.
void	setAnchorBorderType(BorderType anchorBorderType)
void	setAnchorOffset(java.lang.String anchorOffset) the offset in x and y for the text bubble from the anchor.
void	setAnchorPosition(AnchorPosition anchorPosition) set the location within the box where the annotation will be drawn.
void	setAnchorType(AnchorType anchorType)
void	setArrowStyle(Arrow.HeadStyle newarrowStyle) set the arrow style to BIG,SMALL,DRAFTING.
void	setBorderType(BorderType newborderType) set the border type to NONE, rounded rectangle, etc.
void	setFontSize(float fontSize) override the canvas font size.
void	setOverrideColors(boolean overrideColors) true will use the colors specified, otherwise the canvas colors are used.
void	setPlot(DasPlot p)
void	setPointAt(DasAnnotation.PointDescriptor p) set the thing to point at.
void	setPointAtX(Datum pointAtX)
void	setPointAtY(Datum pointAtY)
void	setShowArrow(boolean showArrow)
void	setText(java.lang.String string) Set the text, which can be Granny Text, or image URL.
void	setTextColor(java.awt.Color textColor) the color of the text, or if transparent then the border color should be used.
void	setUrl(java.lang.String url) set the URL to the location of a png or jpg file.
void	setXrange(DatumRange xrange)
void	setYrange(DatumRange yrange)

Methods inherited from class org.das2.graph.DasCanvasComponent

addMouseModule, coalesceEvents, getActions, getCanvas, getColumn, getDasMouseInputAdapter, getDasName, getEmSize, getFont, getRow, processDasUpdateEvent, processEvent, removeMouseModule, setColumn, setDasName, setRow, showProperties, toString, uninstallComponent, update, updateImmediately

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

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, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROP_TEXT

public static final java.lang.String PROP_TEXT

See Also:

Constant Field Values

PROP_URL

public static final java.lang.String PROP_URL

See Also:

Constant Field Values

PROP_FONT_SIZE

public static final java.lang.String PROP_FONT_SIZE

the font size in pixels.

See Also:

Constant Field Values

PROP_BORDERTYPE

public static final java.lang.String PROP_BORDERTYPE

See Also:

Constant Field Values

PROP_ANCHORPOSITION

public static final java.lang.String PROP_ANCHORPOSITION

See Also:

Constant Field Values

PROP_XRANGE

public static final java.lang.String PROP_XRANGE

See Also:

Constant Field Values

PROP_YRANGE

public static final java.lang.String PROP_YRANGE

See Also:

Constant Field Values

PROP_POINTATX

public static final java.lang.String PROP_POINTATX

See Also:

Constant Field Values

PROP_POINTATY

public static final java.lang.String PROP_POINTATY

See Also:

Constant Field Values

PROP_SHOWARROW

public static final java.lang.String PROP_SHOWARROW

See Also:

Constant Field Values

PROP_ANCHORBORDERTYPE

public static final java.lang.String PROP_ANCHORBORDERTYPE

See Also:

Constant Field Values

PROP_ANCHORTYPE

public static final java.lang.String PROP_ANCHORTYPE

See Also:

Constant Field Values

PROP_ARROWSTYLE

public static final java.lang.String PROP_ARROWSTYLE

See Also:

Constant Field Values

PROP_OVERRIDECOLORS

public static final java.lang.String PROP_OVERRIDECOLORS

See Also:

Constant Field Values

PROP_TEXTCOLOR

public static final java.lang.String PROP_TEXTCOLOR

See Also:

Constant Field Values

PROP_ANCHOROFFSET

public static final java.lang.String PROP_ANCHOROFFSET

See Also:

Constant Field Values

Constructor Detail

DasAnnotation

public DasAnnotation(java.lang.String string)

Create the annotation

Parameters:

string - the message, which may contain %p which will be replaced with a label.

Method Detail

setText

public void setText(java.lang.String string)

Set the text, which can be Granny Text, or image URL. (Image URL is deprecated, use url property instead.) If the url property has length>0, then this is ignored. URLs must start with http:, https:, or file:.

Parameters:

string - the text

See Also:

GrannyTextRenderer

getText

public java.lang.String getText()

get the text, which can be Granny Text.

Returns:

the text.

See Also:

GrannyTextRenderer

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

set the URL to the location of a png or jpg file. If this is set, then the text property is ignored.

Parameters:

url -

resize

public void resize()

Description copied from class: DasCanvasComponent

Called by the DasCanvas layout manager to request this component to set its bounds.

Overrides:

resize in class DasCanvasComponent

getActiveRegion

public java.awt.Shape getActiveRegion()

Description copied from class: DasCanvasComponent

returns the active region of the canvas component, which is not necessarily the bounds.

Overrides:

getActiveRegion in class DasCanvasComponent

Returns:

the active region of the canvas component

acceptContext

public boolean acceptContext(int x,
                             int y)

Description copied from class: DasCanvasComponent

returns true if the component is suitable context for the point. For example, the operator right-clicks at the point, is this point a transparent region of the component, and accepting context would be confusing to the operator? This was first introduced to support the annotation component, which draws a compact background bubble around a message, which is typically smaller than its bounds, plus an arrow.

Overrides:

acceptContext in class DasCanvasComponent

Parameters:

x - the x location on the canvas, with (0,0) being the upper-left corner.

y - the y location on the canvas, with (0,0) being the upper-left corner.

Returns:

true if the component accepts the context at this point.

contains

public boolean contains(int x,
                        int y)

This item should only accept mouse events on the bubble

Overrides:

contains in class javax.swing.JComponent

Parameters:

x -

y -

Returns:

paintComponent

public void paintComponent(java.awt.Graphics g1)

Overrides:

paintComponent in class javax.swing.JComponent

setPointAt

public void setPointAt(DasAnnotation.PointDescriptor p)

set the thing to point at. If %p will be replaced by p.getLabel()

Parameters:

p - the thing.

getPointAt

public DasAnnotation.PointDescriptor getPointAt()

return the thing we are pointing at.

Returns:

the thing we are pointing at.

installComponent

protected void installComponent()

Description copied from class: DasCanvasComponent

currently does nothing.

Overrides:

installComponent in class DasCanvasComponent

getFontSize

public float getFontSize()

the font size in points. If zero, then use the canvas size.

Returns:

the font size in points.

setFontSize

public void setFontSize(float fontSize)

override the canvas font size. If zero, then use the canvas size, otherwise, use this size.

Parameters:

fontSize - New value of property fontSize.

getBorderType

public BorderType getBorderType()

the border type

Returns:

the border type

setBorderType

public void setBorderType(BorderType newborderType)

set the border type to NONE, rounded rectangle, etc.

Parameters:

newborderType - the border type

getAnchorPosition

public AnchorPosition getAnchorPosition()

get the location within the box where the annotation will be drawn.

Returns:

anchorPosition

setAnchorPosition

public void setAnchorPosition(AnchorPosition anchorPosition)

set the location within the box where the annotation will be drawn.

Parameters:

anchorPosition -

setPlot

public void setPlot(DasPlot p)

getXrange

public DatumRange getXrange()

setXrange

public void setXrange(DatumRange xrange)

getYrange

public DatumRange getYrange()

setYrange

public void setYrange(DatumRange yrange)

getPointAtX

public Datum getPointAtX()

setPointAtX

public void setPointAtX(Datum pointAtX)

getPointAtY

public Datum getPointAtY()

setPointAtY

public void setPointAtY(Datum pointAtY)

isShowArrow

public boolean isShowArrow()

setShowArrow

public void setShowArrow(boolean showArrow)

getAnchorBorderType

public BorderType getAnchorBorderType()

setAnchorBorderType

public void setAnchorBorderType(BorderType anchorBorderType)

getAnchorType

public AnchorType getAnchorType()

setAnchorType

public void setAnchorType(AnchorType anchorType)

getArrowStyle

public Arrow.HeadStyle getArrowStyle()

get the arrow style

Returns:

the arrow style

setArrowStyle

public void setArrowStyle(Arrow.HeadStyle newarrowStyle)

set the arrow style to BIG,SMALL,DRAFTING.

Parameters:

newarrowStyle - the arrow style

isOverrideColors

public boolean isOverrideColors()

setOverrideColors

public void setOverrideColors(boolean overrideColors)

true will use the colors specified, otherwise the canvas colors are used.

Parameters:

overrideColors -

getTextColor

public java.awt.Color getTextColor()

setTextColor

public void setTextColor(java.awt.Color textColor)

the color of the text, or if transparent then the border color should be used.

Parameters:

textColor -

getAnchorOffset

public java.lang.String getAnchorOffset()

setAnchorOffset

public void setAnchorOffset(java.lang.String anchorOffset)

the offset in x and y for the text bubble from the anchor. For example, "4em,4em" will place a OutsideNE label 4ems up and 4ems over from the default.

Parameters:

anchorOffset -