Gephi Toolkit Javadoc

org.gephi.io.exporter.preview
Class PDFExporter

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

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

Class exporting the preview graph as a PDF file.

Author:
Jérémy Subtil , Mathieu Bastian

Constructor Summary
PDFExporter()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 boolean execute()
          Run the export process.
 float getMarginBottom()
           
 float getMarginLeft()
           
 float getMarginRight()
           
 float getMarginTop()
           
 Rectangle getPageSize()
           
 Workspace getWorkspace()
          Returns the workspace from where data are exported
 boolean isLandscape()
           
 void setLandscape(boolean landscape)
           
 void setMarginBottom(float marginBottom)
           
 void setMarginLeft(float marginLeft)
           
 void setMarginRight(float marginRight)
           
 void setMarginTop(float marginTop)
           
 void setOutputStream(java.io.OutputStream stream)
          Set the stream where to export.
 void setPageSize(Rectangle pageSize)
           
 void setProgressTicket(ProgressTicket progressTicket)
          Set the progress ticket for the long task.
 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

PDFExporter

public PDFExporter()
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

isLandscape

public boolean isLandscape()

getMarginBottom

public float getMarginBottom()

getMarginLeft

public float getMarginLeft()

getMarginRight

public float getMarginRight()

getMarginTop

public float getMarginTop()

getPageSize

public Rectangle getPageSize()

setMarginBottom

public void setMarginBottom(float marginBottom)

setMarginLeft

public void setMarginLeft(float marginLeft)

setMarginRight

public void setMarginRight(float marginRight)

setMarginTop

public void setMarginTop(float marginTop)

setPageSize

public void setPageSize(Rectangle pageSize)

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

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

setLandscape

public void setLandscape(boolean landscape)

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

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