Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.swt.widgets
Class Scrollable  view Scrollable download Scrollable.java

java.lang.Object
  extended byorg.eclipse.swt.widgets.Widget
      extended byorg.eclipse.swt.widgets.Control
          extended byorg.eclipse.swt.widgets.Scrollable
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable
Direct Known Subclasses:
Composite, List, Text

public abstract class Scrollable
extends Control

This class is the abstract superclass of all classes which represent controls that have standard scroll bars.

Styles:
H_SCROLL, V_SCROLL
Events:
(none)

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.


Field Summary
(package private)  ScrollBar horizontalBar
           
(package private)  long scrolledHandle
           
(package private)  ScrollBar verticalBar
           
 
Fields inherited from class org.eclipse.swt.widgets.Control
accessible, cursor, drawCount, enableWindow, fixedHandle, font, layoutData, menu, parent, redrawWindow, toolTipText
 
Fields inherited from class org.eclipse.swt.widgets.Widget
ACTIVATE, BUTTON_PRESS_EVENT, BUTTON_RELEASE_EVENT, CANVAS, CHANGED, CLICKED, COMMIT, CONFIGURE_EVENT, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_RANGE, DELETE_TEXT, DISABLED, display, DISPOSED, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPOSE_EVENT, FOCUS, FOCUS_IN_EVENT, FOCUS_OUT_EVENT, handle, HANDLE, HIDE, INSERT_TEXT, KEY_PRESS_EVENT, KEY_RELEASE_EVENT, KEYED_DATA, LEAVE_NOTIFY_EVENT, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MOTION_NOTIFY_EVENT, OBSCURED, POPUP_MENU, PREEDIT_CHANGED, REALIZE, ROW_ACTIVATED, SCROLL_CHILD, SELECT, SHOW, SHOW_HELP, SIZE_ALLOCATE, state, style, STYLE_SET, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TOGGLED, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, VISIBILITY_NOTIFY_EVENT, WINDOW_STATE_EVENT
 
Constructor Summary
(package private) Scrollable()
          Prevents uninitialized instances from being created outside the package.
  Scrollable(Composite parent, int style)
          Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
 
Method Summary
(package private)  long clientHandle()
           
 org.eclipse.swt.graphics.Rectangle computeTrim(int x, int y, int width, int height)
          Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.
(package private)  ScrollBar createScrollBar(int style)
           
(package private)  void createWidget(int index)
           
(package private)  void deregister()
           
 int getBorderWidth()
          Returns the receiver's border width.
 org.eclipse.swt.graphics.Rectangle getClientArea()
          Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").
 ScrollBar getHorizontalBar()
          Returns the receiver's horizontal scroll bar if it has one, and null if it does not.
 ScrollBar getVerticalBar()
          Returns the receiver's vertical scroll bar if it has one, and null if it does not.
(package private)  int hScrollBarWidth()
           
(package private)  void register()
           
(package private)  void releaseHandle()
           
(package private)  void releaseWidget()
           
(package private)  void resizeHandle(int width, int height)
           
(package private)  void setOrientation()
           
(package private)  long topHandle()
           
(package private)  int vScrollBarWidth()
           
 
Methods inherited from class org.eclipse.swt.widgets.Control
_getShell, addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeNativeSize, computeSize, computeSize, computeTabGroup, computeTabList, computeTabRoot, defaultFont, drawGripper, enableWidget, eventHandle, filterKey, findMenus, fixChildren, fixFocus, focusHandle, fontHandle, forceFocus, forceFocus, getAccessible, getBackground, getBackgroundColor, getBaseColor, getBgColor, getBounds, getEnabled, getFgColor, getFont, getFontDescription, getForeground, getForegroundColor, getIMCaretPos, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getShell, getSize, getTextColor, getToolTipText, getVisible, gtk_button_press_event, gtk_button_release_event, gtk_commit, gtk_enter_notify_event, gtk_event_after, gtk_expose_event, gtk_focus_in_event, gtk_focus_out_event, gtk_focus, gtk_key_press_event, gtk_key_release_event, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_realize, gtk_show_help, gtk_unrealize, gtk_visibility_notify_event, hasFocus, hookEvents, hoverProc, imHandle, internal_dispose_GC, internal_new_GC, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, paintWindow, redraw, redraw, redrawWidget, releaseChild, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendFocusEvent, sendHelpEvent, sendIMKeyEvent, sendKeyEvent, sendMouseEvent, setBackground, setBackgroundColor, setBackgroundColor, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setEnabled, setFocus, setFont, setFontDescription, setForeground, setForegroundColor, setInitialSize, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioSelection, setRedraw, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, setZOrder, setZOrder, showMenu, sort, toControl, toControl, toDisplay, toDisplay, translateMnemonic, translateMnemonic, translateTraversal, traversalCode, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkSubclass, checkWidget, createHandle, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getNameText, getStyle, gtk_activate, gtk_changed, gtk_clicked, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_event, gtk_hide, gtk_insert_text, gtk_map_event, gtk_row_activated, gtk_scroll_child, gtk_select, gtk_show, gtk_size_allocate, gtk_style_set, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_timer, gtk_toggled, gtk_unmap_event, gtk_value_changed, gtk_window_state_event, hooks, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, shellMapProc, textCellDataProc, timerProc, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

scrolledHandle

long scrolledHandle

horizontalBar

ScrollBar horizontalBar

verticalBar

ScrollBar verticalBar
Constructor Detail

Scrollable

Scrollable()
Prevents uninitialized instances from being created outside the package.


Scrollable

public Scrollable(Composite parent,
                  int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Method Detail

clientHandle

long clientHandle()

computeTrim

public org.eclipse.swt.graphics.Rectangle computeTrim(int x,
                                                      int y,
                                                      int width,
                                                      int height)
Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.

In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).


createScrollBar

ScrollBar createScrollBar(int style)

createWidget

void createWidget(int index)
Overrides:
createWidget in class Control

deregister

void deregister()
Overrides:
deregister in class Control

getBorderWidth

public int getBorderWidth()
Description copied from class: Control
Returns the receiver's border width.

Overrides:
getBorderWidth in class Control

getClientArea

public org.eclipse.swt.graphics.Rectangle getClientArea()
Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").


getHorizontalBar

public ScrollBar getHorizontalBar()
Returns the receiver's horizontal scroll bar if it has one, and null if it does not.


getVerticalBar

public ScrollBar getVerticalBar()
Returns the receiver's vertical scroll bar if it has one, and null if it does not.


hScrollBarWidth

int hScrollBarWidth()

setOrientation

void setOrientation()
Overrides:
setOrientation in class Widget

register

void register()
Overrides:
register in class Control

releaseHandle

void releaseHandle()
Overrides:
releaseHandle in class Control

releaseWidget

void releaseWidget()
Overrides:
releaseWidget in class Control

resizeHandle

void resizeHandle(int width,
                  int height)
Overrides:
resizeHandle in class Control

topHandle

long topHandle()
Overrides:
topHandle in class Control

vScrollBarWidth

int vScrollBarWidth()