org.emboss.jemboss.editor
Class PrintAlignmentImage

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.emboss.jemboss.gui.ScrollPanel
                      extended byorg.emboss.jemboss.editor.PrintAlignmentImage
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable

public class PrintAlignmentImage
extends ScrollPanel

Print png/jpeg image and print preview. Java 1.4 or higher is required for the imageio package which is used here to create jpeg and png images of the multiple alignment.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  boolean antiAlias
          use anti aliasing (default is false)
private  java.lang.String filePrefix
          prefix of file
private  java.awt.print.PageFormat format
          page format
private  GraphicSequenceCollection gsc
          alignment sequence panel
private  int nResPerLine
          number of residues per line
private  int pageIndex
          page number to print
private  javax.swing.JTextField statusField
          status field for print preview
 
Fields inherited from class javax.swing.JPanel
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
PrintAlignmentImage(GraphicSequenceCollection gsc)
           
PrintAlignmentImage(GraphicSequenceCollection gsc, java.awt.print.PageFormat format)
           
 
Method Summary
private  java.awt.image.RenderedImage createAlignmentImage(int pageIndex)
          Returns a generated image
protected  java.awt.print.PageFormat getFormat()
          Get the page format
protected  java.awt.print.PageFormat getFormatDialog()
          Get a default page format
 void paintComponent(java.awt.Graphics g)
          Override this method to draw the sequences
 void print()
          Print to a jpeg or png file
 void print(int nResPerLine, java.lang.String type, java.lang.String filePrefix, boolean landscape, double leftMargin, double rightMargin, double topMargin, double btmMargin)
          Print to a jpeg or png file
 void print(int nResPerLine, java.lang.String type, java.lang.String filePrefix, double leftMargin, double rightMargin, double topMargin, double btmMargin)
          Print to one jpeg or png file
 void print(java.lang.String type, double leftMargin, double rightMargin, double topMargin, double btmMargin)
          Print to one jpeg or png file
protected  void printPreview()
          Display a print preview page
protected  void printSinglePagePreview()
          Display a single page print preview page
protected  void setAntiAlias(boolean antiAlias)
           
protected  void setFormat(java.awt.print.PageFormat format)
          Set the page format
 void setPageIndex(int pageIndex)
          Set the page number to create an image of
protected  java.lang.String showOptions(boolean showFileOptions)
          Provide some options for the image created
private  void writeImageToFile(java.awt.image.RenderedImage image, java.io.File file, java.lang.String type)
          Write out the image
 
Methods inherited from class org.emboss.jemboss.gui.ScrollPanel
getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

format

private java.awt.print.PageFormat format
page format


pageIndex

private int pageIndex
page number to print


gsc

private GraphicSequenceCollection gsc
alignment sequence panel


filePrefix

private java.lang.String filePrefix
prefix of file


statusField

private javax.swing.JTextField statusField
status field for print preview


nResPerLine

private int nResPerLine
number of residues per line


antiAlias

private boolean antiAlias
use anti aliasing (default is false)

Constructor Detail

PrintAlignmentImage

public PrintAlignmentImage(GraphicSequenceCollection gsc,
                           java.awt.print.PageFormat format)
Parameters:
gsc - sequence panel

PrintAlignmentImage

public PrintAlignmentImage(GraphicSequenceCollection gsc)
Parameters:
gsc - sequence panel
Method Detail

setFormat

protected void setFormat(java.awt.print.PageFormat format)
Set the page format

Parameters:
format - to use for the image

getFormat

protected java.awt.print.PageFormat getFormat()
Get the page format

Returns:
format to use for the image

setPageIndex

public void setPageIndex(int pageIndex)
Set the page number to create an image of

Parameters:
pageIndex - page number

paintComponent

public void paintComponent(java.awt.Graphics g)
Override this method to draw the sequences

Returns:
Graphics g

print

public void print()
Print to a jpeg or png file


print

public void print(int nResPerLine,
                  java.lang.String type,
                  java.lang.String filePrefix,
                  boolean landscape,
                  double leftMargin,
                  double rightMargin,
                  double topMargin,
                  double btmMargin)
Print to a jpeg or png file


print

public void print(java.lang.String type,
                  double leftMargin,
                  double rightMargin,
                  double topMargin,
                  double btmMargin)
Print to one jpeg or png file


print

public void print(int nResPerLine,
                  java.lang.String type,
                  java.lang.String filePrefix,
                  double leftMargin,
                  double rightMargin,
                  double topMargin,
                  double btmMargin)
Print to one jpeg or png file


showOptions

protected java.lang.String showOptions(boolean showFileOptions)
Provide some options for the image created

Parameters:
showFileOptions - display file options

getFormatDialog

protected java.awt.print.PageFormat getFormatDialog()
Get a default page format

Returns:
page format

setAntiAlias

protected void setAntiAlias(boolean antiAlias)

createAlignmentImage

private java.awt.image.RenderedImage createAlignmentImage(int pageIndex)
Returns a generated image

Parameters:
pageIndex - page number
Returns:
image

printSinglePagePreview

protected void printSinglePagePreview()
Display a single page print preview page


printPreview

protected void printPreview()
Display a print preview page


writeImageToFile

private void writeImageToFile(java.awt.image.RenderedImage image,
                              java.io.File file,
                              java.lang.String type)
Write out the image

Parameters:
image - image
file - file to write image to
type - type of image