com.mindfusion.diagramming
Class RenderOptions

java.lang.Object
  extended by com.mindfusion.diagramming.RenderOptions
Direct Known Subclasses:
PrintOptions

public class RenderOptions
extends java.lang.Object

Defines the attributes of a printed diagram. Use the PrintOptions object returned by the DiagramView.getPrintOptions() method to set the attributes of a specific diagram.


Constructor Summary
RenderOptions()
          Initializes a new RenderOptions instance.
 
Method Summary
 SmoothingMode getAntiAlias()
           
 java.lang.String getDocumentName()
          Gets the document name.
 boolean getEnableAnchors()
          Gets a value indicating whether anchor point marks will be printed.
 boolean getEnableBackground()
          Gets a value indicating whether the diagram background will be filled using the Diagram.getBackBrush() background brush.
 boolean getEnableBackgroundImage()
          Gets a value indicating whether the diagram's background image will be printed.
 boolean getEnableEffects()
          Gets a value indicating whether to render special node effects.
 boolean getEnableFitToPage()
           
 boolean getEnableGrid()
          Gets a value indicating whether the alignment grid is rendered.
 boolean getEnableImages()
          Gets a value indicating whether images that are displayed inside nodes will be printed.
 boolean getEnableInterior()
          Gets a value indicating whether the nodes will be filled when printed.
 boolean getEnableShadows()
          Gets a value indicating whether item shadows will be printed.
 boolean getEnableText()
           
 java.lang.String getHeaderFormat()
          Gets the page header format string.
 int getHyperLinkStyle()
           
 java.lang.String getHyperLinkTarget()
           
 int getRenderTarget()
           
 float getScale()
          Gets the scale of the printed diagram relatively to the original on-screen size of the diagram.
 double getScrollX()
           
 double getScrollY()
           
 java.lang.Object getTargetView()
           
 SmoothingMode getTextAntiAlias()
           
 java.awt.geom.Rectangle2D getVisibleRect()
           
 void setAntiAlias(SmoothingMode smoothingMode)
           
 void setDocumentName(java.lang.String value)
          Sets the document name.
 void setEnableAnchors(boolean value)
          Sets a value indicating whether anchor point marks should be printed.
 void setEnableBackground(boolean value)
          Sets a value indicating whether the diagram background should be filled using the Diagram.getBackBrush() background brush.
 void setEnableBackgroundImage(boolean value)
          Sets a value indicating whether the diagram's background image should be printed.
 void setEnableEffects(boolean value)
          Sets a value indicating whether to render special node effects.
 void setEnableFitToPage(boolean value)
           
 void setEnableGrid(boolean value)
          Gets a value indicating whether the alignment grid is rendered.
 void setEnableImages(boolean value)
          Sets a value indicating whether images that are displayed inside nodes should be printed.
 void setEnableInterior(boolean value)
          Sets a value indicating whether the nodes should be filled when printed.
 void setEnableShadows(boolean value)
          Sets a value indicating whether item shadows should be printed.
 void setEnableText(boolean value)
           
 void setHeaderFormat(java.lang.String value)
          Sets the page header format string.
 void setHyperLinkStyle(int value)
           
 void setHyperLinkTarget(java.lang.String value)
           
 void setRenderTarget(int renderTarget)
           
 void setScale(float value)
          Sets the scale of the printed diagram relatively to the original on-screen size of the diagram.
 void setScrollX(double value)
           
 void setScrollY(double value)
           
 void setTargetView(java.lang.Object targetView)
           
 void setTextAntiAlias(SmoothingMode textAntiAlias)
           
 void setVisibleRect(java.awt.geom.Rectangle2D visibleRect)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RenderOptions

public RenderOptions()
Initializes a new RenderOptions instance.

Method Detail

getDocumentName

public java.lang.String getDocumentName()
Gets the document name.

Returns:
A String containing the document name.

setDocumentName

public void setDocumentName(java.lang.String value)
Sets the document name.

Parameters:
value - A String containing the document name.

getHeaderFormat

public java.lang.String getHeaderFormat()
Gets the page header format string.

Returns:
A String containing formatting attributes for the page headers.

setHeaderFormat

public void setHeaderFormat(java.lang.String value)
Sets the page header format string.

Parameters:
value - A String containing formatting attributes for the page headers.

getScale

public float getScale()
Gets the scale of the printed diagram relatively to the original on-screen size of the diagram.

Returns:
A float value specifying percents of the original diagram size.

setScale

public void setScale(float value)
Sets the scale of the printed diagram relatively to the original on-screen size of the diagram.

Parameters:
value - A float value specifying percents of the original diagram size. The default value is 100.

getEnableShadows

public boolean getEnableShadows()
Gets a value indicating whether item shadows will be printed.

Returns:
true if shadows will be printed, otherwise false.

setEnableShadows

public void setEnableShadows(boolean value)
Sets a value indicating whether item shadows should be printed.

Parameters:
value - true if shadows should be printed, otherwise false.

getEnableImages

public boolean getEnableImages()
Gets a value indicating whether images that are displayed inside nodes will be printed.

Returns:
true if images will be printed, otherwise false.

setEnableImages

public void setEnableImages(boolean value)
Sets a value indicating whether images that are displayed inside nodes should be printed.

Parameters:
value - true if images should be printed, otherwise false.

getEnableInterior

public boolean getEnableInterior()
Gets a value indicating whether the nodes will be filled when printed.

Returns:
true if nodes will be filled, otherwise false.

setEnableInterior

public void setEnableInterior(boolean value)
Sets a value indicating whether the nodes should be filled when printed.

Parameters:
value - true if nodes should be filled, otherwise false.

getEnableAnchors

public boolean getEnableAnchors()
Gets a value indicating whether anchor point marks will be printed.

Returns:
true if anchor point marks will be printed, otherwise false.

setEnableAnchors

public void setEnableAnchors(boolean value)
Sets a value indicating whether anchor point marks should be printed.

Parameters:
value - true if anchor point marks should be printed, otherwise false.

getEnableBackground

public boolean getEnableBackground()
Gets a value indicating whether the diagram background will be filled using the Diagram.getBackBrush() background brush.

Returns:
true if the background will be filled when printing, otherwise false.

setEnableBackground

public void setEnableBackground(boolean value)
Sets a value indicating whether the diagram background should be filled using the Diagram.getBackBrush() background brush.

Parameters:
value - true if the background should be filled when printing, otherwise false.

getEnableEffects

public boolean getEnableEffects()
Gets a value indicating whether to render special node effects.

Returns:
true if node effects should be rendered; otherwise, false.

setEnableEffects

public void setEnableEffects(boolean value)
Sets a value indicating whether to render special node effects.

Parameters:
value - true if node effects should be rendered; otherwise, false.

getEnableGrid

public boolean getEnableGrid()
Gets a value indicating whether the alignment grid is rendered.


setEnableGrid

public void setEnableGrid(boolean value)
Gets a value indicating whether the alignment grid is rendered.


getEnableBackgroundImage

public boolean getEnableBackgroundImage()
Gets a value indicating whether the diagram's background image will be printed.

Returns:
true if the background image will be printed, otherwise false.

setEnableBackgroundImage

public void setEnableBackgroundImage(boolean value)
Sets a value indicating whether the diagram's background image should be printed.

Parameters:
value - true if the background image should be printed, otherwise false.

getEnableText

public boolean getEnableText()

setEnableText

public void setEnableText(boolean value)

setEnableFitToPage

public void setEnableFitToPage(boolean value)

getEnableFitToPage

public boolean getEnableFitToPage()

getAntiAlias

public SmoothingMode getAntiAlias()

setAntiAlias

public void setAntiAlias(SmoothingMode smoothingMode)

getTextAntiAlias

public SmoothingMode getTextAntiAlias()

setTextAntiAlias

public void setTextAntiAlias(SmoothingMode textAntiAlias)

getRenderTarget

public int getRenderTarget()

setRenderTarget

public void setRenderTarget(int renderTarget)

getHyperLinkTarget

public java.lang.String getHyperLinkTarget()

setHyperLinkTarget

public void setHyperLinkTarget(java.lang.String value)

getHyperLinkStyle

public int getHyperLinkStyle()

setHyperLinkStyle

public void setHyperLinkStyle(int value)

getVisibleRect

public java.awt.geom.Rectangle2D getVisibleRect()

setVisibleRect

public void setVisibleRect(java.awt.geom.Rectangle2D visibleRect)

getTargetView

public java.lang.Object getTargetView()

setTargetView

public void setTargetView(java.lang.Object targetView)

getScrollX

public double getScrollX()

setScrollX

public void setScrollX(double value)

getScrollY

public double getScrollY()

setScrollY

public void setScrollY(double value)