com.swfm.mica.editors
Class MiGraphicsNode

java.lang.Object
  com.swfm.mica.core.MiPart
      com.swfm.mica.core.MiContainer
          com.swfm.mica.editors.MiGraphicsNode

All Implemented Interfaces:

MiiActionTypes, MiiAttributeTypes, MiiDragAndDropParticipant, MiiEventTypes, MiiNames, MiiPropertyTypes, MiiTypes

public class MiGraphicsNode

extends MiContainer

This class implements the graphics for a 'node' useful for node-arc graphs. A number of options are provided to customize the appearance of the node. The consitiuent parts of the node are an icon image, a (optionally editable) text string, and a box that encloses the text (and optionally the icon).

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

static java.lang.String	Mi_IMAGE_INSIDE_BOX_NAME
static java.lang.String	Mi_IMAGE_LOCATION_NAME

Constructor Summary

MiGraphicsNode()
Constructs a new MiGraphicsNode.

MiGraphicsNode(MiPart image, int imageLocation, boolean imageInsideBox, boolean editable, java.lang.String label)
Constructs a new MiGraphicsNode.

Method Summary

void	copy(MiPart source) Copy the state of this MiPart into the target MiPart.
MiPart	deepCopy() Makes and returns a copy of this container and all of it's parts.
MiPart	getImage()
MiPart	getLabel()
MiPropertyDescriptions	getPropertyDescriptions() Gets the descriptions of all of the properties.
java.lang.String	getPropertyValue(java.lang.String name) Gets the textual value of the property with the given name.
java.lang.String	getValue() Gets the value of the label.
void	setEditable(boolean editable) Sets whether the label of this node is editable.
void	setImage(MiPart image) Sets the icon image of this node.
void	setImageInsideBox(boolean imageInsideBox) Sets whether the icon image of this node should join any label inside the box.
void	setImageLocation(int location) Sets the location of the icon image of this node.
void	setPropertyValue(java.lang.String name, java.lang.String value) Sets the attribute with the given name to the given value.
void	setValue(java.lang.String value) Sets the value of the label.

Methods inherited from class com.swfm.mica.core.MiContainer

appendPart, calcMinimumSize, calcPreferredSize, containsPart, doImport, getIndexOfPart, getIntersectionWithLine, getKeepConnectionsBelowNodes, getNumberOfParts, getPart, getPart, getSupportedImportFormats, hasEventHandlers, hasValidCachedEventHandlerInfo, insertPart, invalidateCachedEventHandlerInfo, isContainerOf, isContainerOf, isContainerOfWithAttachments, pick, pickDeepListContents, pickObject, removeAllParts, removePart, removePart, setKeepConnectionsBelowNodes, setPart, translate

Methods inherited from class com.swfm.mica.core.MiPart

_reCalcBounds, _render, _replaceBounds, _setContainer, _setDrawManager, _setValidatingLayout, appendActionHandler, appendActionHandler, appendActionHandler, appendActionHandler, appendActionHandler, appendAttachment, appendAttachment, appendCommandHandler, appendCommandHandler, appendCommandHandler, appendConnection, appendContainer, appendEventHandler, appendItem, appendPoint, appendPoint, applyCustomLookAndFeel, containsItem, containsOpaqueRectangles, copy, deleteAllConnections, deleteAllParts, deleteSelf, dispatchAction, dispatchAction, dispatchAction, dispatchActionRequest, dispatchActionRequest, dispatchActionRequest, dispatchEvent, doExport, draw, drawNow, drawNow, flip, flip, freeAccessLock, get1DShapeStrokeBackgroundColor, get1DShapeStrokesFilled, getAccessLock, getActionHandler, getActionsGenerated, getActionsLocallyGenerated, getActionsRequestedFromParts, getAfterRenderer, getAlphaCompositeRenderMode, getAnnotationPointManager, getAssociatedParts, getAttachment, getAttachment, getAttachmentMargins, getAttachments, getAttributeLockMask, getAttributePublicMask, getAttributes, getAttributeValue, getBackgroundColor, getBackgroundImage, getBackgroundRenderer, getBackgroundTile, getBalloonHelp, getBeforeRenderer, getBlackColor, getBorderHiliteColor, getBorderHiliteWidth, getBorderLook, getBorderRenderer, getBounds, getBounds, getCenter, getCenter, getCenterOfRotation, getCenterX, getCenterY, getColor, getConnection, getConnectionPointManager, getContainer, getContainerRequestedActions, getContainingEditor, getContainingWindow, getContextCursor, getContextMenu, getContextMenu, getControlPointManager, getCustomLookAndFeels, getCustomLookAndFeels, getDarkColor, getDeepConnection, getDeepConnection, getDeepConnections, getDeeplyInvalidateAreas, getDefaultAttributes, getDialogHelp, getDoubleBuffer, getDragAndDropBehavior, getDrawBounds, getDrawManager, getEventHandler, getEventHandler, getEventHandlerWithClass, getEventHandlingDisabledByContainer, getEventHandlingEnabled, getFlipped, getFont, getFontHorizontalJustification, getFontPointSize, getFontVerticalJustification, getHasBorderHilite, getHasShadow, getHeight, getID, getIncomingInvalidLayoutNotificationsEnabled, getIndexOfItem, getInnerBounds, getInnerBounds, getInvalidAreaNotificationsEnabled, getInvalidLayoutNotificationsEnabled, getItem, getItem, getKeyFocusTraversalGroup, getLayout, getLayoutManipulator, getLightColor, getLineEndSize, getLineEndsRenderer, getLineEndsSizeFnOfLineWidth, getLineEndStyle, getLineStartSize, getLineStartStyle, getLineStyle, getLineWidth, getLocallyRequestedEventTypes, getManipulator, getMargins, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumPickAreaSize, getMinimumSize, getMinimumWidth, getName, getNumberOfActionHandlers, getNumberOfAttachments, getNumberOfConnections, getNumberOfContainers, getNumberOfDeepConnections, getNumberOfEventHandlers, getNumberOfItems, getNumberOfPoints, getNumberOfResources, getOutgoingInvalidLayoutNotificationsEnabled, getPoint, getPoint, getPointEntryAngle, getPointExitAngle, getPointX, getPointY, getPreferredSize, getPrototypeManipulator, getRelativeLocation, getResource, getResourceName, getRootWindow, getRotation, getSelectionGraphics, getShadowColor, getShadowDirection, getShadowLength, getShadowRenderer, getShadowShape, getShadowStyle, getSize, getSnapPointManager, getStatusHelp, getSupportedExportFormats, getThisOrPartHasInvalidArea, getToolHintHelp, getTotalNumberOfPartsCreated, getTransform, getTransparency, getValidatingLayout, getVisibilityAnimator, getWhiteColor, getWidth, getWriteMode, getXmax, getXmin, getXorColor, getYmax, getYmin, hasAttachment, hasAttribute, hasEnterKeyFocus, hasEventHandler, hasFixedAspectRatio, hasFixedHeight, hasFixedWidth, hasKeyboardFocus, hasMouseFocus, hasOverriddenMinimumSize, hasOverriddenPreferredSize, hasProperty, hasTotallyInvalidArea, hasValidLayout, insertActionHandler, insertActionHandler, insertActionHandler, insertConnection, insertContainer, insertEventHandler, insertItem, insertPoint, insertPoint, invalidateArea, invalidateArea, invalidateLayout, isAcceptingEnterKeyFocus, isAcceptingKeyboardFocus, isAcceptingMouseFocus, isAcceptingTabKeys, isActionDispatchingEnabled, isConnectable, isConnectedTo, isCopyable, isCopyableAsPartOfCopyable, isDeletable, isDoubleBuffered, isDragAndDropSource, isDragAndDropTarget, isFilled, isFontBold, isFontItalic, isFontUnderlined, isHidden, isMovable, isOpaqueRectangle, isPickable, isPickableWhenTransparent, isPrintable, isSavable, isSelectable, isSelected, isSensitive, isShowing, isSnappable, isUngroupable, isValidConnectionDestination, isValidConnectionSource, isVisible, layoutParts, makeImageFromArea, makeLayoutManipulator, makeManipulator, optimizedInvalidateArea, optimizedInvalidateDrawBoundsArea, overrideAttributes, overrideEventHandlingDisabledByContainer, packLayout, pickDeepList, preRenderToDoubleBuffer, refreshBounds, refreshLookAndFeel, refreshLookAndFeel, removeActionHandler, removeActionHandler, removeActionHandlers, removeAllActionHandlers, removeAllAttachments, removeAllConnections, removeAllEventHandlers, removeAllItems, removeAllManipulators, removeAttachment, removeAttachment, removeCommandHandler, removeCommandHandler, removeConnection, removeConnection, removeContainer, removeContainer, removeEventHandler, removeFromAllContainers, removeItem, removeItem, removePoint, removeResource, removeSelf, replaceDrawBounds, replaceSelf, requestEnterKeyFocus, requestKeyboardFocus, rotate, rotate, rotateTo, scale, scale, scale, select, set1DShapeStrokeBackgroundColor, set1DShapeStrokesFilled, setAcceptingEnterKeyFocus, setAcceptingKeyboardFocus, setAcceptingMouseFocus, setAcceptingTabKeys, setActionDispatchingEnabled, setAfterRenderer, setAlphaCompositeRenderMode, setAnnotationPointManager, setAttachmentDrawnAfter, setAttachmentMargins, setAttachmentsVisibility, setAttributeLockMask, setAttributePublicMask, setAttributes, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundRenderer, setBackgroundTile, setBalloonHelp, setBalloonHelpMessage, setBeforeRenderer, setBlackColor, setBorderHiliteColor, setBorderHiliteWidth, setBorderLook, setBorderRenderer, setBounds, setBounds, setCenter, setCenter, setCenterX, setCenterY, setColor, setColor, setConnectable, setConnectionPointManager, setContextCursor, setContextMenu, setControlPointManager, setCopyable, setCopyableAsPartOfCopyable, setCustomLookAndFeels, setCustomLookAndFeels, setDarkColor, setDeeplyInvalidateAreas, setDefaultAttributes, setDeletable, setDialogHelp, setDialogHelpMessage, setDoubleBuffer, setDoubleBuffered, setDragAndDropBehavior, setEventHandlingEnabled, setFilled, setFixedAspectRatio, setFixedHeight, setFixedWidth, setFont, setFontBold, setFontHorizontalJustification, setFontItalic, setFontPointSize, setFontUnderlined, setFontVerticalJustification, setHasBorderHilite, setHasShadow, setHeight, setHidden, setIncomingInvalidLayoutNotificationsEnabled, setInvalidAreaNotificationsEnabled, setInvalidLayoutNotificationsEnabled, setIsDragAndDropSource, setIsDragAndDropTarget, setIsOpaqueRectangle, setItem, setKeyFocusTraversalGroup, setLayout, setLightColor, setLineEndSize, setLineEndSizeFnOfLineWidth, setLineEndsRenderer, setLineEndStyle, setLineStartSize, setLineStartStyle, setLineStyle, setLineWidth, setMargins, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumPickAreaSize, setMinimumSize, setMinimumWidth, setMouseFocus, setMovable, setName, setNumberOfPoints, setOutgoingInvalidLayoutNotificationsEnabled, setPickable, setPickableWhenTransparent, setPoint, setPoint, setPreferredSize, setPrintable, setPropertyValues, setPrototypeManipulator, setResource, setSavable, setSelectable, setSelectionGraphics, setSensitive, setShadowColor, setShadowDirection, setShadowLength, setShadowRenderer, setShadowStyle, setSize, setSize, setSnappable, setSnapPointManager, setStatusHelp, setStatusHelpMessage, setSupportedImportFormats, setToolHintHelp, setToolHintMessage, setTransparency, setTransparency, setUngroupable, setVisibilityAnimator, setVisible, setWhiteColor, setWidth, setWriteMode, setXmax, setXmin, setXorColor, setYmax, setYmin, supportsImportOfSpecificInstance, toString, translate, translate, translatePoint, validateLayout, validatePropertyValue, waitUntilRedrawn

Methods inherited from class java.lang.Object

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

Field Detail

Mi_IMAGE_LOCATION_NAME

public static final java.lang.String Mi_IMAGE_LOCATION_NAME

See Also:

Constant Field Values

Mi_IMAGE_INSIDE_BOX_NAME

public static final java.lang.String Mi_IMAGE_INSIDE_BOX_NAME

See Also:

Constant Field Values

Constructor Detail

MiGraphicsNode

public MiGraphicsNode()

Constructs a new MiGraphicsNode. The node has no image, and the un-editable text string "Node".

MiGraphicsNode

public MiGraphicsNode(MiPart image,
                      int imageLocation,
                      boolean imageInsideBox,
                      boolean editable,
                      java.lang.String label)

Constructs a new MiGraphicsNode.

Parameters:

image - the icon image or null

imageLocation - either Mi_ABOVE or Mi_TO_LEFT

imageInsideBox - true if image joins the label inside the box

editable - true if the label is to be editable

label - the text of the node

Method Detail

setValue

public void setValue(java.lang.String value)

Sets the value of the label. A value of null removes the label and a non-null value creates a label, if required, and sets it's displayed text to the given value.

Parameters:

value - the label text or null

getValue

public java.lang.String getValue()

Gets the value of the label.

Returns:

the label text or null

setImage

public void setImage(MiPart image)

Sets the icon image of this node.

Parameters:

image - the icon image or null

setImageLocation

public void setImageLocation(int location)

Sets the location of the icon image of this node.

Parameters:

location - either Mi_ABOVE or Mi_TO_LEFT

setEditable

public void setEditable(boolean editable)

Sets whether the label of this node is editable.

Parameters:

editable - true if editable

setImageInsideBox

public void setImageInsideBox(boolean imageInsideBox)

Sets whether the icon image of this node should join any label inside the box.

getImage

public MiPart getImage()

getLabel

public MiPart getLabel()

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Sets the attribute with the given name to the given value. Valid names are found in the MiiAttributeTypes.attributeNames array.

Overrides:

setPropertyValue in class MiPart

Parameters:

name - the name of an attribute

value - the value of the attribute

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Gets the textual value of the property with the given name. If the value is null then MiiTypes.Mi_NULL_VALUE_NAME is returned.

Overrides:

getPropertyValue in class MiPart

Parameters:

name - the name of a property

Returns:

the string value of the property

getPropertyDescriptions

public MiPropertyDescriptions getPropertyDescriptions()

Gets the descriptions of all of the properties. These can be used to see if an property is different from the default value or if a proposed value is valid or to get a list of all of the valid values of a property.

Overrides:

getPropertyDescriptions in class MiPart

Returns:

the list of property descriptions

copy

public void copy(MiPart source)

Copy the state of this MiPart into the target MiPart.

Overrides:

copy in class MiPart

Parameters:

source - the part to copy

See Also:

MiPart.copy()

deepCopy

public MiPart deepCopy()

Makes and returns a copy of this container and all of it's parts.

Overrides:

deepCopy in class MiContainer

Returns:

the copy

See Also:

MiPart.copy()