|
Search this API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object y.module.YModule y.module.io.IOHandlerModule
public abstract class IOHandlerModule
Base class of all modules that provide file based I/O services for diagrams.
Field Summary | |
---|---|
static byte |
INPUT_MODE
I/O mode specifier constant. |
protected static java.lang.String |
OPTION_CLIP_GRAPH
|
protected static java.lang.String |
OPTION_CLIP_TYPE
|
protected static java.lang.String |
OPTION_CLIP_VIEW
|
protected static java.lang.String |
OPTION_CUSTOM_HEIGHT
|
protected static java.lang.String |
OPTION_CUSTOM_WIDTH
|
protected static java.lang.String |
OPTION_GENERATE_HTML_TABLE
|
protected static java.lang.String |
OPTION_MARGIN
|
protected static java.lang.String |
OPTION_SCALING_FACTOR
|
protected static java.lang.String |
OPTION_SIZE_TYPE
|
protected static java.lang.String |
OPTION_SIZE_USE_CUSTOM_HEIGHT
|
protected static java.lang.String |
OPTION_SIZE_USE_CUSTOM_WIDTH
|
protected static java.lang.String |
OPTION_SIZE_USE_ORIGINAL
|
protected static java.lang.String |
OPTION_TILE_COLUMN_COUNT
|
protected static java.lang.String |
OPTION_TILE_ROW_COUNT
|
protected static java.lang.String |
OPTION_TILING_ACTIVE
|
static byte |
OUTPUT_MODE
I/O mode specifier constant. |
protected static java.lang.String |
TAB_TILING
|
protected static java.lang.String |
TAB_VIEWPORT
|
protected ViewPortConfigurator |
vpc
|
Fields inherited from class y.module.YModule |
---|
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS |
Constructor Summary | |
---|---|
protected |
IOHandlerModule(java.lang.String name)
Creates a new instance of IOHandlerModule . |
protected |
IOHandlerModule(java.lang.String name,
java.lang.String author,
java.lang.String description)
Deprecated. Use IOHandlerModule(String) instead.
Proper module description should take place in the API documentation. |
Method Summary | |
---|---|
protected void |
addTilingOptions(OptionHandler options)
Adds image-tiling specific options to the given option handler instance. |
protected void |
addViewPortOptions(OptionHandler options)
Adds viewport specific options to the given option handler instance. |
protected void |
adoptRenderingHints(Graph2DView viewPort,
Graph2DView originalView)
Configures global rendering hints for export. |
protected void |
adoptViewPortOptions()
|
protected void |
configureViewPort(Graph2DView viewPort,
Graph2DView originalView)
Configures the given view port. |
protected abstract IOHandler |
createIOHandler()
Creates an IOHandler instance responsible for the actual I/O to be performed. |
IOHandler |
getIOHandler()
Returns the IOHandler used by this module. |
byte |
getIOMode()
Returns the I/O mode the module is working in. |
java.net.URL |
getURL()
Returns the location of the file to which the module either will export or import the diagram. |
protected void |
mainrun()
Reads or writes a diagram in a specific format to a file. |
protected void |
setIOHandler(IOHandler ioh)
Sets a specific IOHandler to be used by this module. |
protected void |
setIOMode(byte ioMode)
Sets the I/O mode the module is working in. |
void |
setURL(java.net.URL url)
Sets the location of the file to which the module either will export or import the diagram. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ViewPortConfigurator vpc
public static final byte OUTPUT_MODE
public static final byte INPUT_MODE
protected static final java.lang.String TAB_VIEWPORT
protected static final java.lang.String OPTION_SIZE_TYPE
protected static final java.lang.String OPTION_SIZE_USE_ORIGINAL
protected static final java.lang.String OPTION_SIZE_USE_CUSTOM_WIDTH
protected static final java.lang.String OPTION_SIZE_USE_CUSTOM_HEIGHT
protected static final java.lang.String OPTION_CUSTOM_WIDTH
protected static final java.lang.String OPTION_CUSTOM_HEIGHT
protected static final java.lang.String OPTION_MARGIN
protected static final java.lang.String OPTION_SCALING_FACTOR
protected static final java.lang.String OPTION_CLIP_TYPE
protected static final java.lang.String OPTION_CLIP_VIEW
protected static final java.lang.String OPTION_CLIP_GRAPH
protected static final java.lang.String TAB_TILING
protected static final java.lang.String OPTION_TILING_ACTIVE
protected static final java.lang.String OPTION_TILE_COLUMN_COUNT
protected static final java.lang.String OPTION_TILE_ROW_COUNT
protected static final java.lang.String OPTION_GENERATE_HTML_TABLE
Constructor Detail |
---|
protected IOHandlerModule(java.lang.String name, java.lang.String author, java.lang.String description)
IOHandlerModule(String)
instead.
Proper module description should take place in the API documentation.
IOHandlerModule
.
name
- the module's nameauthor
- the module's authordescription
- a short description of the module's functionalityprotected IOHandlerModule(java.lang.String name)
IOHandlerModule
.
name
- the module's nameMethod Detail |
---|
protected void setIOMode(byte ioMode)
OUTPUT_MODE
is set.
ioMode
- one of OUTPUT_MODE
or INPUT_MODE
.protected void configureViewPort(Graph2DView viewPort, Graph2DView originalView)
adoptViewPortOptions()
and
adoptRenderingHints(y.view.Graph2DView, y.view.Graph2DView)
.
viewPort
- the Graph2DView
used for exporting.originalView
- the exported graph's current view.protected void addViewPortOptions(OptionHandler options)
protected void addTilingOptions(OptionHandler options)
protected void adoptViewPortOptions()
protected void adoptRenderingHints(Graph2DView viewPort, Graph2DView originalView)
RenderingHints.KEY_FRACTIONALMETRICS
hint from the original view
if that hint is not already set for the export view.
viewPort
- the Graph2DView
used for exporting.originalView
- the exported graph's current view.Graph2DView.getRenderingHints()
public byte getIOMode()
public void setURL(java.net.URL url)
public java.net.URL getURL()
protected abstract IOHandler createIOHandler()
public IOHandler getIOHandler()
protected void setIOHandler(IOHandler ioh)
protected void mainrun()
mainrun
in class YModule
|
© Copyright 2000-2022, yWorks GmbH. All rights reserved. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |