ilog.views.util.print

Class IlvDocumentSetupDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

ilog.views.util.print.IlvDocumentSetupDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

IlvChartDocumentSetupDialog, IlvGanttDocumentSetupDialog, IlvManagerDocumentSetupDialog

public class IlvDocumentSetupDialog
extends JDialog

A dialog box to setup the parameters of a IlvPrintableDocument. This dialog box allows to edit the page format, the header and the footer. This dialog box is composed of a JTabbedPane with two tabs: one to edit the page format and one to edit the header and footer. You may add a new tab by using the addTab(java.lang.String, java.awt.Component) method if you need to edit additional parameters for a specialized class of document.

Since:

JViews 5.5

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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 inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvDocumentSetupDialog(Dialog owner, IlvPrintingController controller, boolean printButton, boolean printPreviewButton) Creates a IlvDocumentSetupDialog
IlvDocumentSetupDialog(Frame owner, IlvPrintingController controller, boolean printButton, boolean printPreviewButton) Creates a IlvDocumentSetupDialog

Method Summary

Modifier and Type	Method and Description
protected void	addTab(String title, Component tab) Adds a new tab in the JTabbedPane of this dialog box.
protected boolean	checkDialog() This method is called to verify the content of the dialog box entry fields before validating the dialog.
IlvPrintableDocument	getDocument() Returns the document that is currently edited by this dialog box.
com.ibm.icu.util.ULocale	getULocale() Returns the locale that is used for formatting numbers and dates.
protected void	initComponents() This method is called from within the constructor to initialize the form.
protected void	setDocument(IlvPrintableDocument document) Changes the document edited by this dialog box.
void	setLookAndFeel(UIManager.LookAndFeelInfo laf) Changes the look and feel of the dialog.
protected void	setUpDocument() This function is called when the "OK" button is pressed.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDocumentSetupDialog

public IlvDocumentSetupDialog(Dialog owner,
                              IlvPrintingController controller,
                              boolean printButton,
                              boolean printPreviewButton)

Creates a IlvDocumentSetupDialog

Parameters:

owner - The owner of the dialog.

controller - The printing controller.

printButton - Indicates if a button must be added to print the content of the document.

printPreviewButton - Indicates if a button must be added to open the 'Print Preview' dialog.

IlvDocumentSetupDialog

public IlvDocumentSetupDialog(Frame owner,
                              IlvPrintingController controller,
                              boolean printButton,
                              boolean printPreviewButton)

Creates a IlvDocumentSetupDialog

Parameters:

owner - The owner of the dialog.

controller - The printing controller.

printButton - Indicates if a button must be added to print the content of the document.

printPreviewButton - Indicates if a button must be added to open the 'Print Preview' dialog.

Method Detail

getDocument

public IlvPrintableDocument getDocument()

Returns the document that is currently edited by this dialog box.

See Also:

setDocument(ilog.views.util.print.IlvPrintableDocument)

setDocument

protected void setDocument(IlvPrintableDocument document)

Changes the document edited by this dialog box. This method is called when the edited document changes. It propagates the settings from the document to this dialog.

See Also:

getDocument(), setUpDocument()

getULocale

public com.ibm.icu.util.ULocale getULocale()

Returns the locale that is used for formatting numbers and dates. This method can be overridden in subclasses.

Since:

JViews 8.8

initComponents

protected void initComponents()

This method is called from within the constructor to initialize the form. This method creates a JTabbedPane with two pages: one for editing the page format and another one for the header and footer. You may override this method to add a new page using the addTab(java.lang.String, java.awt.Component) method, in this case you have to call super.initComponents first.

addTab

protected void addTab(String title,
                      Component tab)

Adds a new tab in the JTabbedPane of this dialog box.

See Also:

initComponents()

setUpDocument

protected void setUpDocument()

This function is called when the "OK" button is pressed. It propagates the settings from this dialog to the document. If you have subclassed this class to edit properties specific to you document, you have to extend this method to set the new properties in the document.

See Also:

setDocument(IlvPrintableDocument)

checkDialog

protected boolean checkDialog()

This method is called to verify the content of the dialog box entry fields before validating the dialog. You may override this method to add your checking. This method must return false when an entry field is not valid. In this case a message dialog should be displayed to inform the user that the dialog will not be validated.

Returns:

true when the content of the dialog is OK.

setLookAndFeel

public void setLookAndFeel(UIManager.LookAndFeelInfo laf)

Changes the look and feel of the dialog.