Gephi Toolkit Javadoc

org.gephi.io.exporter.preview
Class PNGExporter

java.lang.Object
  extended by org.gephi.io.exporter.preview.PNGExporter
All Implemented Interfaces:
ByteExporter, Exporter, VectorExporter, LongTask

public class PNGExporter
extends java.lang.Object
implements VectorExporter, ByteExporter, LongTask

Author:
Mathieu Bastian

Constructor Summary
PNGExporter()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 boolean execute()
          Run the export process.
 int getHeight()
           
 int getMargin()
           
 int getWidth()
           
 Workspace getWorkspace()
          Returns the workspace from where data are exported
 boolean isTransparentBackground()
           
 void setHeight(int height)
           
 void setMargin(int margin)
           
 void setOutputStream(java.io.OutputStream stream)
          Set the stream where to export.
 void setProgressTicket(ProgressTicket progressTicket)
          Set the progress ticket for the long task.
 void setTransparentBackground(boolean transparentBackground)
           
 void setWidth(int width)
           
 void setWorkspace(Workspace workspace)
          Sets the worksapce from where to export data
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PNGExporter

public PNGExporter()
Method Detail

execute

public boolean execute()
Description copied from interface: Exporter
Run the export process.

Specified by:
execute in interface Exporter
Returns:
true if the operation is successful, false if it has been cancelled

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getMargin

public int getMargin()

setMargin

public void setMargin(int margin)

isTransparentBackground

public boolean isTransparentBackground()

setTransparentBackground

public void setTransparentBackground(boolean transparentBackground)

setWorkspace

public void setWorkspace(Workspace workspace)
Description copied from interface: Exporter
Sets the worksapce from where to export data

Specified by:
setWorkspace in interface Exporter
Parameters:
workspace - the workspace to export

getWorkspace

public Workspace getWorkspace()
Description copied from interface: Exporter
Returns the workspace from where data are exported

Specified by:
getWorkspace in interface Exporter
Returns:
the workspace the data are to be exported

setOutputStream

public void setOutputStream(java.io.OutputStream stream)
Description copied from interface: ByteExporter
Set the stream where to export.

Specified by:
setOutputStream in interface ByteExporter
Parameters:
stream - the stream the exporter is to write

cancel

public boolean cancel()
Description copied from interface: LongTask
Cancel the task. Returns true if the task has been sucessfully cancelled, false otherwise.

Specified by:
cancel in interface LongTask
Returns:
true if the task has been sucessfully cancelled, false otherwise

setProgressTicket

public void setProgressTicket(ProgressTicket progressTicket)
Description copied from interface: LongTask
Set the progress ticket for the long task. Can't be null.

Specified by:
setProgressTicket in interface LongTask
Parameters:
progressTicket - the progress ticket for this task

Gephi Toolkit Javadoc