java.lang.Object
- com.cosylab.vdct.graphics.objects.VisibleObject
- - com.cosylab.vdct.graphics.objects.Macro

All Implemented Interfaces:

Descriptable, Flexible, InLink, Linkable, Movable, MultiInLink, Selectable, Visitable, Popupable, Inspectable
```
public class Macro
extends VisibleObject
implements Descriptable, Movable, InLink, Popupable, Selectable, Inspectable, MultiInLink, Flexible
```
Insert the type's description here. Creation date: (29.1.2001 20:05:51)

Author:

Matej Sekoranja

Field Summary

Fields
Modifier and Type	Field	Description
`protected VDBMacro`	`data`
`protected boolean`	`disconnected`
`protected Polygon`	`leftPoly`
`protected int`	`leftXtranslation`
`protected int`	`leftYtranslation`
`protected Vector`	`outlinks`
`protected Polygon`	`rightPoly`
`protected int`	`rightXtranslation`
`protected int`	`rightYtranslation`

Fields inherited from class com.cosylab.vdct.graphics.objects.VisibleObject
x, y, zoomImage

Fields inherited from interface com.cosylab.vdct.graphics.objects.InLink
INPUT_MACRO_MODE, OUTPUT_MACRO_MODE

Constructor Summary

Constructors
Constructor Description

Macro(VDBMacro data, ContainerObject parent, int x, int y)
Insert the method's description here.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(Visitor visitor)`	Insert the method's description here.
`boolean`	`checkMove(int dx, int dy)`	Insert the method's description here.
`Flexible`	`copyToGroup(Object dsId, String group)`	Returns the copied instance or null if the object cannot be copied.
`void`	`destroy()`	Insert the method's description here.
`void`	`disconnect(Linkable disconnector)`	Insert the method's description here.
`protected void`	`draw(Graphics g, boolean hilited)`	Insert the method's description here.
`InspectableProperty`	`getCommentProperty()`
`VDBMacro`	`getData()`	Returns the data.
`String`	`getDescription()`	Insert the method's description here.
`String`	`getFlexibleName()`	Insert the method's description here.
`String`	`getHashID()`	Insert the method's description here.
`Icon`	`getIcon()`	Insert the method's description here.
`String`	`getID()`	Insert the method's description here.
`int`	`getInX()`	Insert the method's description here.
`int`	`getInY()`	Insert the method's description here.
`Vector`	`getItems()`	Insert the method's description here.
`String`	`getLayerID()`	Insert the method's description here.
`int`	`getLeftOffset()`	Returns the offset in pixels(the length of additional objects (arrows, strings) drawn on the left side of this object.
`int`	`getLeftX()`
`int`	`getLinkCount()`	Insert the method's description here.
`static GUISeparator`	`getMacroSeparator()`	Insert the method's description here.
`int`	`getMode()`
`ArrayList`	`getModeNames()`	Obtains list of all mode names for this particular property.
`String`	`getName()`	Insert the method's description here.
`Vector`	`getOutlinks()`
`OutLink`	`getOutput()`	Insert the method's description here.
`InspectableProperty[]`	`getProperties(int mode, boolean spreadsheet)`
`int`	`getRightOffset()`	Returns the offset in pixels(the length of additional objects (arrows, strings) drawn on the right side of this object.
`int`	`getRightX()`
`Vector`	`getStartPoints()`	Insert the method's description here.
`int`	`getTopOffset()`	Returns the offset in pixels(the length of additional objects (arrows, strings) drawn above this object.
`boolean`	`isConnectable()`	Insert the method's description here.
`boolean`	`isDisconnected()`	Insert the method's description here.
`boolean`	`isRight()`	Insert the method's description here.
`boolean`	`isTextPositionNorth()`
`boolean`	`move(int dx, int dy)`	Insert the method's description here.
`boolean`	`moveToGroup(Object dsId, String group)`	Insert the method's description here.
`boolean`	`rename(Object dsId, String newName)`	Insert the method's description here.
`void`	`rename(String oldName, String newName)`
`void`	`revalidatePosition()`	Insert the method's description here.
`void`	`setDescription(String description)`	Insert the method's description here.
`void`	`setDestroyed(boolean newDestroyed)`	Insert the method's description here.
`void`	`setLayerID(String id)`	Insert the method's description here.
`void`	`setMode(int mode)`
`void`	`setOutput(OutLink output, OutLink prevOutput)`	Insert the method's description here.
`void`	`setTextPositionNorth(boolean isTextPositionNorth)`
`String`	`toString()`	Insert the method's description here.
`void`	`updateTemplateLink()`	Insert the method's description here.
`protected void`	`validate()`	Insert the method's description here.

Methods inherited from class com.cosylab.vdct.graphics.objects.VisibleObject
forceValidation, getColor, getDsId, getFont, getHeight, getLabel, getMarkedX, getMarkedY, getMoveInsideView, getParent, getRheight, getRlabelX, getRlabelY, getRootContainer, getRscale, getRwidth, getRx, getRy, getScale, getVisibleColor, getWidth, getX, getY, intersects, intersects, isDestroyed, isVisible, isZoomRepaint, markPosition, paint, postDraw, postPaint, setColor, setFont, setHeight, setLabel, setParent, setRheight, setRlabelX, setRlabelY, setRwidth, setRx, setRy, setScale, setWidth, setX, setY, setZoomRepaint, snapToGrid, unconditionalValidation

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

Methods inherited from interface com.cosylab.vdct.inspector.Inspectable
getDsId

Methods inherited from interface com.cosylab.vdct.graphics.popup.Popupable
getLabel

- Field Detail
  - disconnected
```
protected boolean disconnected
```
  - outlinks
```
protected Vector outlinks
```
  - data
```
protected VDBMacro data
```
  - rightXtranslation
```
protected int rightXtranslation
```
  - rightYtranslation
```
protected int rightYtranslation
```
  - leftXtranslation
```
protected int leftXtranslation
```
  - leftYtranslation
```
protected int leftYtranslation
```
  - leftPoly
```
protected Polygon leftPoly
```
  - rightPoly
```
protected Polygon rightPoly
```
- Constructor Detail
  - Macro
```
public Macro(VDBMacro data,
             ContainerObject parent,
             int x,
             int y)
```
    Insert the method's description here. Creation date: (1.2.2001 17:22:29)
    
    Parameters:
    
    data - data
    
    y - y
    
    parent - parent
    
    x - x
- Method Detail
  - accept
```
public void accept(Visitor visitor)
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:52)
    
    Specified by:
    
    accept in interface Visitable
    
    Parameters:
    
    visitor - com.cosylab.vdct.graphics.objects.Visitor
  - checkMove
```
public boolean checkMove(int dx,
                         int dy)
```
    Insert the method's description here. Creation date: (25.12.2000 14:14:35)
    
    Specified by:
    
    checkMove in interface Movable
    
    Parameters:
    
    dx - int
    
    dy - int
    
    Returns:
    
    boolean
  - destroy
```
public void destroy()
```
    Insert the method's description here. Creation date: (29.1.2001 21:59:34)
    
    Overrides:
    
    destroy in class VisibleObject
  - disconnect
```
public void disconnect(Linkable disconnector)
```
    Insert the method's description here. Creation date: (29.1.2001 21:23:04)
    
    Specified by:
    
    disconnect in interface Linkable
    
    Parameters:
    
    disconnector - disconnector
  - draw
```
protected void draw(Graphics g,
                    boolean hilited)
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:52)
    
    Specified by:
    
    draw in class VisibleObject
    
    Parameters:
    
    g - java.awt.Graphics
    
    hilited - boolean
  - getDescription
```
public String getDescription()
```
    Insert the method's description here. Creation date: (24.4.2001 18:04:05)
    
    Specified by:
    
    getDescription in interface Descriptable
    
    Returns:
    
    java.lang.String
  - getHashID
```
public String getHashID()
```
    Insert the method's description here. Creation date: (3.5.2001 16:43:08)
    
    Specified by:
    
    getHashID in class VisibleObject
    
    Returns:
    
    java.lang.String
  - getID
```
public String getID()
```
    Insert the method's description here. Creation date: (1.2.2001 17:31:26)
    
    Specified by:
    
    getID in interface Linkable
    
    Returns:
    
    java.lang.String
  - getItems
```
public Vector getItems()
```
    Insert the method's description here. Creation date: (3.2.2001 11:23:59)
    
    Specified by:
    
    getItems in interface Popupable
    
    Returns:
    
    java.util.Vector
  - getLayerID
```
public String getLayerID()
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:51)
    
    Specified by:
    
    getLayerID in interface Linkable
    
    Returns:
    
    java.lang.String
  - getInX
```
public int getInX()
```
    Insert the method's description here. Creation date: (29.1.2001 22:22:13)
    
    Specified by:
    
    getInX in interface InLink
    
    Returns:
    
    int
  - getInY
```
public int getInY()
```
    Insert the method's description here. Creation date: (29.1.2001 22:22:13)
    
    Specified by:
    
    getInY in interface InLink
    
    Returns:
    
    int
  - isConnectable
```
public boolean isConnectable()
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:52)
    
    Specified by:
    
    isConnectable in interface Linkable
    
    Returns:
    
    boolean
  - isDisconnected
```
public boolean isDisconnected()
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:51)
    
    Specified by:
    
    isDisconnected in interface Linkable
    
    Returns:
    
    boolean
  - move
```
public boolean move(int dx,
                    int dy)
```
    Insert the method's description here. Creation date: (25.12.2000 14:14:35)
    
    Specified by:
    
    move in interface Movable
    
    Parameters:
    
    dx - int
    
    dy - int
    
    Returns:
    
    boolean
  - revalidatePosition
```
public void revalidatePosition()
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:52)
    
    Specified by:
    
    revalidatePosition in class VisibleObject
  - setDescription
```
public void setDescription(String description)
```
    Insert the method's description here. Creation date: (24.4.2001 18:04:05)
    
    Specified by:
    
    setDescription in interface Descriptable
    
    Parameters:
    
    description - java.lang.String
  - setLayerID
```
public void setLayerID(String id)
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:51)
    
    Specified by:
    
    setLayerID in interface Linkable
    
    Parameters:
    
    id - java.lang.String
  - validate
```
protected void validate()
```
    Insert the method's description here. Creation date: (29.1.2001 20:05:52)
    
    Specified by:
    
    validate in class VisibleObject
  - getMode
```
public int getMode()
```
    Returns:
    
    something
    
    See Also:
    
    OutLink.getMode()
  - setTextPositionNorth
```
public void setTextPositionNorth(boolean isTextPositionNorth)
```
    Parameters:
    
    isTextPositionNorth - isTextPositionNorth
  - isTextPositionNorth
```
public boolean isTextPositionNorth()
```
    Returns:
    
    something
  - setMode
```
public void setMode(int mode)
```
    Parameters:
    
    mode - mode
  - getCommentProperty
```
public InspectableProperty getCommentProperty()
```
    Specified by:
    
    getCommentProperty in interface Inspectable
    
    Returns:
    
    com.cosylab.vdct.inspector.InspectableProperty
    
    See Also:
    
    Inspectable.getCommentProperty()
  - getIcon
```
public Icon getIcon()
```
    Description copied from interface: Inspectable
    
    Insert the method's description here. Creation date: (10.1.2001 15:14:56)
    
    Specified by:
    
    getIcon in interface Inspectable
    
    Returns:
    
    javax.swing.Icon
    
    See Also:
    
    Inspectable.getIcon()
  - getModeNames
```
public ArrayList getModeNames()
```
    Description copied from interface: Inspectable
    
    Obtains list of all mode names for this particular property. Modes are numbered from 0-n. Creation date: (11.1.2001 21:30:04)
    
    Specified by:
    
    getModeNames in interface Inspectable
    
    Returns:
    
    java.util.ArrayList array of mode names - obtained using toString().
    
    See Also:
    
    Inspectable.getModeNames()
  - getName
```
public String getName()
```
    Description copied from interface: Inspectable
    
    Insert the method's description here. Creation date: (10.1.2001 14:47:43)
    
    Specified by:
    
    getName in interface Inspectable
    
    Returns:
    
    java.lang.String
    
    See Also:
    
    Inspectable.getName()
  - toString
```
public String toString()
```
    Description copied from interface: Inspectable
    
    Insert the method's description here. Creation date: (10.1.2001 14:48:10)
    
    Specified by:
    
    toString in interface Flexible
    
    Specified by:
    
    toString in interface Inspectable
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    java.lang.String
    
    See Also:
    
    String.toString()
  - getMacroSeparator
```
public static GUISeparator getMacroSeparator()
```
    Insert the method's description here. Creation date: (3.2.2001 13:07:04)
    
    Returns:
    
    com.cosylab.vdct.vdb.GUISeparator
  - getProperties
```
public InspectableProperty[] getProperties(int mode,
                                           boolean spreadsheet)
```
    Specified by:
    
    getProperties in interface Inspectable
    
    Parameters:
    
    mode - mode
    
    spreadsheet - spreadsheet
    
    Returns:
    
    com.cosylab.vdct.inspector.InspectableProperty[]
    
    See Also:
    
    Inspectable.getProperties(int, boolean spreadsheet)
  - setDestroyed
```
public void setDestroyed(boolean newDestroyed)
```
    Description copied from class: VisibleObject
    
    Insert the method's description here. Creation date: (5.5.2001 18:02:09)
    
    Overrides:
    
    setDestroyed in class VisibleObject
    
    Parameters:
    
    newDestroyed - boolean
    
    See Also:
    
    VisibleObject.setDestroyed(boolean)
  - rename
```
public void rename(String oldName,
                   String newName)
```
    Parameters:
    
    oldName - oldName
    
    newName - newName
  - getData
```
public VDBMacro getData()
```
    Returns the data.
    
    Returns:
    
    VDBMacro
  - getStartPoints
```
public Vector getStartPoints()
```
    Insert the method's description here. Creation date: (5.2.2001 12:10:18)
    
    Specified by:
    
    getStartPoints in interface MultiInLink
    
    Returns:
    
    java.util.Vector
  - isRight
```
public boolean isRight()
```
    Insert the method's description here. Creation date: (30.1.2001 16:58:58)
    
    Specified by:
    
    isRight in interface InLink
    
    Returns:
    
    boolean
  - setOutput
```
public void setOutput(OutLink output,
                      OutLink prevOutput)
```
    Insert the method's description here. Creation date: (29.1.2001 21:34:27)
    
    Specified by:
    
    setOutput in interface InLink
    
    Parameters:
    
    output - com.cosylab.vdct.graphics.objects.OutLink
    
    prevOutput - com.cosylab.vdct.graphics.objects.OutLink
  - getOutput
```
public OutLink getOutput()
```
    Insert the method's description here. Creation date: (29.1.2001 21:34:27)
    
    Specified by:
    
    getOutput in interface InLink
    
    Returns:
    
    com.cosylab.vdct.graphics.objects.OutLink
  - updateTemplateLink
```
public void updateTemplateLink()
```
    Insert the method's description here. Creation date: (30.1.2001 16:58:58)
  - getLeftX
```
public int getLeftX()
```
    Specified by:
    
    getLeftX in interface InLink
    
    Returns:
    
    int
  - getRightX
```
public int getRightX()
```
    Specified by:
    
    getRightX in interface InLink
    
    Returns:
    
    int
  - getLinkCount
```
public int getLinkCount()
```
    Description copied from interface: MultiInLink
    
    Insert the method's description here. Creation date: (4.5.2001 9:51:40)
    
    Specified by:
    
    getLinkCount in interface MultiInLink
    
    Returns:
    
    java.util.Vector
  - getOutlinks
```
public Vector getOutlinks()
```
    Specified by:
    
    getOutlinks in interface MultiInLink
    
    Returns:
    
    something
  - getTopOffset
```
public int getTopOffset()
```
    Description copied from class: VisibleObject
    
    Returns the offset in pixels(the length of additional objects (arrows, strings) drawn above this object.
    
    Overrides:
    
    getTopOffset in class VisibleObject
    
    Returns:
    
    something
  - getLeftOffset
```
public int getLeftOffset()
```
    Description copied from class: VisibleObject
    
    Returns the offset in pixels(the length of additional objects (arrows, strings) drawn on the left side of this object.
    
    Overrides:
    
    getLeftOffset in class VisibleObject
    
    Returns:
    
    something
  - getRightOffset
```
public int getRightOffset()
```
    Description copied from class: VisibleObject
    
    Returns the offset in pixels(the length of additional objects (arrows, strings) drawn on the right side of this object.
    
    Overrides:
    
    getRightOffset in class VisibleObject
    
    Returns:
    
    something
  - copyToGroup
```
public Flexible copyToGroup(Object dsId,
                            String group)
```
    Description copied from interface: Flexible
    
    Returns the copied instance or null if the object cannot be copied. Creation date: (4.2.2001 21:59:44)
    
    Specified by:
    
    copyToGroup in interface Flexible
    
    Parameters:
    
    dsId - dsId
    
    group - java.lang.String
    
    Returns:
    
    something
  - getFlexibleName
```
public String getFlexibleName()
```
    Description copied from interface: Flexible
    
    Insert the method's description here. Creation date: (3.5.2001 10:15:48)
    
    Specified by:
    
    getFlexibleName in interface Flexible
    
    Returns:
    
    java.lang.String
  - moveToGroup
```
public boolean moveToGroup(Object dsId,
                           String group)
```
    Description copied from interface: Flexible
    
    Insert the method's description here. Creation date: (4.2.2001 22:00:01)
    
    Specified by:
    
    moveToGroup in interface Flexible
    
    Parameters:
    
    dsId - dsId
    
    group - java.lang.String
    
    Returns:
    
    something
  - rename
```
public boolean rename(Object dsId,
                      String newName)
```
    Description copied from interface: Flexible
    
    Insert the method's description here. Creation date: (2.5.2001 23:23:17)
    
    Specified by:
    
    rename in interface Flexible
    
    Parameters:
    
    dsId - dsId
    
    newName - java.lang.String
    
    Returns:
    
    something

Class Macro

Field Summary

Fields inherited from class com.cosylab.vdct.graphics.objects.VisibleObject

Fields inherited from interface com.cosylab.vdct.graphics.objects.InLink

Constructor Summary

Method Summary

Methods inherited from class com.cosylab.vdct.graphics.objects.VisibleObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.cosylab.vdct.inspector.Inspectable

Methods inherited from interface com.cosylab.vdct.graphics.popup.Popupable

Field Detail

disconnected

outlinks

data

rightXtranslation

rightYtranslation

leftXtranslation

leftYtranslation

leftPoly

rightPoly

Constructor Detail

Macro

Method Detail

accept

checkMove

destroy

disconnect

draw

getDescription

getHashID

getID

getItems

getLayerID

getInX

getInY

isConnectable

isDisconnected

move

revalidatePosition

setDescription

setLayerID

validate

getMode

setTextPositionNorth

isTextPositionNorth

setMode

getCommentProperty

getIcon

getModeNames

getName

toString

getMacroSeparator

getProperties

setDestroyed

rename

getData

getStartPoints

isRight

setOutput

getOutput

updateTemplateLink

getLeftX

getRightX

getLinkCount

getOutlinks

getTopOffset

getLeftOffset

getRightOffset

copyToGroup

getFlexibleName

moveToGroup

rename