com.jrefinery.report.preview
Class PageSetupPlugin

java.lang.Object
  |
  +--com.jrefinery.report.preview.AbstractExportPlugin
        |
        +--com.jrefinery.report.preview.PageSetupPlugin
All Implemented Interfaces:
ExportPlugin

public class PageSetupPlugin
extends AbstractExportPlugin


Field Summary
static java.lang.String BASE_RESOURCE_CLASS
          The base resource class.
 
Constructor Summary
PageSetupPlugin()
          Default Constructor.
 
Method Summary
 javax.swing.KeyStroke getAcceleratorKey()
          Returns the accelerator key for the export action.
 java.lang.String getDisplayName()
          Returns the display name for the export action.
 javax.swing.Icon getLargeIcon()
          Returns the large icon for the export action.
 java.lang.Integer getMnemonicKey()
          Returns the mnemonic key code.
 java.lang.String getShortDescription()
          Returns the short description for the export action.
 javax.swing.Icon getSmallIcon()
          Returns the small icon for the export action.
 boolean isControlPlugin()
          Returns true, when this export plugin is used to configure the report or an other plugin.
 boolean isSeparated()
          Returns true if the action is separated, and false otherwise.
 boolean performExport(JFreeReport report)
          Exports a report.
 
Methods inherited from class com.jrefinery.report.preview.AbstractExportPlugin
getBase, getFailureDescription, getProxy, init, isAddToToolbar
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BASE_RESOURCE_CLASS

public static final java.lang.String BASE_RESOURCE_CLASS
The base resource class.

See Also:
Constant Field Values
Constructor Detail

PageSetupPlugin

public PageSetupPlugin()
Default Constructor.

Method Detail

isControlPlugin

public boolean isControlPlugin()
Returns true, when this export plugin is used to configure the report or an other plugin.

Specified by:
isControlPlugin in interface ExportPlugin
Overrides:
isControlPlugin in class AbstractExportPlugin
Returns:
true if this is a control plugin, false otherwise.

performExport

public boolean performExport(JFreeReport report)
Exports a report.

Parameters:
report - the report.
Returns:
A boolean.

getDisplayName

public java.lang.String getDisplayName()
Returns the display name for the export action.

Returns:
The display name.

getShortDescription

public java.lang.String getShortDescription()
Returns the short description for the export action.

Returns:
The short description.

getSmallIcon

public javax.swing.Icon getSmallIcon()
Returns the small icon for the export action.

Returns:
The icon.

getLargeIcon

public javax.swing.Icon getLargeIcon()
Returns the large icon for the export action.

Returns:
The icon.

getAcceleratorKey

public javax.swing.KeyStroke getAcceleratorKey()
Returns the accelerator key for the export action.

Returns:
The accelerator key.

getMnemonicKey

public java.lang.Integer getMnemonicKey()
Returns the mnemonic key code.

Returns:
The code.

isSeparated

public boolean isSeparated()
Returns true if the action is separated, and false otherwise.

Specified by:
isSeparated in interface ExportPlugin
Overrides:
isSeparated in class AbstractExportPlugin
Returns:
A boolean.