GraphObject (CharGer4 Documentation)

Object
- charger.obj.GraphObject

Direct Known Subclasses:

GEdge, GNode
```
public abstract class GraphObject
extends Object
```
GraphObjects support common characteristics for any component of a graph.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright (c) 1998-2020 by Harry S. Delugach.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GraphObject.Kind` One of GraphObject.GNODE or GEDGE or GRAPH
`static class`	`GraphObject.ObjectIDComparator` This class compares the object ID's of two GraphObject's.

Field Summary

Fields
Modifier and Type	Field and Description
`Color`	`backColor` Background or fill color of the object
`static chargerlib.Rectangle3D`	`defaultDim`
`static Color`	`defaultSelectColor` The color used for a thick rectangle around each selected node
`static int`	`defaultWrapColumns`
`static boolean`	`defaultWrapLabels`
`chargerlib.Rectangle3D`	`displayRect3D` Will represent the diplay "rectangle" including a depth for display.
`Color`	`foreColor` Foreground or text color of the object
`Color`	`highlightColor` highlight color
`chargerlib.history.ObjectHistory`	`history`
`private boolean`	`isNegated` whether this object is negated; for right now, only useful with graphs
`boolean`	`isSelected` True if this object was selected on the canvas, otherwise false
`Font`	`labelFont`
`GraphObject.Kind`	`myKind`
`GraphObjectID`	`objectID` global and unique number.
`static int`	`objectMargin` The amount of white space to have around the text label
`Graph`	`ownerGraph` The innermost enclosing graph in which this object logically lies; null if in the outermost graph
`static int`	`TerritorialLimit`
`String`	`textLabel` One of: a referent, a link name, an actor name, a context name
`Point2D.Double`	`textLabelLowerLeftPt` The lower left corner of where the text label should be drawn.

Constructor Summary

Constructors
Constructor and Description

GraphObject()

Constructors
Constructor and Description
`GraphObject()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) abstract void`	`abandonObject()` Abstract method that disconnects object from any other objects.
`void`	`addHistoryRecord(chargerlib.history.HistoryRecord he)`
`void`	`adjustCustomDisplayRect()` Performs whatever custom adjustments that any sub-classes want.
`boolean`	`commitToKnowledgeBase(KnowledgeBase kb)` Subclasses will implement this method in order to perform whatever object-specific actions are appropriate for adding to the knowledge base.
`abstract void`	`draw(Graphics2D g, boolean printing)` Render the object with adjustments as necessary
`(package private) abstract void`	`drawBorder(Graphics2D g, Color borderColor)` Highlights the border of the object
`protected void`	`finalize()`
`static Graph`	`findDominantContext(ArrayList nodeList)` Find the dominant context for a given collection of objects, defined as the one partially-included context.
`boolean`	`forceMove(Point2D.Double delta)` Forces an un-verified move of the object.
`void`	`forgetObject()` Convenience method for telling the object to tell its graph to forget it.
`FontMetrics`	`getBestFontMetrics()` Find the most appropriate font metrics for this object.
`Point2D.Double`	`getCenter()`
`Color`	`getColor(String foreback)` Get the colors for this object.
`double`	`getDepth()` Get the 3D depth of the object display (1 means 2D)
`Dimension`	`getDim()` Get the dimension of this object.
`Rectangle2D.Double`	`getDisplayRect()` Gets the display rectangle of this object on the canvas, without any scaling information.
`chargerlib.Rectangle3D`	`getDisplayRect3D()`
`chargerlib.history.ObjectHistory`	`getHistory()`
`Font`	`getLabelFont()`
`Dimension`	`getMinimumContentSize()` Using the size of the textlabel and including reasonable padding, etc.
`ObjectLocator`	`getObjectLocator()` Constructs an object locator for this object.
`Graph`	`getOutermostGraph()` Find the graph that is the outermost graph of the given object.
`EditFrame`	`getOwnerFrame()` Determines the owner edit frame (if any) for a given graph object, regardless of the level of nesting.
`Graph`	`getOwnerGraph()` Find the most immediate enclosing graph.
`abstract Shape`	`getShape()` Obtain the Shape object that represents the selectable region of this object.
`Shape`	`getShapeForDrawing()` Finds the center line of the shape, so that drawing the border will take place entirely within the desired shape.
`String`	`getTextLabel()`
`Dimension`	`getTextLabelSize()`
`Point2D.Double`	`getUpperLeft()` Find the upper left point that lies on the extreme edge of the display rectangle.
`int`	`getWrapColumns()` The number of columns to wrap a label, if wrapping is enabled
`boolean`	`getWrapLabels()` Figure out whether to wrap labels.
`boolean`	`isNegated()`
`boolean`	`isNegativelyNested()` Determine whether the given graph is negatively nested; i.e., is it oddly-nested in the existential graph sense (where only cuts/negative contexts matter).
`static String`	`listToString(ArrayList list)` Converts a list of graph objects into their i/o string form, including line separators.
`static String`	`listToStringXML(ArrayList list)` Converts an arraylist of graph objects into their XML string form, including line separators.
`boolean`	`putInCorrectContext(Graph g, GraphObject go)`
`static boolean`	`putInCorrectContext(Graph g, GraphObject go, Point2D.Double newPos)` Puts an object in its correct logical context, constrained to be nested in graph g.
`void`	`resizeIfNecessary()` Use the object's current text label and center to determine whether it needs re-sizing to accommodate the (possibly new) label.
`void`	`resizeIfNecessary(FontMetrics fmetrics, Point2D.Double p)` Using the given string and center point, determine whether the object needs resizing to accommodate the (possibly new) string label.
`void`	`selfCleanup()` Any CharGer-specific cleanup that must be done prior to being disconnect/ignored.
`void`	`setBackground(Color c)`
`void`	`setCenter(Point2D.Double p)` Set the center point of the current object.
`void`	`setCenterOnly(Point2D.Double p)` Sets the object's center point on the canvas, moving the object if necessary.
`void`	`setColor()` Sets the colors of this concept from the current defaults, whatever they are.
`void`	`setColor(String foreback, Color c)` Sets the colors of this object from the given color.
`void`	`setDepth(double depth)` Set the 3D depth of the object display (1 means 2D)
`void`	`setDim(Dimension d)` Sets the dimensions of the object.
`void`	`setDim(float wid, float ht)` Sets the width and height of the object.
`void`	`setDisplayRect(double x, double y, double width, double height)`
`void`	`setDisplayRect(Rectangle2D.Double rect)` Sets the size and location of the object on the unscaled canvas.
`void`	`setDisplayRect3D(chargerlib.Rectangle3D displayRect3D)`
`void`	`setForeground(Color c)`
`void`	`setLabelFont(Font labelFont)`
`void`	`setNegated(boolean isNegated)`
`void`	`setOwnerGraph(Graph g)` Set the owner of this graph.
`void`	`setTextLabel(String newTextLabel)` Sets the text label of the graph object.
`void`	`setTextLabel(String newTextLabel, FontMetrics fm)` Sets the text label of the graph object.
`void`	`setTextLabel(String newTextLabel, FontMetrics fmetrics, Point2D.Double p)` Sets the text label of the graph object.
`void`	`setUpperLeft(double upperleftx, double upperlefty)` Sets the upper left corner of the object.
`void`	`setUpperLeft(Point2D.Double upperleft)` Sets the upper left corner of the object.
`String`	`toString()` Constructs a constrained text version of the object, suitable for writing to a file and then reading back into the system.
`boolean`	`unCommitFromKnowledgeBase(KnowledgeBase kb)` Subclasses will implement this method in order to perform whatever object-specific actions are appropriate for removing this object from the knowledge base.

Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - objectID
```
public GraphObjectID objectID
```
    global and unique number.
    
    See Also:
    
    Global.applyForID()
  - ownerGraph
```
public Graph ownerGraph
```
    The innermost enclosing graph in which this object logically lies; null if in the outermost graph
  - myKind
```
public GraphObject.Kind myKind
```
  - defaultSelectColor
```
public static final Color defaultSelectColor
```
    The color used for a thick rectangle around each selected node
  - textLabel
```
public String textLabel
```
    One of: a referent, a link name, an actor name, a context name
  - defaultDim
```
public static chargerlib.Rectangle3D defaultDim
```
  - TerritorialLimit
```
public static int TerritorialLimit
```
  - defaultWrapLabels
```
public static boolean defaultWrapLabels
```
  - defaultWrapColumns
```
public static int defaultWrapColumns
```
  - objectMargin
```
public static int objectMargin
```
    The amount of white space to have around the text label
  - textLabelLowerLeftPt
```
public Point2D.Double textLabelLowerLeftPt
```
    The lower left corner of where the text label should be drawn. Set for each object in advance to speed up drawing.
  - displayRect3D
```
public chargerlib.Rectangle3D displayRect3D
```
    Will represent the diplay "rectangle" including a depth for display.
  - isSelected
```
public boolean isSelected
```
    True if this object was selected on the canvas, otherwise false
  - foreColor
```
public Color foreColor
```
    Foreground or text color of the object
  - backColor
```
public Color backColor
```
    Background or fill color of the object
  - isNegated
```
private boolean isNegated
```
    whether this object is negated; for right now, only useful with graphs
  - highlightColor
```
public Color highlightColor
```
    highlight color
  - labelFont
```
public Font labelFont
```
  - history
```
public chargerlib.history.ObjectHistory history
```
- Constructor Detail
  - GraphObject
```
public GraphObject()
```
- Method Detail
  - getShape
```
public abstract Shape getShape()
```
    Obtain the Shape object that represents the selectable region of this object.
    
    Returns:
    
    the Shape for this object, with appropriate dimensions, etc.
  - getShapeForDrawing
```
public Shape getShapeForDrawing()
```
    Finds the center line of the shape, so that drawing the border will take place entirely within the desired shape. Note this is the same as getShape unless it's a context (graph)
    
    Returns:
    
    same as getShape, unless it's overridden in a subclass.
  - getWrapLabels
```
public boolean getWrapLabels()
```
    Figure out whether to wrap labels. Usually gotten from the object's owner frame, but if there isn't one, return the default static value.
    
    Returns:
    
    true if labels are to be wrapped; false otherwise
  - getWrapColumns
```
public int getWrapColumns()
```
    The number of columns to wrap a label, if wrapping is enabled
    
    Returns:
    
    The number of columns to wrap a label, if wrapping is enabled
  - getColor
```
public Color getColor(String foreback)
```
    Get the colors for this object.
    
    Parameters:
    
    foreback - one of "fill" or "text" indicating which color to get.
    
    Returns:
    
    requested color
  - setColor
```
public void setColor()
```
    Sets the colors of this concept from the current defaults, whatever they are.
  - setColor
```
public void setColor(String foreback,
                     Color c)
```
    Sets the colors of this object from the given color.
    
    Parameters:
    
    foreback - one of "text" or "fill"
    
    c - the color to set for that property
  - isNegated
```
public boolean isNegated()
```
  - setNegated
```
public void setNegated(boolean isNegated)
```
  - forgetObject
```
public void forgetObject()
```
    Convenience method for telling the object to tell its graph to forget it.
  - forceMove
```
public boolean forceMove(Point2D.Double delta)
```
    Forces an un-verified move of the object.
    
    Parameters:
    
    delta -
    
    Returns:
    
    whether the new position in different from the old position
  - setCenter
```
public void setCenter(Point2D.Double p)
```
    Set the center point of the current object. Adjust the display rectangle of its enclosing graph, in case the new center is outside the graph's previous bounds.
    
    Parameters:
    
    p - new CENTER point
  - setCenterOnly
```
public void setCenterOnly(Point2D.Double p)
```
    Sets the object's center point on the canvas, moving the object if necessary. Moves the textlabel to be centered in this object.
    
    Parameters:
    
    p - The new center point
  - setUpperLeft
```
public void setUpperLeft(Point2D.Double upperleft)
```
    Sets the upper left corner of the object. Makes no consistency or other adjustments and does not change the size of the object.
    
    Parameters:
    
    upperleft - The point at the upper left of the graph object.
  - setUpperLeft
```
public void setUpperLeft(double upperleftx,
                         double upperlefty)
```
    Sets the upper left corner of the object. Makes no consistency or other adjustments, nor does it change the size of the object.
    
    Parameters:
    
    upperleftx - x-value of the point at the upper left of the graph object.
    
    upperlefty - y-value of the point at the upper left of the graph object.
  - getUpperLeft
```
public Point2D.Double getUpperLeft()
```
    Find the upper left point that lies on the extreme edge of the display rectangle.
    
    Returns:
    
    upper left corner of the displayable area of this object.
  - getCenter
```
public Point2D.Double getCenter()
```
    Returns:
    
    center point of the object
    
    See Also:
    
    getUpperLeft()
  - getDim
```
public Dimension getDim()
```
    Get the dimension of this object.
    
    Returns:
    
    its current dimension.
  - setDim
```
public void setDim(Dimension d)
```
    Sets the dimensions of the object. Does not change the location of the upper left point.
    
    Parameters:
    
    d - new dimensions for the object.
  - setDim
```
public void setDim(float wid,
                   float ht)
```
    Sets the width and height of the object. Does not change the location of the upper left point.
    
    Parameters:
    
    wid - new width for the object.
    
    ht - new height for the object.
  - getDisplayRect3D
```
public chargerlib.Rectangle3D getDisplayRect3D()
```
  - setDisplayRect3D
```
public void setDisplayRect3D(chargerlib.Rectangle3D displayRect3D)
```
  - getDisplayRect
```
public Rectangle2D.Double getDisplayRect()
```
    Gets the display rectangle of this object on the canvas, without any scaling information. The display rectangle includes the border but does not currently include the shadow (if present). Should it?
  - setDisplayRect
```
public void setDisplayRect(Rectangle2D.Double rect)
```
    Sets the size and location of the object on the unscaled canvas.
    
    Parameters:
    
    rect - the rectangle of the object.
  - setDisplayRect
```
public void setDisplayRect(double x,
                           double y,
                           double width,
                           double height)
```
  - adjustCustomDisplayRect
```
public void adjustCustomDisplayRect()
```
    Performs whatever custom adjustments that any sub-classes want. This method is called explicitly in some cases by Charger, but it does nothing in the GraphObject class itself. Sub-classes can override this in order to ensure their own peculiar display rect constraints (e.g., actors).
  - getDepth
```
public double getDepth()
```
    Get the 3D depth of the object display (1 means 2D)
    
    Returns:
    
    the depth of the object display
  - setDepth
```
public void setDepth(double depth)
```
    Set the 3D depth of the object display (1 means 2D)
  - setForeground
```
public void setForeground(Color c)
```
  - setBackground
```
public void setBackground(Color c)
```
  - getTextLabel
```
public String getTextLabel()
```
    Returns:
    
    the text label of the graph object
  - setTextLabel
```
public void setTextLabel(String newTextLabel)
```
    Sets the text label of the graph object.
    
    Parameters:
    
    newTextLabel - new text label (erases the old text label)
  - setTextLabel
```
public void setTextLabel(String newTextLabel,
                         FontMetrics fm)
```
    Sets the text label of the graph object. Creates a dummy graphics context to determine a font size, etc. May re-size the node if the label is too long
    
    Parameters:
    
    newTextLabel - new text label (erases the old text label)
    
    fm - the font metrics that govern re-sizing of the text or object if necessary
  - setTextLabel
```
public void setTextLabel(String newTextLabel,
                         FontMetrics fmetrics,
                         Point2D.Double p)
```
    Sets the text label of the graph object. May re-size the node if the label is too long.
    
    Parameters:
    
    newTextLabel - new text label (erases the old text label)
    
    fmetrics - the font metrics that govern re-sizing of the text or object if necessary
    
    p - the point around which the label is centered
  - getTextLabelSize
```
public Dimension getTextLabelSize()
```
  - resizeIfNecessary
```
public void resizeIfNecessary()
```
    Use the object's current text label and center to determine whether it needs re-sizing to accommodate the (possibly new) label. If resizing is necessary, then do it.
  - resizeIfNecessary
```
public void resizeIfNecessary(FontMetrics fmetrics,
                              Point2D.Double p)
```
    Using the given string and center point, determine whether the object needs resizing to accommodate the (possibly new) string label. If resizing is necessary then do it, Previously resizing meant making the object larger if necessary, but never smaller (at least not here). Now resizing may also shrink the node if the new label is significantly smaller than the box.
  - getMinimumContentSize
```
public Dimension getMinimumContentSize()
```
    Using the size of the textlabel and including reasonable padding, etc. how much space is required
    
    Returns:
    
    the smallest rectangle that will hold the text label including the margins.
  - getBestFontMetrics
```
public FontMetrics getBestFontMetrics()
```
    Find the most appropriate font metrics for this object. Use the object's label font. If there is no graphics context, then revert to the default metrics for the session.
    
    Returns:
    
    the most applicable FontMetrics object that can be used when needed
  - toString
```
public String toString()
```
    Constructs a constrained text version of the object, suitable for writing to a file and then reading back into the system.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    IOManager
  - listToString
```
public static String listToString(ArrayList list)
```
    Converts a list of graph objects into their i/o string form, including line separators.
    
    Parameters:
    
    list - ArrayList of graph objects
    
    Returns:
    
    A string (including line separators) of the objects
    
    See Also:
    
    charger.xml.CGXParser#parseCGXMLString
  - listToStringXML
```
public static String listToStringXML(ArrayList list)
```
    Converts an arraylist of graph objects into their XML string form, including line separators.
    
    Parameters:
    
    list - ArrayList of graph objects
    
    Returns:
    
    A string (including line separators, and overall %<conceptualgraph%gt; tags) of the objects
    
    See Also:
    
    EditManager
  - abandonObject
```
abstract void abandonObject()
```
    Abstract method that disconnects object from any other objects. Doesn't delete from its owning graph, from Notio, or destroy itself.
  - commitToKnowledgeBase
```
public boolean commitToKnowledgeBase(KnowledgeBase kb)
```
    Subclasses will implement this method in order to perform whatever object-specific actions are appropriate for adding to the knowledge base.
  - unCommitFromKnowledgeBase
```
public boolean unCommitFromKnowledgeBase(KnowledgeBase kb)
```
    Subclasses will implement this method in order to perform whatever object-specific actions are appropriate for removing this object from the knowledge base.
  - selfCleanup
```
public void selfCleanup()
```
    Any CharGer-specific cleanup that must be done prior to being disconnect/ignored. Distinct from finalize because it can deal with logical disposal rather than memory management. Does nothing at this level; usually overwritten in a subclass.
  - draw
```
public abstract void draw(Graphics2D g,
                          boolean printing)
```
    Render the object with adjustments as necessary
    
    Parameters:
    
    g - Graphics context on which the object is to be rendered
    
    printing - Whether to pretty-print the object
  - drawBorder
```
abstract void drawBorder(Graphics2D g,
                         Color borderColor)
```
    Highlights the border of the object
    
    Parameters:
    
    g - Graphics context on which the object is to be rendered
    
    borderColor - the color to draw
  - findDominantContext
```
public static Graph findDominantContext(ArrayList nodeList)
                                 throws CGContextException
```
    Find the dominant context for a given collection of objects, defined as the one partially-included context. If more than one is found, it throws an exception.
    
    Parameters:
    
    nodeList - list containing the objects
    
    Returns:
    
    dominant context if a unique one is found; else null
    
    Throws:
    
    CGContextException
  - putInCorrectContext
```
public static boolean putInCorrectContext(Graph g,
                                          GraphObject go,
                                          Point2D.Double newPos)
```
    Puts an object in its correct logical context, constrained to be nested in graph g. Makes no attempt to handle links.
    
    Parameters:
    
    g - outermost enclosing graph out of which go cannot be placed
    
    go - new (or repositioned) object that is to be placed
    
    newPos - the new position, usually considered to be the center point for the object
    
    Returns:
    
    true the context was changed; false otherwise Assumes that object go is already positioned where it is to go.
    
    See Also:
    
    Graph.handleContextLinks()
  - putInCorrectContext
```
public boolean putInCorrectContext(Graph g,
                                   GraphObject go)
```
  - getOutermostGraph
```
public Graph getOutermostGraph()
```
    Find the graph that is the outermost graph of the given object.
    
    Returns:
    
    outermost graph, self if this one is the outermost
  - isNegativelyNested
```
public boolean isNegativelyNested()
```
    Determine whether the given graph is negatively nested; i.e., is it oddly-nested in the existential graph sense (where only cuts/negative contexts matter).
    
    Returns:
    
    true if we're negatively nested (ultimately oddly-nested with respect to cuts).
  - getOwnerFrame
```
public EditFrame getOwnerFrame()
```
    Determines the owner edit frame (if any) for a given graph object, regardless of the level of nesting.
    
    Returns:
    
    the edit frame in which this object is located; null if it is not in a frame.
  - getOwnerGraph
```
public Graph getOwnerGraph()
```
    Find the most immediate enclosing graph.
    
    Returns:
    
    enclosing graph; null if we're at the top level.
  - setOwnerGraph
```
public void setOwnerGraph(Graph g)
```
    Set the owner of this graph.
    
    Parameters:
    
    g - the owner of this graph
  - getObjectLocator
```
public ObjectLocator getObjectLocator()
```
    Constructs an object locator for this object.
    
    Returns:
    
    an object locator for this object.
    
    See Also:
    
    ObjectLocator
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - addHistoryRecord
```
public void addHistoryRecord(chargerlib.history.HistoryRecord he)
```
  - getHistory
```
public chargerlib.history.ObjectHistory getHistory()
```
  - getLabelFont
```
public Font getLabelFont()
```
  - setLabelFont
```
public void setLabelFont(Font labelFont)
```

Class GraphObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

objectID

ownerGraph

myKind

defaultSelectColor

textLabel

defaultDim

TerritorialLimit

defaultWrapLabels

defaultWrapColumns

objectMargin

textLabelLowerLeftPt

displayRect3D

isSelected

foreColor

backColor

isNegated

highlightColor

labelFont

history

Constructor Detail

GraphObject

Method Detail

getShape

getShapeForDrawing

getWrapLabels

getWrapColumns

getColor

setColor

setColor

isNegated

setNegated

forgetObject

forceMove

setCenter

setCenterOnly

setUpperLeft

setUpperLeft

getUpperLeft

getCenter

getDim

setDim

setDim

getDisplayRect3D

setDisplayRect3D

getDisplayRect

setDisplayRect

setDisplayRect

adjustCustomDisplayRect

getDepth

setDepth

setForeground

setBackground

getTextLabel

setTextLabel

setTextLabel

setTextLabel

getTextLabelSize

resizeIfNecessary

resizeIfNecessary

getMinimumContentSize

getBestFontMetrics

toString

listToString

listToStringXML

abandonObject

commitToKnowledgeBase

unCommitFromKnowledgeBase

selfCleanup

draw

drawBorder

findDominantContext

putInCorrectContext

putInCorrectContext