TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.ui.swt.widgets.internal
Class NoOverviewScrollView

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by org.eclipse.swt.widgets.Canvas
                      extended by org.eclipse.tptp.platform.report.ui.swt.widgets.internal.NoOverviewScrollView
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable

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 NoOverviewScrollView
extends org.eclipse.swt.widgets.Canvas

ScrollView widget provides a scrolling area with on-demand scroll bars


Field Summary
static int ALWAYS_OFF
          Deprecated.  
static int ALWAYS_ON
          Deprecated.  
static int AUTO
          Deprecated. Value for scroll bar mode, default is AUTO
 
Fields inherited from class org.eclipse.swt.widgets.Composite
embeddedHandle
 
Fields inherited from class org.eclipse.swt.widgets.Widget
handle
 
Constructor Summary
NoOverviewScrollView(org.eclipse.swt.widgets.Composite c, int style)
          Deprecated. Create a ScrollView, child of composite c.
 
Method Summary
protected  void contentsMouseDoubleClickEvent(org.eclipse.swt.events.MouseEvent e)
          Deprecated. Called when user double on contents area.
protected  void contentsMouseDownEvent(org.eclipse.swt.events.MouseEvent e)
          Deprecated. Called when mouse is on contents area and button is pressed.
protected  void contentsMouseMoveEvent(org.eclipse.swt.events.MouseEvent _event)
          Deprecated. Called when mouse is on contents area and mode.
protected  void contentsMouseUpEvent(org.eclipse.swt.events.MouseEvent _event)
          Deprecated. Called when mouse is on contents area and button is released
 org.eclipse.swt.graphics.Point contentsToView(int _x, int _y)
          Deprecated. Transform (x,y) point from contents coordinates, to widget coordinates.
 int contentsToViewX(int _x)
          Deprecated. Transform X axis coordinates from contents to widgets.
 int contentsToViewY(int _y)
          Deprecated. Transform Y axis coordinates from contents to widgets.
 void dispose()
          Deprecated.  
protected  void drawContents(org.eclipse.swt.graphics.GC gc, int clipx, int clipy, int clipw, int cliph)
          Deprecated. Responsible to draw contents area.
 void ensureVisible(int _px, int _py)
          Deprecated. Scroll to ensure point(in contents coordinates) is visible.
 void ensureVisible(int _x, int _y, int _w, int _h, int _align)
          Deprecated. Make rectangle (_x,_y,_w,_h, in contents coordinates) visible.
 int getContentsHeight()
          Deprecated. Access method for the contentsHeight property.
 int getContentsWidth()
          Deprecated. Access method for the contentsWidth property.
 int getContentsX()
          Deprecated. Access method for the contentsX property.
 int getContentsY()
          Deprecated. Access method for the contentsY property.
 boolean getDragAutoScroll()
          Deprecated. Determines if the dragAutoScroll property is true.
 int getDragAutoScrollPeriod()
          Deprecated. Return auto scroll period.
 int getHScrollBarIncrement()
          Deprecated. Return horizontal scroll bar increment, default:1
 int getHScrollBarMode()
          Deprecated. Access method for the hScrollBarMode property.
 int getVisibleHeight()
          Deprecated.  
 org.eclipse.swt.graphics.Rectangle getVisiblePart(int _x, int _y, int _w, int _h)
          Deprecated.  
 org.eclipse.swt.graphics.Rectangle getVisiblePart(org.eclipse.swt.graphics.Rectangle _r)
          Deprecated.  
 int getVisibleWidth()
          Deprecated.  
 int getVScrollBarIncrement()
          Deprecated. Return vertical scroll bar increment, default:1
 int getVScrollBarMode()
          Deprecated. Access method for the vScrollBarMode property.
 boolean isVisible(int _px, int _py)
          Deprecated.  
 boolean isVisible(int _x, int _y, int _w, int _h)
          Deprecated.  
protected  void keyPressedEvent(org.eclipse.swt.events.KeyEvent _e)
          Deprecated.  
protected  void keyReleasedEvent(org.eclipse.swt.events.KeyEvent _e)
          Deprecated.  
static void main(java.lang.String[] argv)
          Deprecated.  
 void replaceControlListener(org.eclipse.swt.events.ControlListener nlistener)
          Deprecated. Remove the local Listener and add the new listener.
 void replaceKeyListener(org.eclipse.swt.events.KeyListener nlistener)
          Deprecated. Remove the local Listener and add the new listener.
 void replaceMouseListener(org.eclipse.swt.events.MouseListener nlistener)
          Deprecated. Remove the local Listener and add the new listener.
 void replaceMouseMoveListener(org.eclipse.swt.events.MouseMoveListener nlistener)
          Deprecated. Remove the local Listener and add the new listener.
 void replacePaintListener(org.eclipse.swt.events.PaintListener nlistener)
          Deprecated. Remove the local Listener and add the new listener.
 void resizeContents(int _w, int _h)
          Deprecated. Change the size of the contents area.
 void scrollBy(int _dx, int _dy)
          Deprecated.  
 void setContentsPos(int _x, int _y)
          Deprecated. Change top left position of visible area.
 void setDragAutoScroll(boolean aDragAutoScroll)
          Deprecated. Sets the value of the dragAutoScroll property.
 void setDragAutoScrollPeriod(int _period)
          Deprecated. Change delay (in millisec) used for auto scroll feature.
 void setHScrollBarIncrement(int _inc)
          Deprecated. Change horizontal scroll bar increment, minimum:1.
 void setHScrollBarMode(int aHScrollBarMode)
          Deprecated. Sets the value of the hScrollBarMode property.
 void setVScrollBarIncrement(int _inc)
          Deprecated. Change vertical scroll bar increment, minimum:1.
 void setVScrollBarMode(int aVScrollBarMode)
          Deprecated. Sets the value of the vScrollBarMode property.
 void updateScrollBars()
          Deprecated. Setup scroll bar using contents, visible and scroll bar mode properties.
protected  void viewResizeEvent(org.eclipse.swt.events.ControlEvent _event)
          Deprecated. Called when ScrollView is resized.
 org.eclipse.swt.graphics.Point viewToContents(int _x, int _y)
          Deprecated. Transform (x,y) point in widget coordinates to contents coordinates.
 int viewToContentsX(int _x)
          Deprecated.  
 int viewToContentsY(int _y)
          Deprecated.  
 
Methods inherited from class org.eclipse.swt.widgets.Canvas
drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AUTO

public static final int AUTO
Deprecated. 
Value for scroll bar mode, default is AUTO

See Also:
Constant Field Values

ALWAYS_OFF

public static final int ALWAYS_OFF
Deprecated. 
See Also:
Constant Field Values

ALWAYS_ON

public static final int ALWAYS_ON
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

NoOverviewScrollView

public NoOverviewScrollView(org.eclipse.swt.widgets.Composite c,
                            int style)
Deprecated. 
Create a ScrollView, child of composite c. Both scroll bar have the mode AUTO. Auto scroll feature is enabled using a delay of 250ms.

Parameters:
c -
style - SWT style bits @see SWT
Method Detail

dispose

public void dispose()
Deprecated. 
Overrides:
dispose in class org.eclipse.swt.widgets.Widget

replaceControlListener

public void replaceControlListener(org.eclipse.swt.events.ControlListener nlistener)
Deprecated. 
Remove the local Listener and add the new listener.

Parameters:
nlistener - the new listener

replaceKeyListener

public void replaceKeyListener(org.eclipse.swt.events.KeyListener nlistener)
Deprecated. 
Remove the local Listener and add the new listener.

Parameters:
nlistener - the new listener

replaceMouseListener

public void replaceMouseListener(org.eclipse.swt.events.MouseListener nlistener)
Deprecated. 
Remove the local Listener and add the new listener.

Parameters:
nlistener - the new listener

replaceMouseMoveListener

public void replaceMouseMoveListener(org.eclipse.swt.events.MouseMoveListener nlistener)
Deprecated. 
Remove the local Listener and add the new listener.

Parameters:
nlistener - the new listener

replacePaintListener

public void replacePaintListener(org.eclipse.swt.events.PaintListener nlistener)
Deprecated. 
Remove the local Listener and add the new listener.

Parameters:
nlistener - the new listener

getContentsHeight

public int getContentsHeight()
Deprecated. 
Access method for the contentsHeight property.

Returns:
the current value of the contentsHeight property

getContentsWidth

public int getContentsWidth()
Deprecated. 
Access method for the contentsWidth property.

Returns:
the current value of the contentsWidth property

getContentsX

public int getContentsX()
Deprecated. 
Access method for the contentsX property.

Returns:
the current value of the contentsX property

getContentsY

public int getContentsY()
Deprecated. 
Access method for the contentsY property.

Returns:
the current value of the contentsY property

getDragAutoScroll

public boolean getDragAutoScroll()
Deprecated. 
Determines if the dragAutoScroll property is true.

Returns:
true if the dragAutoScroll property is true

setDragAutoScroll

public void setDragAutoScroll(boolean aDragAutoScroll)
Deprecated. 
Sets the value of the dragAutoScroll property.

Parameters:
aDragAutoScroll - the new value of the dragAutoScroll property

setDragAutoScrollPeriod

public void setDragAutoScrollPeriod(int _period)
Deprecated. 
Change delay (in millisec) used for auto scroll feature.

Parameters:
_period - new period between to auto scroll

getDragAutoScrollPeriod

public int getDragAutoScrollPeriod()
Deprecated. 
Return auto scroll period.


getHScrollBarMode

public int getHScrollBarMode()
Deprecated. 
Access method for the hScrollBarMode property.

Returns:
the current value of the hScrollBarMode property

setHScrollBarMode

public void setHScrollBarMode(int aHScrollBarMode)
Deprecated. 
Sets the value of the hScrollBarMode property.

Parameters:
aHScrollBarMode - the new value of the hScrollBarMode property

getVScrollBarMode

public int getVScrollBarMode()
Deprecated. 
Access method for the vScrollBarMode property.

Returns:
the current value of the vScrollBarMode property

setVScrollBarMode

public void setVScrollBarMode(int aVScrollBarMode)
Deprecated. 
Sets the value of the vScrollBarMode property.

Parameters:
aVScrollBarMode - the new value of the vScrollBarMode property

getHScrollBarIncrement

public int getHScrollBarIncrement()
Deprecated. 
Return horizontal scroll bar increment, default:1


getVScrollBarIncrement

public int getVScrollBarIncrement()
Deprecated. 
Return vertical scroll bar increment, default:1


setHScrollBarIncrement

public void setHScrollBarIncrement(int _inc)
Deprecated. 
Change horizontal scroll bar increment, minimum:1. Page increment is always set to visible width.


setVScrollBarIncrement

public void setVScrollBarIncrement(int _inc)
Deprecated. 
Change vertical scroll bar increment, minimum:1. Page increment is always set to visible height.


contentsMouseDoubleClickEvent

protected void contentsMouseDoubleClickEvent(org.eclipse.swt.events.MouseEvent e)
Deprecated. 
Called when user double on contents area.

Parameters:
e -

contentsMouseDownEvent

protected void contentsMouseDownEvent(org.eclipse.swt.events.MouseEvent e)
Deprecated. 
Called when mouse is on contents area and button is pressed.

Parameters:
e -

contentsMouseMoveEvent

protected void contentsMouseMoveEvent(org.eclipse.swt.events.MouseEvent _event)
Deprecated. 
Called when mouse is on contents area and mode.

Parameters:
_event -

contentsMouseUpEvent

protected void contentsMouseUpEvent(org.eclipse.swt.events.MouseEvent _event)
Deprecated. 
Called when mouse is on contents area and button is released

Parameters:
_event -

drawContents

protected void drawContents(org.eclipse.swt.graphics.GC gc,
                            int clipx,
                            int clipy,
                            int clipw,
                            int cliph)
Deprecated. 
Responsible to draw contents area. At least rectangle clipX must be redrawn. This rectangle is given in contents coordinates. By default, no paint is produced.

Parameters:
gc -
clipx -
clipy -
clipw -
cliph -

resizeContents

public void resizeContents(int _w,
                           int _h)
Deprecated. 
Change the size of the contents area.

Parameters:
w - new width of the area.
h - new height of the area.

scrollBy

public void scrollBy(int _dx,
                     int _dy)
Deprecated. 
Parameters:
_dx -
_dy -

ensureVisible

public void ensureVisible(int _px,
                          int _py)
Deprecated. 
Scroll to ensure point(in contents coordinates) is visible.


ensureVisible

public void ensureVisible(int _x,
                          int _y,
                          int _w,
                          int _h,
                          int _align)
Deprecated. 
Make rectangle (_x,_y,_w,_h, in contents coordinates) visible. if rectangle cannot be completly visible, use _align flags.

Parameters:
_x - x contents coordinates of rectangle.
_y - y contents coordinates of rectangle.
_w - width of rectangle.
_h - height of rectangle.
_align - bit or'ed SWT flag like SWT.LEFT,RIGHT,CENTER,TOP,BOTTOM,VERTICAL used only for bigger rectangle than visible area. By default CENTER/VERTICAL

isVisible

public boolean isVisible(int _px,
                         int _py)
Deprecated. 
Returns:
true if point is visible (expressed in contents coordinates)

isVisible

public boolean isVisible(int _x,
                         int _y,
                         int _w,
                         int _h)
Deprecated. 
Returns:
true if rectangle if partially visible.

getVisiblePart

public org.eclipse.swt.graphics.Rectangle getVisiblePart(int _x,
                                                         int _y,
                                                         int _w,
                                                         int _h)
Deprecated. 
Returns:
visible part of rectangle, or null if rectangle is not visible. rectangle is expressed in contents coordinates.

getVisiblePart

public final org.eclipse.swt.graphics.Rectangle getVisiblePart(org.eclipse.swt.graphics.Rectangle _r)
Deprecated. 
See Also:
getVisiblePart

setContentsPos

public void setContentsPos(int _x,
                           int _y)
Deprecated. 
Change top left position of visible area. Check if the given point is inside contents area.

Parameters:
_x -
_y -

updateScrollBars

public void updateScrollBars()
Deprecated. 
Setup scroll bar using contents, visible and scroll bar mode properties.


viewToContents

public final org.eclipse.swt.graphics.Point viewToContents(int _x,
                                                           int _y)
Deprecated. 
Transform (x,y) point in widget coordinates to contents coordinates.

Parameters:
x -
y -
Returns:
org.eclipse.swt.graphics.Point

viewToContentsX

public int viewToContentsX(int _x)
Deprecated. 

viewToContentsY

public int viewToContentsY(int _y)
Deprecated. 

contentsToView

public final org.eclipse.swt.graphics.Point contentsToView(int _x,
                                                           int _y)
Deprecated. 
Transform (x,y) point from contents coordinates, to widget coordinates.

Parameters:
x -
y -
Returns:
org.eclipse.swt.graphics.Point
See Also:
contentsToViewX, contentsToViewY

contentsToViewX

public int contentsToViewX(int _x)
Deprecated. 
Transform X axis coordinates from contents to widgets.

Parameters:
_x - contents coordinate to transform
Returns:
coordinate in widget area

contentsToViewY

public int contentsToViewY(int _y)
Deprecated. 
Transform Y axis coordinates from contents to widgets.

Parameters:
_y - contents coordinate to transform
Returns:
coordinate in widget area

getVisibleHeight

public int getVisibleHeight()
Deprecated. 
Returns:
int

getVisibleWidth

public int getVisibleWidth()
Deprecated. 
Returns:
int

keyPressedEvent

protected void keyPressedEvent(org.eclipse.swt.events.KeyEvent _e)
Deprecated. 

keyReleasedEvent

protected void keyReleasedEvent(org.eclipse.swt.events.KeyEvent _e)
Deprecated. 

viewResizeEvent

protected void viewResizeEvent(org.eclipse.swt.events.ControlEvent _event)
Deprecated. 
Called when ScrollView is resized.

Parameters:
_event -

main

public static void main(java.lang.String[] argv)
Deprecated. 

TPTP 4.5.0 Platform Project
Internal API Specification