com.togethersoft.openapi.ide.diagram
Interface IdeDiagramManager

public interface IdeDiagramManager

IdeDiagramManager is responsible for opening/closing a diagram and providing access to the opened diagrams.

Given a RwiDiagram the find method allows to find an opened IdeDiagram visualizing it.

Current IdeDiagramManager can be obtained via IdeDiagramManagerAccess.getDiagramManager method.

Author:

TogetherSoft

See Also: IdeDiagramManagerAccess.getDiagramManager()

public void addIdeDiagramListener(IdeDiagramListener listener)

Adds a diagram listener.

Parameters:

listener - the IdeDiagramListener

See Also:

IdeDiagramListener

public void closeDiagram(IdeDiagram diagram)

Closes the specified diagram.

Parameters:

diagram - the IdeDiagram to be closed

See Also:

IdeDiagram

public void createImagemap(RwiDiagram rwiDiagram, IdeMapBuilder builder)

Creates ImageMap for this diagram using the specified IdeMapBuilder as the actual creator.

Parameters:

builder - IdeMapBuilder instance

See Also:

IdeMapBuilder

public IdeDiagramEnumeration diagrams()

Returns an enumeration of all opened diagrams.

Returns: IdeDiagramEnumeration

public IdeDiagram findDiagram(RwiDiagram rwiDiagram)

Specified RwiDiagram finds an opened IdeDiagram visualizing it. If there is no opened IdeDiagram visualizing it, returns null.

Parameters:

rwiDiagram - RwiDiagram instance

Returns: opened IdeDiagram

See Also:

openDiagram(com.togethersoft.openapi.rwi.RwiDiagram,boolean), RwiDiagram

public IdeDiagram getActiveDiagram()

Returns an active IdeDiagram (the one the user is working with). If there is no open diagram, this method returns null. For example:

 IdeDiagram activeIdeDiagram = IdeDiagramManagerAccess.getDiagramManager().getActiveDiagram();
 if (activeIdeDiagram == null){
   IdeMessageManagerAccess.printMessage(IdeMessageType.ERROR_MODAL,"No open diagram");
 }

Returns: IdeDiagram

public boolean isPaneVisible()

Checks whether the Together's diagram pane is visible on the screen.

Returns: true if the diagram pane if visible, false otherwise

public IdeDiagram openDiagram(RwiDiagram rwiDiagram, boolean inNewWindow)

Given the RwiDiagram creates and opens IdeDiagram.

Parameters:

rwiDiagram - RwiDiagram instance

inNewWindow - if true then the diagram will be opened in a new window, if false the in the active window

Returns: opened IdeDiagram

See Also:

findDiagram(com.togethersoft.openapi.rwi.RwiDiagram), RwiDiagram, IdeDiagram

public void print(RwiDiagram rwiDiagram, java.awt.PrintJob printJob)

public void removeIdeDiagramListener(IdeDiagramListener listener)

Removes a diagram listener.

Parameters:

listener - the IdeDiagramListener

See Also:

IdeDiagramListener

public void requestFocus()

Requests focus for the diagram pane. If the diagram pane cannot accept focus, nothing happens.

public void saveImage(RwiDiagram rwiDiagram, OutputStream output, String formatID)
                throws java.io.IOException

Saves the image of the diagram into the OutputStream. The format that the image will be saved in is specified by the formatID argument. There are two predefined formatID values for GIF and WMF format in IdeImageFormat interface.

Parameters:

output - OutputStream to receive the image

formatID - String ID of the output image format

Throws:

IOException - if IO error occurred.

See Also:

IdeImageFormat

public void setActiveDiagram(IdeDiagram diagram)

Sets the active IdeDiagram (the one the user is working with).

Parameters:

diagram - the IdeDiagram instance to be set as the active diagram

public void setPaneVisible(boolean value)

Sets visibility flag of the Together's diagram pane.

Parameters:

value - boolean flag. If true then the diagram pane will be made visible, invisible otherwise.