PrintableComponent (interruptible-weka 0.1.2 API)

java.lang.Object
- weka.gui.visualize.PrintableComponent

All Implemented Interfaces:

PrintableHandler
```
public class PrintableComponent
extends java.lang.Object
implements PrintableHandler
```
This class extends the component which is handed over in the constructor by a print dialog. The Print dialog is accessible via Alt+Shift+LeftMouseClick.
The individual JComponentWriter-descendants can be accessed by the getWriter(String) method, if the parameters need to be changed.

See Also:

getWriters(), getWriter(String)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class PrintableComponent.JComponentWriterFileFilter
a specialized filter that also contains the associated filter class.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`PrintableComponent.JComponentWriterFileFilter` a specialized filter that also contains the associated filter class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`m_AspectRatio` the aspect ratio.
`protected static javax.swing.JCheckBox`	`m_AspectRatioCheckBox` the checkbox for keeping the aspect ration.
`protected javax.swing.JComponent`	`m_Component` the parent component of this print dialog.
`protected static javax.swing.JCheckBox`	`m_CustomDimensionsCheckBox` the checkbox for the custom dimensions.
`protected static javax.swing.JTextField`	`m_CustomHeightText` the edit field for the custom height.
`protected static javax.swing.JTextField`	`m_CustomWidthText` the edit field for the custom width.
`protected static javax.swing.JFileChooser`	`m_FileChooserPanel` the filechooser for saving the panel.
`protected boolean`	`m_IgnoreChange` whether to ignore the update of the text field (in case of "keep ratio").
`protected java.lang.String`	`m_SaveDialogTitle` the title of the save dialog.
`protected static boolean`	`m_ShowToolTip` whether to display the tooltip or not.
`protected static boolean`	`m_ToolTipUserAsked` whether the user was already asked about the tooltip behavior.
`protected double`	`m_xScale` the x scale factor.
`protected double`	`m_yScale` the y scale factor.
`protected static java.lang.String`	`PROPERTY_SHOW` the property name for showing the tooltip.
`protected static java.lang.String`	`PROPERTY_USERASKED` the property name whether the user was already asked.

Constructor Summary

Constructors
Constructor and Description

PrintableComponent(javax.swing.JComponent component)
initializes the panel.

Constructors
Constructor and Description
`PrintableComponent(javax.swing.JComponent component)` initializes the panel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.swing.JComponent`	`getComponent()` returns the GUI component this print dialog is part of.
`java.lang.String`	`getSaveDialogTitle()` returns the title for the save dialog.
`static java.lang.String`	`getToolTipText(PrintableComponent component)` Returns a tooltip only if the user wants it.
`JComponentWriter`	`getWriter(java.lang.String name)` returns the JComponentWriter associated with the given name, is `null` if not found.
`java.util.Hashtable<java.lang.String,JComponentWriter>`	`getWriters()` returns a Hashtable with the current available JComponentWriters in the save dialog. the key of the Hashtable is the description of the writer.
`double`	`getXScale()` returns the scale factor for the x-axis.
`double`	`getYScale()` returns the scale factor for the y-axis.
`protected void`	`initFileChooser()` initializes the filechooser, i.e. locates all the available writers in the current package
`void`	`saveComponent()` displays a save dialog for saving the panel to a file.
`void`	`setSaveDialogTitle(java.lang.String title)` sets the title for the save dialog.
`void`	`setScale(double x, double y)` sets the scale factor.
`protected void`	`updateDimensions(javax.swing.JTextField sender)` updates the dimensions if necessary (i.e., if aspect ratio is to be kept).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_Component
```
protected javax.swing.JComponent m_Component
```
    the parent component of this print dialog.
  - m_FileChooserPanel
```
protected static javax.swing.JFileChooser m_FileChooserPanel
```
    the filechooser for saving the panel.
  - m_CustomDimensionsCheckBox
```
protected static javax.swing.JCheckBox m_CustomDimensionsCheckBox
```
    the checkbox for the custom dimensions.
  - m_CustomWidthText
```
protected static javax.swing.JTextField m_CustomWidthText
```
    the edit field for the custom width.
  - m_CustomHeightText
```
protected static javax.swing.JTextField m_CustomHeightText
```
    the edit field for the custom height.
  - m_AspectRatioCheckBox
```
protected static javax.swing.JCheckBox m_AspectRatioCheckBox
```
    the checkbox for keeping the aspect ration.
  - m_SaveDialogTitle
```
protected java.lang.String m_SaveDialogTitle
```
    the title of the save dialog.
  - m_xScale
```
protected double m_xScale
```
    the x scale factor.
  - m_yScale
```
protected double m_yScale
```
    the y scale factor.
  - m_AspectRatio
```
protected double m_AspectRatio
```
    the aspect ratio.
  - m_IgnoreChange
```
protected boolean m_IgnoreChange
```
    whether to ignore the update of the text field (in case of "keep ratio").
  - m_ToolTipUserAsked
```
protected static boolean m_ToolTipUserAsked
```
    whether the user was already asked about the tooltip behavior.
  - PROPERTY_SHOW
```
protected static final java.lang.String PROPERTY_SHOW
```
    the property name for showing the tooltip.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USERASKED
```
protected static final java.lang.String PROPERTY_USERASKED
```
    the property name whether the user was already asked.
    
    See Also:
    
    Constant Field Values
  - m_ShowToolTip
```
protected static boolean m_ShowToolTip
```
    whether to display the tooltip or not.
- Constructor Detail
  - PrintableComponent
```
public PrintableComponent(javax.swing.JComponent component)
```
    initializes the panel.
    
    Parameters:
    
    component - the component to enhance with printing functionality
- Method Detail
  - getComponent
```
public javax.swing.JComponent getComponent()
```
    returns the GUI component this print dialog is part of.
    
    Returns:
    
    the GUI component
  - getToolTipText
```
public static java.lang.String getToolTipText(PrintableComponent component)
```
    Returns a tooltip only if the user wants it. If retrieved for the first, a dialog pops up and asks the user whether the tooltip should always appear or not. The weka/gui/visualize/Visualize.props is then written in the user's home directory.
    
    Parameters:
    
    component - the PrintableComponent to ask for
    
    Returns:
    
    null if the user doesn't want the tooltip, otherwise the text
  - initFileChooser
```
protected void initFileChooser()
```
    initializes the filechooser, i.e. locates all the available writers in the current package
  - updateDimensions
```
protected void updateDimensions(javax.swing.JTextField sender)
```
    updates the dimensions if necessary (i.e., if aspect ratio is to be kept).
    
    Parameters:
    
    sender - the JTextField which send the notification to update
  - getWriters
```
public java.util.Hashtable<java.lang.String,JComponentWriter> getWriters()
```
    returns a Hashtable with the current available JComponentWriters in the save dialog. the key of the Hashtable is the description of the writer.
    
    Specified by:
    
    getWriters in interface PrintableHandler
    
    Returns:
    
    all currently available JComponentWriters
    
    See Also:
    
    JComponentWriter.getDescription()
  - getWriter
```
public JComponentWriter getWriter(java.lang.String name)
```
    returns the JComponentWriter associated with the given name, is null if not found.
    
    Specified by:
    
    getWriter in interface PrintableHandler
    
    Parameters:
    
    name - the name of the writer
    
    Returns:
    
    the writer associated with the given name
    
    See Also:
    
    JComponentWriter.getDescription()
  - setSaveDialogTitle
```
public void setSaveDialogTitle(java.lang.String title)
```
    sets the title for the save dialog.
    
    Specified by:
    
    setSaveDialogTitle in interface PrintableHandler
    
    Parameters:
    
    title - the title of the save dialog
  - getSaveDialogTitle
```
public java.lang.String getSaveDialogTitle()
```
    returns the title for the save dialog.
    
    Specified by:
    
    getSaveDialogTitle in interface PrintableHandler
    
    Returns:
    
    the title of the save dialog
  - setScale
```
public void setScale(double x,
                     double y)
```
    sets the scale factor.
    
    Specified by:
    
    setScale in interface PrintableHandler
    
    Parameters:
    
    x - the scale factor for the x-axis
    
    y - the scale factor for the y-axis
  - getXScale
```
public double getXScale()
```
    returns the scale factor for the x-axis.
    
    Specified by:
    
    getXScale in interface PrintableHandler
    
    Returns:
    
    the scale factor
  - getYScale
```
public double getYScale()
```
    returns the scale factor for the y-axis.
    
    Specified by:
    
    getYScale in interface PrintableHandler
    
    Returns:
    
    the scale factor
  - saveComponent
```
public void saveComponent()
```
    displays a save dialog for saving the panel to a file. Fixes a bug with the Swing JFileChooser: if you entered a new filename in the save dialog and press Enter the getSelectedFile method returns null instead of the filename.
    To solve this annoying behavior we call the save dialog once again s.t. the filename is set. Might look a little bit strange to the user, but no NullPointerException! ;-)
    
    Specified by:
    
    saveComponent in interface PrintableHandler

Class PrintableComponent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_Component

m_FileChooserPanel

m_CustomDimensionsCheckBox

m_CustomWidthText

m_CustomHeightText

m_AspectRatioCheckBox

m_SaveDialogTitle

m_xScale

m_yScale

m_AspectRatio

m_IgnoreChange

m_ToolTipUserAsked

PROPERTY_SHOW

PROPERTY_USERASKED

m_ShowToolTip

Constructor Detail

PrintableComponent

Method Detail

getComponent

getToolTipText

initFileChooser

updateDimensions

getWriters

getWriter

setSaveDialogTitle

getSaveDialogTitle

setScale

getXScale

getYScale

saveComponent