Package org.pentaho.reporting.engine.classic.core.modules.gui.base

Class PreviewPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.pentaho.reporting.engine.classic.core.modules.gui.base.PreviewPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ReportEventSource

public class PreviewPane
extends JPanel
implements ReportEventSource

Creation-Date: 11.11.2006, 19:36:13

Author:

Thomas Morgner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLOSED_PROPERTY
static String	ERROR_PROPERTY
static String	ICON_THEME_PROPERTY
static String	MENU_PROPERTY
static String	NUMBER_OF_PAGES_PROPERTY
static String	PAGE_NUMBER_PROPERTY
static String	PAGINATED_PROPERTY
static String	PAGINATING_PROPERTY
static String	PREVIEW_MAXIMUM_HEIGHT	The maximum height key.
static String	PREVIEW_MAXIMUM_WIDTH	The maximum width key.
static String	PREVIEW_PREFERRED_HEIGHT	The preferred height key.
static String	PREVIEW_PREFERRED_WIDTH	The preferred width key.
static String	REPORT_CONTROLLER_PROPERTY
static String	REPORT_JOB_PROPERTY
static String	STATUS_TEXT_PROPERTY
static String	STATUS_TYPE_PROPERTY
static String	TITLE_PROPERTY
static String	ZOOM_MAXIMUM_KEY	The maximum zoom key.
static String	ZOOM_MINIMUM_KEY	The minimum zoom key.
static String	ZOOM_PROPERTY

Fields inherited from class javax.swing.JComponent

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.Component

accessibleContext, 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

Constructors

Constructor	Description
PreviewPane()	Creates a new JPanel with a double buffer and a flow layout.
PreviewPane(boolean init)

Method Summary

Modifier and Type	Method	Description
void	addReportHyperlinkListener(ReportHyperlinkListener listener)
void	addReportProgressListener(ReportProgressListener progressListener)
protected JToolBar	buildToolbar(boolean floatable)
protected org.pentaho.reporting.libraries.base.config.Configuration	computeContextConfiguration()
protected Worker	createWorker()
protected JComboBox	createZoomSelector(PreviewPane pane)
protected void	fireReportHyperlinkEvent(ReportHyperlinkEvent event)
protected String	formatZoomText(double zoom)
protected void	forwardReportFinishedEvent(ReportProgressEvent event)
protected void	forwardReportStartedEvent(ReportProgressEvent event)
protected void	forwardReportUpdateEvent(ReportProgressEvent event)
Throwable	getError()
IconTheme	getIconTheme()
Locale	getLocale()
JMenu[]	getMenu()
Object	getNoReportDrawable()
int	getNumberOfPages()
int	getPageNumber()
Object	getPaginatingDrawable()
PrintReportProcessor	getPrintReportProcessor()
ReportController	getReportController()
MasterReport	getReportJob()
PreviewDrawablePanel	getReportPreviewArea()
protected StatusListener	getStatusListener()
String	getStatusText()
StatusType	getStatusType()
SwingGuiContext	getSwingGuiContext()
String	getTitle()
JToolBar	getToolBar()
protected Action[]	getToolbarPreActions()	Gets a list of Actions to add to the toolbar ahead of all other toolbar actions.
double	getZoom()
double[]	getZoomFactors()
org.pentaho.reporting.libraries.designtime.swing.KeyedComboBoxModel<Double,String>	getZoomModel()
protected void	initializeFromReport()
protected void	initializeWithoutJob()
boolean	isClosed()
boolean	isDeferredRepagination()
protected boolean	isHyperlinkSystemActive()
boolean	isPaginated()
boolean	isPaginating()
boolean	isToolbarFloatable()
protected float	parseRelativeFloat(String value)
void	removeReportHyperlinkListener(ReportHyperlinkListener listener)
void	removeReportProgressListener(ReportProgressListener progressListener)
void	setClosed(boolean closed)
void	setDeferredRepagination(boolean deferredRepagination)
void	setError(Throwable error)
protected void	setIconTheme(IconTheme theme)
protected void	setMenu(JMenu[] menus)
void	setNoReportDrawable(Object noReportDrawable)
void	setNumberOfPages(int numberOfPages)
void	setPageNumber(int pageNumber)
void	setPaginated(boolean paginated)
void	setPaginating(boolean paginating)
void	setPaginatingDrawable(Object paginatingDrawable)
protected void	setPrintReportProcessor(PrintReportProcessor printReportProcessor)
void	setReportController(ReportController reportController)
void	setReportJob(MasterReport reportJob)
void	setStatusText(String statusText)
void	setStatusType(StatusType statusType)
void	setTitle(String title)
void	setToolbarFloatable(boolean toolbarFloatable)
void	setZoom(double zoom)
void	startPagination()
protected void	updateVisiblePage(int pageNumber)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.ReportEventSource

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

STATUS_TEXT_PROPERTY

public static final String STATUS_TEXT_PROPERTY

See Also:

Constant Field Values

STATUS_TYPE_PROPERTY

public static final String STATUS_TYPE_PROPERTY

See Also:

Constant Field Values

REPORT_CONTROLLER_PROPERTY

public static final String REPORT_CONTROLLER_PROPERTY

See Also:

Constant Field Values

ZOOM_PROPERTY

public static final String ZOOM_PROPERTY

See Also:

Constant Field Values

CLOSED_PROPERTY

public static final String CLOSED_PROPERTY

See Also:

Constant Field Values

ERROR_PROPERTY

public static final String ERROR_PROPERTY

See Also:

Constant Field Values

REPORT_JOB_PROPERTY

public static final String REPORT_JOB_PROPERTY

See Also:

Constant Field Values

PAGINATING_PROPERTY

public static final String PAGINATING_PROPERTY

See Also:

Constant Field Values

PAGINATED_PROPERTY

public static final String PAGINATED_PROPERTY

See Also:

Constant Field Values

PAGE_NUMBER_PROPERTY

public static final String PAGE_NUMBER_PROPERTY

See Also:

Constant Field Values

NUMBER_OF_PAGES_PROPERTY

public static final String NUMBER_OF_PAGES_PROPERTY

See Also:

Constant Field Values

ICON_THEME_PROPERTY

public static final String ICON_THEME_PROPERTY

See Also:

Constant Field Values

TITLE_PROPERTY

public static final String TITLE_PROPERTY

See Also:

Constant Field Values

MENU_PROPERTY

public static final String MENU_PROPERTY

See Also:

Constant Field Values

PREVIEW_PREFERRED_WIDTH

public static final String PREVIEW_PREFERRED_WIDTH

The preferred width key.

See Also:

Constant Field Values

PREVIEW_PREFERRED_HEIGHT

public static final String PREVIEW_PREFERRED_HEIGHT

The preferred height key.

See Also:

Constant Field Values

PREVIEW_MAXIMUM_WIDTH

public static final String PREVIEW_MAXIMUM_WIDTH

The maximum width key.

See Also:

Constant Field Values

PREVIEW_MAXIMUM_HEIGHT

public static final String PREVIEW_MAXIMUM_HEIGHT

The maximum height key.

See Also:

Constant Field Values

ZOOM_MAXIMUM_KEY

public static final String ZOOM_MAXIMUM_KEY

The maximum zoom key.

See Also:

Constant Field Values

ZOOM_MINIMUM_KEY

public static final String ZOOM_MINIMUM_KEY

The minimum zoom key.

See Also:

Constant Field Values

Constructor Detail

PreviewPane

public PreviewPane()

Creates a new JPanel with a double buffer and a flow layout.

PreviewPane

public PreviewPane(boolean init)

Method Detail

createZoomSelector

protected JComboBox createZoomSelector(PreviewPane pane)

getReportPreviewArea

public PreviewDrawablePanel getReportPreviewArea()

isDeferredRepagination

public boolean isDeferredRepagination()

setDeferredRepagination

public void setDeferredRepagination(boolean deferredRepagination)

getPrintReportProcessor

public PrintReportProcessor getPrintReportProcessor()

setPrintReportProcessor

protected void setPrintReportProcessor(PrintReportProcessor printReportProcessor)

getMenu

public JMenu[] getMenu()

setMenu

protected void setMenu(JMenu[] menus)

getToolBar

public JToolBar getToolBar()

getStatusText

public String getStatusText()

setStatusText

public void setStatusText(String statusText)

getError

public Throwable getError()

setError

public void setError(Throwable error)

getStatusType

public StatusType getStatusType()

setStatusType

public void setStatusType(StatusType statusType)

getReportController

public ReportController getReportController()

setReportController

public void setReportController(ReportController reportController)

getReportJob

public MasterReport getReportJob()

Specified by:

getReportJob in interface ReportEventSource

setReportJob

public void setReportJob(MasterReport reportJob)

getZoom

public double getZoom()

setZoom

public void setZoom(double zoom)

isClosed

public boolean isClosed()

setClosed

public void setClosed(boolean closed)

getLocale

public Locale getLocale()

Overrides:

getLocale in class Component

getNumberOfPages

public int getNumberOfPages()

Specified by:

getNumberOfPages in interface ReportEventSource

setNumberOfPages

public void setNumberOfPages(int numberOfPages)

getPageNumber

public int getPageNumber()

Specified by:

getPageNumber in interface ReportEventSource

setPageNumber

public void setPageNumber(int pageNumber)

getIconTheme

public IconTheme getIconTheme()

setIconTheme

protected void setIconTheme(IconTheme theme)

initializeFromReport

protected void initializeFromReport()

initializeWithoutJob

protected void initializeWithoutJob()

parseRelativeFloat

protected float parseRelativeFloat(String value)

getToolbarPreActions

protected Action[] getToolbarPreActions()

Gets a list of Actions to add to the toolbar ahead of all other toolbar actions. Left protected for subclasses to override.

Returns:

Action[] an array of javax.swing.Action objects

buildToolbar

protected JToolBar buildToolbar(boolean floatable)

setToolbarFloatable

public void setToolbarFloatable(boolean toolbarFloatable)

isToolbarFloatable

public boolean isToolbarFloatable()

getSwingGuiContext

public SwingGuiContext getSwingGuiContext()

getZoomModel

public org.pentaho.reporting.libraries.designtime.swing.KeyedComboBoxModel<Double,String> getZoomModel()

formatZoomText

protected final String formatZoomText(double zoom)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getZoomFactors

public double[] getZoomFactors()

isPaginated

public boolean isPaginated()

Specified by:

isPaginated in interface ReportEventSource

setPaginated

public void setPaginated(boolean paginated)

isPaginating

public boolean isPaginating()

Specified by:

isPaginating in interface ReportEventSource

setPaginating

public void setPaginating(boolean paginating)

startPagination

public void startPagination()

createWorker

protected Worker createWorker()

getNoReportDrawable

public Object getNoReportDrawable()

setNoReportDrawable

public void setNoReportDrawable(Object noReportDrawable)

getPaginatingDrawable

public Object getPaginatingDrawable()

setPaginatingDrawable

public void setPaginatingDrawable(Object paginatingDrawable)

updateVisiblePage

protected void updateVisiblePage(int pageNumber)

getStatusListener

protected StatusListener getStatusListener()

addReportProgressListener

public void addReportProgressListener(ReportProgressListener progressListener)

removeReportProgressListener

public void removeReportProgressListener(ReportProgressListener progressListener)

forwardReportStartedEvent

protected void forwardReportStartedEvent(ReportProgressEvent event)

forwardReportUpdateEvent

protected void forwardReportUpdateEvent(ReportProgressEvent event)

forwardReportFinishedEvent

protected void forwardReportFinishedEvent(ReportProgressEvent event)

addReportHyperlinkListener

public void addReportHyperlinkListener(ReportHyperlinkListener listener)

removeReportHyperlinkListener

public void removeReportHyperlinkListener(ReportHyperlinkListener listener)

isHyperlinkSystemActive

protected boolean isHyperlinkSystemActive()

fireReportHyperlinkEvent

protected void fireReportHyperlinkEvent(ReportHyperlinkEvent event)

computeContextConfiguration

protected org.pentaho.reporting.libraries.base.config.Configuration computeContextConfiguration()