ilog.views.util.print

Class IlvPrintPreviewPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.util.print.IlvPrintPreviewPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class IlvPrintPreviewPanel
extends JPanel

A IlvPrintPreviewPanel is a component designed to preview the contents managed by a IlvPrintingController.

Since:

JViews 5.5

See Also:

IlvPrintPreviewDialog, IlvPrintingController.printPreview(java.awt.Window), IlvPrintingController.createPrintPreviewWindow(java.awt.Window), 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 and Description
static int	CONTINUOUS_MODE Preview mode that allows to preview all the pages together.
static int	SINGLE_PAGE_MODE Preview mode that allows to preview the pages one by one.

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 and Description
IlvPrintPreviewPanel(IlvPrintingController controller, int mode) Creates a IlvPrintPreviewDialog for the specified IlvPrintingController.

Method Summary

Modifier and Type	Method and Description
JButton	addToolbarAction(Action action) Adds a button in the toolbar.
Color	getMarginsColor() Returns the color used to paint the margins of the page.
Color	getPageColor() Returns the background color of a page.
Color	getPreviewBackground() Returns the background color of the preview area (behind the pages).
IlvPrintingController	getPrintingController() Returns the printing controller passed as a parameter of the constructor.
static String	getPrintPreviewTitle() Returns an internationalized string that can be used as a title of a Print preview dialog.
Color	getShadowColor() Returns the color used to paint the shadow of the page.
boolean	isMarginsVisible() Indicates if the margin delimiters are visible.
void	setCursor(Cursor c) Changes the cursor.
void	setMarginsColor(Color color) Specifies the color used to paint the margin delimiters of the page.
void	setMarginsVisible(boolean show) Specifies whether the page margins should be visible.
void	setPageColor(Color c) Changes the background color of a page.
void	setPreviewBackground(Color color) Specifies the background color of the preview area (behind the pages).
void	setShadowColor(Color color) Specifies the color used to paint the shadow around a page.

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, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Field Detail

SINGLE_PAGE_MODE

public static final int SINGLE_PAGE_MODE

Preview mode that allows to preview the pages one by one. This is the default mode.

See Also:

Constant Field Values

CONTINUOUS_MODE

public static final int CONTINUOUS_MODE

Preview mode that allows to preview all the pages together.

See Also:

Constant Field Values

Constructor Detail

IlvPrintPreviewPanel

public IlvPrintPreviewPanel(IlvPrintingController controller,
                            int mode)

Creates a IlvPrintPreviewDialog for the specified IlvPrintingController.

Parameters:

controller - The controller controlling the printing.

mode - The preview mode, is one of SINGLE_PAGE_MODE and CONTINUOUS_MODE.

Method Detail

getPrintPreviewTitle

public static String getPrintPreviewTitle()

Returns an internationalized string that can be used as a title of a Print preview dialog.

Since:

JViews 8.7

getPrintingController

public IlvPrintingController getPrintingController()

Returns the printing controller passed as a parameter of the constructor.

setPreviewBackground

public void setPreviewBackground(Color color)

Specifies the background color of the preview area (behind the pages).

Parameters:

color - The new color

See Also:

setMarginsVisible(boolean)

getPreviewBackground

public Color getPreviewBackground()

Returns the background color of the preview area (behind the pages).

setMarginsColor

public void setMarginsColor(Color color)

Specifies the color used to paint the margin delimiters of the page.

Parameters:

color - The new margin color.

See Also:

setMarginsVisible(boolean)

getMarginsColor

public Color getMarginsColor()

Returns the color used to paint the margins of the page.

Returns:

The margin color.

isMarginsVisible

public boolean isMarginsVisible()

Indicates if the margin delimiters are visible.

Returns:

true if the page margins are displayed.

setMarginsVisible

public void setMarginsVisible(boolean show)

Specifies whether the page margins should be visible.

Parameters:

show - true if the page margins should be displayed.

getPageColor

public Color getPageColor()

Returns the background color of a page.

setPageColor

public void setPageColor(Color c)

Changes the background color of a page.

setShadowColor

public void setShadowColor(Color color)

Specifies the color used to paint the shadow around a page.

Parameters:

color - The new shadow color.

getShadowColor

public Color getShadowColor()

Returns the color used to paint the shadow of the page.

Returns:

The shadow color.

addToolbarAction

public JButton addToolbarAction(Action action)

Adds a button in the toolbar.

Parameters:

action - The action of the button.

setCursor

public void setCursor(Cursor c)

Changes the cursor.

Overrides:

setCursor in class Component

Parameters:

c - The new cursor.