TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.ui.dialogs.internal
Class ZoomEditorDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.tptp.platform.report.ui.dialogs.internal.JScribDialog
              extended by org.eclipse.tptp.platform.report.ui.dialogs.internal.ZoomEditorDialog
All Implemented Interfaces:
org.eclipse.jface.window.IShellProvider

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class ZoomEditorDialog
extends JScribDialog

This class provides a dialog to configure a zoom factor. It provides some predefined zoom factor and a custom zoom factor selector. The zoom factor and its impact on the forn is shown in a preview area. This class provides a signal named zoomChanged. This signal is emitted every time when the zoom factor changed in the dialog editor.

See Also:
JScribDialog

Nested Class Summary
 class ZoomEditorDialog.ZoomFactorWidget
          Deprecated.  
 class ZoomEditorDialog.ZoomPreviewWidget
          Deprecated.  
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
org.eclipse.jface.window.Window.IExceptionHandler
 
Field Summary
 Signal ratioEnabled
          Deprecated. Signal : ratioEnabled(Boolean f)
Emit when the maintain aspect ratio checkbox changed in the zoom editor dialog
 Signal zoomChanged
          Deprecated. Signal : zoomChanged(Float f)
Emit when the zoom factor changed in the zoom editor dialog
 
Fields inherited from class org.eclipse.tptp.platform.report.ui.dialogs.internal.JScribDialog
applied, canceled, JSCRIB_APPLY_BUTTON, JSCRIB_CANCEL_BUTTON, JSCRIB_HELP_BUTTON, JSCRIB_OK_BUTTON
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
 
Fields inherited from class org.eclipse.jface.window.Window
CANCEL, OK
 
Constructor Summary
ZoomEditorDialog(org.eclipse.swt.widgets.Shell parent)
          Deprecated. Create a zoom editor
 
Method Summary
protected  org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
          Deprecated.  
 float getMaxZoomFactor()
          Deprecated. Returns the maximum of the zoom factor that the dialog can edit
 float getMinZoomFactor()
          Deprecated. Returns the minimum of the zoom factor that the dialog can edit
 float getZoomFactor()
          Deprecated. Returns the zoom factor configurated in the editor
 boolean isFontPreviewEnabled()
          Deprecated. Returns the value of the font size and zoomFactor synchronisation property.
 boolean isMaintainRatio()
          Deprecated.  
 void setData(int _contentsW, int _contentsH, int _viewW, int _viewH, float _zoomFactor)
          Deprecated. Sets the data for the zoom dialog.
 void setFontPreviewEnabled(boolean fontZoom)
          Deprecated. Synchronize or not the font size with the zoom factor.
 void setMaintainRatio(boolean maintainRatio)
          Deprecated.  
 void setMaxZoomFactor(float maxZoomFactor)
          Deprecated. Sets the maximum of the zoom factor that the dialog can edit
 void setMinZoomFactor(float minZoomfactor)
          Deprecated. Sets the minimum of the zoom factor that the dialog can edit
 void setPreviewFont(java.lang.String fontName, int size)
          Deprecated. Sets the font used to show the preview text with zoom factor applied on the font.
 void setPreviewText(java.lang.String sampleText)
          Deprecated. Sets the text show in the preview area.
 
Methods inherited from class org.eclipse.tptp.platform.report.ui.dialogs.internal.JScribDialog
applyPressed, buttonPressed, cancelPressed, createButtonsForButtonBar, helpPressed, okPressed
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, configureShell, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

zoomChanged

public Signal zoomChanged
Deprecated. 
Signal : zoomChanged(Float f)
Emit when the zoom factor changed in the zoom editor dialog


ratioEnabled

public Signal ratioEnabled
Deprecated. 
Signal : ratioEnabled(Boolean f)
Emit when the maintain aspect ratio checkbox changed in the zoom editor dialog

Constructor Detail

ZoomEditorDialog

public ZoomEditorDialog(org.eclipse.swt.widgets.Shell parent)
Deprecated. 
Create a zoom editor

Method Detail

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
Deprecated. 
Overrides:
createDialogArea in class org.eclipse.jface.dialogs.Dialog
See Also:
Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)

getZoomFactor

public float getZoomFactor()
Deprecated. 
Returns the zoom factor configurated in the editor


isFontPreviewEnabled

public boolean isFontPreviewEnabled()
Deprecated. 
Returns the value of the font size and zoomFactor synchronisation property.


setFontPreviewEnabled

public void setFontPreviewEnabled(boolean fontZoom)
Deprecated. 
Synchronize or not the font size with the zoom factor. By default this property is enabled in the ZoomEditorDialog class


setData

public void setData(int _contentsW,
                    int _contentsH,
                    int _viewW,
                    int _viewH,
                    float _zoomFactor)
Deprecated. 
Sets the data for the zoom dialog. This dialog needs the size of the contents and the size of the view to compute the zoom factor for the option Page Width and Ensure visible

Parameters:
_contentsW - is the width in pixel of the contents (document)
_contentsH - is the height in pixel of the contents.
_viewW - is the width in pixel of the view.
_viewH - is the height in pixel of the view.
_zoomFactor - is the current zoomFactor of the view.

setPreviewText

public void setPreviewText(java.lang.String sampleText)
Deprecated. 
Sets the text show in the preview area.


setPreviewFont

public void setPreviewFont(java.lang.String fontName,
                           int size)
Deprecated. 
Sets the font used to show the preview text with zoom factor applied on the font.

Parameters:
font - name is the string name of the font (ex: "Times New Roman").
size - is the original size of the font in pixel.

getMaxZoomFactor

public float getMaxZoomFactor()
Deprecated. 
Returns the maximum of the zoom factor that the dialog can edit

Returns:
Returns the maxZoomFactor.

setMaxZoomFactor

public void setMaxZoomFactor(float maxZoomFactor)
Deprecated. 
Sets the maximum of the zoom factor that the dialog can edit

Parameters:
maxZoomFactor - The maxZoomFactor to set.

getMinZoomFactor

public float getMinZoomFactor()
Deprecated. 
Returns the minimum of the zoom factor that the dialog can edit

Returns:
Returns the minZoomfactor.

setMinZoomFactor

public void setMinZoomFactor(float minZoomfactor)
Deprecated. 
Sets the minimum of the zoom factor that the dialog can edit

Parameters:
minZoomfactor - The minZoomfactor to set.

isMaintainRatio

public boolean isMaintainRatio()
Deprecated. 
Returns:
Returns the maintainRatio.

setMaintainRatio

public void setMaintainRatio(boolean maintainRatio)
Deprecated. 
Parameters:
maintainRatio - The maintainRatio to set.

TPTP 4.6.0 Platform Project
Internal API Specification