Search this API

y.module.io
Class ImageOutputModule

java.lang.Object
  extended by y.module.YModule
      extended by y.module.io.IOHandlerModule
          extended by y.module.io.ImageOutputModule
Direct Known Subclasses:
GIFOutput, ImageIoOutput, JPGOutput

public abstract class ImageOutputModule
extends IOHandlerModule

Abstract base class for all modules that export a diagram to an image file.

 

Field Summary
protected static java.lang.String OPTION_SELECTION_PAINTING
           
 
Fields inherited from class y.module.io.IOHandlerModule
INPUT_MODE, OPTION_CLIP_GRAPH, OPTION_CLIP_TYPE, OPTION_CLIP_VIEW, OPTION_CUSTOM_HEIGHT, OPTION_CUSTOM_WIDTH, OPTION_GENERATE_HTML_TABLE, OPTION_MARGIN, OPTION_SCALING_FACTOR, OPTION_SIZE_TYPE, OPTION_SIZE_USE_CUSTOM_HEIGHT, OPTION_SIZE_USE_CUSTOM_WIDTH, OPTION_SIZE_USE_ORIGINAL, OPTION_TILE_COLUMN_COUNT, OPTION_TILE_ROW_COUNT, OPTION_TILING_ACTIVE, OUTPUT_MODE, TAB_TILING, TAB_VIEWPORT, vpc
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
protected ImageOutputModule(java.lang.String name)
          Creates a new instance of ImageOutputModule.
protected ImageOutputModule(java.lang.String name, java.lang.String author, java.lang.String description)
          Deprecated. Use ImageOutputModule(String) instead. Proper module description should take place in the API documentation.
 
Method Summary
protected  void addRenderingOptions(OptionHandler options)
          Adds rendering specific options to the given option handler instance.
protected  void configureRendering()
          Configures the module's ImageOutputHandler according to the settings in the module's rendering specific options.
protected  void configureTiling()
          Configures the module's ImageOutputHandler for tiling according to the tiling specific options.
protected  void configureViewPort(Graph2DView viewPort, Graph2DView originalView)
          Configures the given view port.
protected abstract  ImageOutputHandler createImageOutputHandler()
          Creates an ImageOutputHandler instance that is used for image export.
protected  IOHandler createIOHandler()
          Returns an ImageOutputHandler instance.
 
Methods inherited from class y.module.io.IOHandlerModule
addTilingOptions, addViewPortOptions, adoptRenderingHints, adoptViewPortOptions, getIOHandler, getIOMode, getURL, mainrun, setIOHandler, setIOMode, setURL
 
Methods inherited from class y.module.YModule
addModuleListener, createOptionHandler, createThread, dispose, exceptionHappened, fitGraph2DView, getAuthor, getDescription, getExitStatus, getGraph2D, getGraph2DView, getModuleListeners, getModuleName, getOptionHandler, getTimer, getView, init, initGuiFactory, isAbortable, isBackupRealizersEnabled, removeModuleListener, run, setBackupRealizersEnabled, setExitStatus, setGraph2D, setModuleName, setOptionHandler, start, startAsThread
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTION_SELECTION_PAINTING

protected static final java.lang.String OPTION_SELECTION_PAINTING
See Also:
Constant Field Values
Constructor Detail

ImageOutputModule

protected ImageOutputModule(java.lang.String name,
                            java.lang.String author,
                            java.lang.String description)
Deprecated. Use ImageOutputModule(String) instead. Proper module description should take place in the API documentation.

Creates a new instance of ImageOutputModule.

Parameters:
name - the module's name
author - the module's author
description - a short description of the module's functionality

ImageOutputModule

protected ImageOutputModule(java.lang.String name)
Creates a new instance of ImageOutputModule.

Parameters:
name - the module's name
Method Detail

addRenderingOptions

protected void addRenderingOptions(OptionHandler options)
Adds rendering specific options to the given option handler instance.

Parameters:
options - the option handler instance.
See Also:
configureRendering()

configureViewPort

protected void configureViewPort(Graph2DView viewPort,
                                 Graph2DView originalView)
Configures the given view port.

This implementation turns off anti-aliasing for the given view port before calling the super implementation.

Overrides:
configureViewPort in class IOHandlerModule
Parameters:
viewPort - the Graph2DView used for exporting.
originalView - the exported graph's current view.

configureRendering

protected void configureRendering()
Configures the module's ImageOutputHandler according to the settings in the module's rendering specific options.

See Also:
addRenderingOptions(y.option.OptionHandler)

configureTiling

protected void configureTiling()
Configures the module's ImageOutputHandler for tiling according to the tiling specific options.


createIOHandler

protected IOHandler createIOHandler()
Returns an ImageOutputHandler instance.

Specified by:
createIOHandler in class IOHandlerModule
Returns:
an ImageOutputHandler instance.

createImageOutputHandler

protected abstract ImageOutputHandler createImageOutputHandler()
Creates an ImageOutputHandler instance that is used for image export.

Returns:
an ImageOutputHandler instance

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.