IlvGrapherPin (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.linkconnector.IlvGrapherPin

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvCompositeGrapherPin, IlvDefaultGrapherPin, IlvGrapherPinRenderer.SDMGrapherPin
```
public abstract class IlvGrapherPin
extends Object
implements Serializable, IlvPersistentObject
```
This class can be used to represent the location of the connection point of a link (IlvLinkImage). The pins are managed by the class IlvPinLinkConnector.
This class is an abstract class. To specify the position of the pin, you must implement the method getPosition(ilog.views.IlvTransformer).

See Also:

IlvPinLinkConnector, IlvGrapher, IlvLinkImage, IlvDefaultGrapherPin, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvGrapherPin(IlvInputStream stream)` Reads the object from an `IlvInputStream`.
`IlvGrapherPin(IlvPinLinkConnector connector)` Creates a new pin and adds it to the pin link connector.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`allow(Object oClass, Object dClass, Object linkOrClass, boolean origin)` Returns a boolean value that allows or inhibits a link on this pin.
`boolean`	`allowsMove()` Returns `true` if the location of the pin can be changed using the method `setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer)`, and returns `false` otherwise.
`protected void`	`drawGhost(Graphics g, IlvTransformer t)` Draws the grapher pin during editing.
`Color`	`getColor()` Returns the color of the pin ghost.
`IlvGraphic`	`getNode()` Returns the node corresponding to the pin, that is, the node returned by the method `IlvLinkConnector.getNode()` called on the `IlvPinLinkConnector` that manages this pin.
`IlvPinLinkConnector`	`getPinLinkConnector()` Returns the `IlvPinLinkConnector` which manages this pin, or `null` if the pin has been removed.
`abstract IlvPoint`	`getPosition(IlvTransformer t)` Returns the position of the pin.
`int`	`getSize()` Returns the size of the pin ghost.
`int`	`getType()` Returns the type of the pin ghost.
`boolean`	`isConnected(IlvLinkImage link, boolean origin)` Returns `true` if `link` is connected to this pin, and `false` otherwise.
`boolean`	`isPersistent()` Indicates whether the grapher pin must be saved to an IVL file.
`void`	`setPosition(IlvPoint p, IlvTransformer t)` Sets the position of the pin.
`void`	`write(IlvOutputStream stream)` Writes the object to an `IlvOutputStream`.
`protected boolean`	`zoomable()` Returns `true` if the pin is zoomable; otherwise it returns `false`.

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

- Constructor Detail
  - IlvGrapherPin
```
public IlvGrapherPin(IlvPinLinkConnector connector)
```
    Creates a new pin and adds it to the pin link connector.
    
    Parameters:
    
    connector - The link connector where the pin is added.
  - IlvGrapherPin
```
public IlvGrapherPin(IlvInputStream stream)
              throws IlvReadFileException
```
    Reads the object from an IlvInputStream. The default implementation of the method does nothing.
    Note that a subclass that overrides the method isPersistent() to return true must be public and must provide a constructor with an IlvInputStream argument. The first line of the constructor must be super(stream).
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if the format is not correct.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    write(ilog.views.io.IlvOutputStream), isPersistent()
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the object to an IlvOutputStream. The default implementation of the method does nothing.
    You should not call this method directly; instead, you should use the write methods of the IlvGrapher that contains the node to which the link connector is attached.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - The output stream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    Since:
    
    JViews 3.5
  - isPersistent
```
public boolean isPersistent()
```
    Indicates whether the grapher pin must be saved to an IVL file. If this method returns true, the grapher pin is saved; otherwise it is not saved.
    The default implementation always returns false.
    Note that if a subclass overrides this method to return true, it must be public and must provide a constructor with an IlvInputStream argument. The first line of the constructor must be super(stream).
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    write(ilog.views.io.IlvOutputStream)
  - getPinLinkConnector
```
public IlvPinLinkConnector getPinLinkConnector()
```
    Returns the IlvPinLinkConnector which manages this pin, or null if the pin has been removed.
    
    Since:
    
    JViews 5.5
  - isConnected
```
public final boolean isConnected(IlvLinkImage link,
                                 boolean origin)
```
    Returns true if link is connected to this pin, and false otherwise.
    
    Parameters:
    
    link - The link image.
    
    origin - If the value is true, checks whether the link is connected by the origin point. If the value is false, checks whether the link is connected by the destination point.
  - getType
```
public int getType()
```
    Returns the type of the pin ghost. The type defines the way the ghost of the pin is drawn. This method must return a value that is either one of the predefined values in the class IlvPinLinkConnector or a combination of these values.
    The default implementation returns the pin ghost type of the IlvPinLinkConnector to which this pin is connected. You can override this method if you need a different type for the pins of the same IlvPinLinkConnector.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    IlvPinLinkConnector.getPinType()
  - getSize
```
public int getSize()
```
    Returns the size of the pin ghost. The default implementation returns the pin ghost size of the IlvPinLinkConnector to which this pin is connected. You can override this method if you need a different size for pins of the same IlvPinLinkConnector.
    A pin ghost is defined by its center point (see getPosition(ilog.views.IlvTransformer)) and its size. A pin ghost is drawn in a square of size 2*size located at (p.x-size, p.y-size), where p is the center point.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    IlvPinLinkConnector.getPinSize()
  - getColor
```
public Color getColor()
```
    Returns the color of the pin ghost. The default implementation returns the pin ghost color of the IlvPinLinkConnector to which this pin is connected. You can override this method if you need a different color for pins of the same IlvPinLinkConnector.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    IlvPinLinkConnector.getPinColor()
  - getNode
```
public final IlvGraphic getNode()
```
    Returns the node corresponding to the pin, that is, the node returned by the method IlvLinkConnector.getNode() called on the IlvPinLinkConnector that manages this pin. The method returns null for a pin that has been removed from its IlvPinLinkConnector.
  - allow
```
protected boolean allow(Object oClass,
                        Object dClass,
                        Object linkOrClass,
                        boolean origin)
```
    Returns a boolean value that allows or inhibits a link on this pin. You must override this method to control the links that are able to connect to the pin. The default implementation returns true.
    
    Parameters:
    
    oClass - The class of the origin object, or the origin object itself.
    
    dClass - The class of the destination object, or the destination object itself.
    
    linkOrClass - The class of the link object.
    
    origin - If the value is true, checks if a link starting at this pin is allowed. If the value is false, checks if a link ending at this pin is allowed.
  - setPosition
```
public void setPosition(IlvPoint p,
                        IlvTransformer t)
```
    Sets the position of the pin.
    The default implementation of the method does nothing. Subclasses of IlvGrapherPin that support the change of the location of the pin using this method must provide an overridden implementation. Also, such subclasses must override the method allowsMove() to return true.
    Note that changing the position of a pin can change the bounding box of the links attached to the pin. Therefore, the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) must be used for the node returned by the method getNode().
    
    Parameters:
    
    p - The point where the pin must be located. The point must be transformed by transformer t.
    
    t - The transformer that is used to draw the node associated with the pin link connector.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getPosition(ilog.views.IlvTransformer), allowsMove()
  - getPosition
```
public abstract IlvPoint getPosition(IlvTransformer t)
```
    Returns the position of the pin. You must override this method to give the position of the pin.
    Note that the bounding box of the links connected to a pin depends on the position of the pin. Therefore, once a pin has been added to an IlvPinLinkConnector attached to a node or a link inside an IlvGrapher, the position of the pin should be changed only using the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean).
    
    Parameters:
    
    t - The transformer used to draw the node.
    
    Returns:
    
    The position of the pin.
    
    See Also:
    
    setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer)
  - allowsMove
```
public boolean allowsMove()
```
    Returns true if the location of the pin can be changed using the method setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer), and returns false otherwise.
    The default implementation always returns false. Subclasses that support the change of the location of the pin using the method setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer) must provide an overridden implementation of setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer) and must override allowsMove() to return true.
    
    Since:
    
    JViews 5.5
  - zoomable
```
protected boolean zoomable()
```
    Returns true if the pin is zoomable; otherwise it returns false.
    A grapher pin is zoomable if calling the getPosition member function with a transformer gives the same result as calling it with a null (identity) transformer and then applying the transformer to the result.
    The default implementation returns true.
    Note that an instance of a grapher pin must return the same value during its lifetime.
    
    Since:
    
    JViews 5.0
  - drawGhost
```
protected void drawGhost(Graphics g,
                         IlvTransformer t)
```
    Draws the grapher pin during editing. You should not call this method directly.
    
    Parameters:
    
    g - The destination graphics (already in XOR mode when called by interactors that need this mode).
    
    t - The transformer used to draw the node.

Class IlvGrapherPin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvGrapherPin

IlvGrapherPin

Method Detail

write

isPersistent

getPinLinkConnector

isConnected

getType

getSize

getColor

getNode

allow

setPosition

getPosition

allowsMove

zoomable

drawGhost