Class Sash

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Sash

All Implemented Interfaces:

Drawable

public class Sash
extends Control

Instances of the receiver represent a selectable user interface object that allows the user to drag a rubber banded outline of the sash within the parent control.

Styles:

HORIZONTAL, VERTICAL, SMOOTH

Events:

Selection

Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

• Sash snippets
• SWT Example: ControlExample
• Sample code and further information

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_CROSS_AXIS_SIZE
(package private) long	defaultCursor
(package private) boolean	dragging
private static final int	INCREMENT
(package private) int	lastX
(package private) int	lastY
private static final int	PAGE_INCREMENT
(package private) int	startX
(package private) int	startY

Fields inherited from class Control

accessible, autoScale, backgroundAlpha, backgroundImage, cachedNoBackground, checkScaleFactor, cssBackground, cssForeground, cursor, DISABLE_EMOJI, dragDetectionQueue, dragGesture, drawCount, drawRegion, enableWindow, eventRegion, firstFixedHandle, fixedHandle, font, gestureBegin, gestureEnd, gestureRotation, gestureSwipe, gestureZoom, keyController, labelRelation, lastInput, layoutData, menu, mouseDown, panGesture, parent, provider, redrawWindow, region, regionHandle, rotateGesture, toolTipText, zoomGesture

Fields inherited from class Widget

ACTIVATE, ACTIVATE_INVERSE, AUTO_TEXT_DIRECTION, BACKGROUND, BACKSPACE, BACKSPACE_INVERSE, BUTTON_PRESS_EVENT, BUTTON_PRESS_EVENT_INVERSE, BUTTON_RELEASE_EVENT, BUTTON_RELEASE_EVENT_INVERSE, CANVAS, CHANGE_VALUE, CHANGED, CHECK_SUBWINDOW, CLICKED, CLOSE_REQUEST, COMMIT, COMPUTE_SIZE, CONFIGURE_EVENT, COPY_CLIPBOARD, COPY_CLIPBOARD_INVERSE, CREATE_MENU_PROXY, CUT_CLIPBOARD, CUT_CLIPBOARD_INVERSE, data, DAY_SELECTED, DAY_SELECTED_DOUBLE_CLICK, DECELERATE, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_FROM_CURSOR, DELETE_FROM_CURSOR_INVERSE, DELETE_RANGE, DELETE_TEXT, DIRECTION_CHANGED, DISABLED, display, DISPOSE_SENT, DISPOSED, DPI_CHANGED, DRAG_DETECT, DRAW, ENTER, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPAND_COLLAPSE_CURSOR_ROW, EXPOSE_EVENT, EXPOSE_EVENT_INVERSE, FOCUS, FOCUS_IN, FOCUS_IN_EVENT, FOCUS_OUT, FOCUS_OUT_EVENT, FONT, FOREGROUND, FOREIGN_HANDLE, gdkSeatGrabPrepareFunc, GESTURE_PRESSED, GESTURE_RELEASED, GRAB_FOCUS, handle, HANDLE, HAS_AUTO_DIRECTION, HIDDEN, HIDE, ICON_RELEASE, IM_UPDATE, INPUT, INSERT_TEXT, IS_ACTIVE, KEY_CHECK_SUBWINDOW, KEY_GTK_CSS, KEY_PRESS_EVENT, KEY_PRESSED, KEY_RELEASE_EVENT, KEY_RELEASED, KEYED_DATA, LAST_SIGNAL, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, LEAVE, LEAVE_NOTIFY_EVENT, MAP, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MONTH_CHANGED, MOTION, MOTION_INVERSE, MOTION_NOTIFY_EVENT, MOTION_NOTIFY_EVENT_INVERSE, MOVE_CURSOR, MOVE_CURSOR_INVERSE, MOVE_FOCUS, MOVED, NOTIFY_DEFAULT_HEIGHT, NOTIFY_DEFAULT_WIDTH, NOTIFY_MAXIMIZED, NOTIFY_STATE, OBSCURED, OUTPUT, PARENT_BACKGROUND, PASTE_CLIPBOARD, PASTE_CLIPBOARD_INVERSE, POPPED_UP, POPULATE_POPUP, POPUP_MENU, PREEDIT_CHANGED, REALIZE, RELEASED, RESIZED, ROW_ACTIVATED, ROW_DELETED, ROW_HAS_CHILD_TOGGLED, ROW_INSERTED, SCROLL, SCROLL_BEGIN, SCROLL_CHILD, SCROLL_END, SCROLL_EVENT, SELECT, SELECTION_DONE, SHOW, SHOW_HELP, SIZE_ALLOCATE, SIZE_ALLOCATE_GTK4, SKIN_NEEDED, START_INTERACTIVE_SEARCH, state, STATUS_ICON_POPUP_MENU, style, STYLE_UPDATED, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TEXT_BUFFER_INSERT_TEXT, THEME_BACKGROUND, TOGGLED, UNMAP, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, WINDOW_STATE_EVENT, ZERO_HEIGHT, ZERO_WIDTH

Constructor Summary

Constructors

Constructor	Description
Sash(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

Modifier and Type	Method	Description
void	addSelectionListener(SelectionListener listener)	Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.
(package private) static int	checkStyle(int style)
(package private) Point	computeSizeInPixels(int wHint, int hHint, boolean changed)
(package private) void	createHandle(int index)
(package private) long	gtk_button_press_event(long widget, long event)
(package private) long	gtk_button_release_event(long widget, long event)
(package private) long	gtk_draw(long widget, long cairo)
(package private) long	gtk_focus_in_event(long widget, long event)
(package private) int	gtk_gesture_press_event(long gesture, int n_press, double x, double y, long event)	Handling multi-press event on GTK4
(package private) int	gtk_gesture_release_event(long gesture, int n_press, double x, double y, long event)
(package private) long	gtk_motion_notify_event(long widget, long eventPtr)
(package private) long	gtk_realize(long widget)
(package private) long	gtk3_key_press_event(long widget, long eventPtr)
(package private) boolean	gtk4_key_press_event(long controller, int keyval, int keycode, int state, long event)
(package private) void	gtk4_motion_event(long controller, double x, double y, long event)
(package private) void	hookEvents()
(package private) void	releaseWidget()
void	removeSelectionListener(SelectionListener listener)	Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
(package private) void	setCursor(long cursor)
(package private) int	traversalCode(int key, long event)

Methods inherited from class Control

_getAccessible, _getShell, addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addRelation, addTouchListener, addTraverseListener, adjustChildClipping, cairoClipRegion, cairoCopyRegion, cairoDisposeRegion, checkBackground, checkBorder, checkBuffered, checkMirrored, checkSubwindow, cleanupEnableWindow, computeNativeSize, computeSize, computeSize, computeSizeInPixels, computeTabGroup, computeTabList, computeTabRoot, containedInRegion, createWidget, defaultBackground, defaultFont, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, dragDetect, drawBackground, drawGripper, drawWidget, enableWidget, enterExitHandle, eventHandle, eventSurface, eventWindow, filterKey, findBackgroundControl, findMenus, fixChildren, fixFocus, fixGdkEventTypeValues, fixModal, fixParentGdkResource, fixStyle, fixStyle, flushQueueOnDnd, focusHandle, fontHandle, forceFocus, forceFocus, forceResize, gestureBeginProc, gestureEndProc, gestureHandle, getAccessible, getBackground, getBackgroundGdkRGBA, getBackgroundImage, getBaseGdkRGBA, getBgGdkRGBA, getBorderWidth, getBorderWidthInPixels, getBounds, getBoundsInPixels, getClientWidth, getContextBackgroundGdkRGBA, getContextColorGdkRGBA, getControl, getControlOrigin, getCursor, getDragDetect, getEnabled, getFont, getFontDescription, getForeground, getForegroundGdkRGBA, getIMCaretPos, getLayoutData, getLocation, getLocationInPixels, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getSizeInPixels, getSurfaceOrigin, getTextDirection, getThickness, getToolTipText, getTouchEnabled, getVisible, getWindowOrigin, gtk_button_press_event, gtk_commit, gtk_css_provider_load_from_css, gtk_enter_notify_event, gtk_focus, gtk_focus_out_event, gtk_label_set_align, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_preedit_changed, gtk_scroll_event, gtk_style_context_get_border, gtk_style_context_get_padding, gtk_style_updated, gtk_unrealize, gtk_widget_reparent, gtk_widget_set_align, gtk3_event_after, gtk3_key_release_event, gtk3_popup_menu, gtk3_show_help, gtk4_draw, gtk4_enter_event, gtk4_focus_enter_event, gtk4_focus_leave_event, gtk4_focus_window_event, gtk4_key_release_event, gtk4_leave_event, gtk4_scroll_event, hasFocus, hooksPaint, hoverProc, imHandle, internal_dispose_GC, internal_new_GC, isActive, isAutoScalable, isDescribedByLabel, isEnabled, isFocusAncestor, isFocusControl, isFocusHandle, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, magnifyProc, markLayout, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, moveChildren, moveHandle, mustBeVisibleOnInitBounds, pack, pack, paintHandle, paintSurface, paintWindow, print, printWidget, printWindow, redraw, redraw, redraw, redrawChildren, redrawWidget, register, release, releaseHandle, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeRelation, removeTouchListener, removeTraverseListener, requestLayout, resizeCalculationsGTK3, resizeHandle, restackWindow, rotateProc, sendDragEvent, sendFocusEvent, sendGestureEvent, sendGestureEvent, sendGestureEvent, sendHelpEvent, sendLeaveNotify, sendMouseEvent, sendMouseEvent, setBackground, setBackground, setBackgroundGdkRGBA, setBackgroundGdkRGBA, setBackgroundGdkRGBA, setBackgroundImage, setBackgroundSurface, setBounds, setBounds, setBounds, setBoundsInPixels, setBoundsInPixels, setCapture, setCursor, setDragDetect, setEnabled, setFocus, setFont, setFontDescription, setForeground, setForegroundGdkRGBA, setForegroundGdkRGBA, setInitialBounds, setLayoutData, setLocation, setLocation, setLocationInPixels, setLocationInPixels, setMenu, setOrientation, setOrientation, setParent, setParentBackground, setParentGdkResource, setRadioSelection, setRedraw, setRegion, setRelations, setSize, setSize, setSizeInPixels, setSizeInPixels, setTabItemFocus, setTextDirection, setToolTipText, setToolTipText, setTouchEnabled, setVisible, setWidgetBackground, setZOrder, setZOrder, showMenu, showMenu, showWidget, sort, swipeProc, toControl, toControl, toDisplay, toDisplay, toDisplayInPixels, topHandle, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update, updateBackgroundMode, updateLayout, wantDragDropDetection, windowProc

Methods inherited from class Widget

_addListener, addDisposeListener, addListener, addTypedListener, cellDataProc, checkBits, checkOpen, checkOrientation, checkParent, checkSubclass, checkWidget, convertPangoFontDescriptionToCss, cssHandle, dispose, dpiChanged, enterMotionProc, error, filterProc, filters, fixMnemonic, fixMnemonic, fixMnemonic, focusProc, fontHeight, gdk_event_free, gdk_event_get_state, gdk_event_get_surface_or_window, gdk_pointer_grab, gdk_pointer_ungrab, gdk_surface_get_size, gdk_window_get_size, GdkSeatGrabPrepareFunc, gesturePressReleaseProc, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, getTypedListeners, gtk_activate, gtk_adjustment_get, gtk_box_new, gtk_box_pack_end, gtk_box_set_child_packing, gtk_cell_renderer_get_preferred_size, gtk_change_value, gtk_changed, gtk_clicked, gtk_close_request, gtk_configure_event, gtk_container_get_border_width_or_margin, gtk_container_set_border_width, gtk_create_menu_proxy, gtk_day_selected, gtk_day_selected_double_click, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_expand_collapse_cursor_row, gtk_grab_focus, gtk_hide, gtk_icon_release, gtk_input, gtk_insert_text, gtk_map, gtk_map_event, gtk_menu_popped_up, gtk_month_changed, gtk_move_focus, gtk_output, gtk_populate_popup, gtk_row_activated, gtk_row_has_child_toggled, gtk_scroll_child, gtk_select, gtk_selection_done, gtk_show, gtk_size_allocate, gtk_start_interactive_search, gtk_status_icon_popup_menu, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_text_buffer_insert_text, gtk_timer, gtk_toggled, gtk_tree_view_column_cell_get_position, gtk_unmap, gtk_unmap_event, gtk_value_changed, gtk_widget_get_preferred_size, gtk_widget_get_surface, gtk_widget_get_window, gtk_widget_hide, gtk_widget_show, gtk_widget_size_allocate, gtk_window_state_event, hooks, isAutoDirection, isDisposed, isListening, isValidSubclass, isValidThread, keyPressReleaseProc, leaveProc, mnemonicHit, mnemonicMatch, notifyCreationTracker, notifyDisposalTracker, notifyListeners, notifyProc, notifyState, postEvent, postEvent, releaseChildren, removeDisposeListener, removeListener, removeListener, removeListener, removeTypedListener, rendererGetPreferredWidthProc, rendererRenderProc, rendererSnapshotProc, reskin, reskinChildren, reskinWidget, scrollProc, sendEvent, sendEvent, sendEvent, sendEvent, sendIMKeyEvent, sendKeyEvent, sendSelectionEvent, sendSelectionEvent, setButtonState, setData, setData, setFontDescription, setInputState, setKeyState, setLocationState, setTabGroupFocus, setToolTipText, shellMapProc, sizeAllocateProc, sizeRequestProc, snapshotToDraw, timerProc, toString, translateTraversal, windowActiveProc, windowProc, windowProc, windowProc, windowProc

Methods inherited from class Object

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

Field Details

dragging

boolean dragging

startX

int startX

startY

int startY

lastX

int lastX

lastY

int lastY

defaultCursor

long defaultCursor

INCREMENT

private static final int INCREMENT

See Also:

• Constant Field Values

PAGE_INCREMENT

private static final int PAGE_INCREMENT

See Also:

• Constant Field Values

DEFAULT_CROSS_AXIS_SIZE

private static final int DEFAULT_CROSS_AXIS_SIZE

See Also:

• Constant Field Values

Constructor Details

Sash

public Sash(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.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

• SWT.HORIZONTAL
• SWT.VERTICAL
• SWT.SMOOTH
• Widget.checkSubclass()
• Widget.getStyle()

Method Details

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the x, y, width, and height fields of the event object are valid. If the receiver is being dragged, the event object detail field contains the value SWT.DRAG. widgetDefaultSelected is not called.

Parameters:

listener - the listener which should be notified when the control is selected by the user

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

• SelectionListener
• removeSelectionListener(SelectionListener)
• SelectionEvent

checkStyle

static int checkStyle(int style)

computeSizeInPixels

Point computeSizeInPixels(int wHint,
 int hHint,
 boolean changed)

Overrides:

computeSizeInPixels in class Control

createHandle

void createHandle(int index)

Overrides:

createHandle in class Widget

gtk_gesture_press_event

int gtk_gesture_press_event(long gesture,
 int n_press,
 double x,
 double y,
 long event)

Description copied from class: Control

Handling multi-press event on GTK4

Overrides:

gtk_gesture_press_event in class Control

Parameters:

gesture - the corresponding controller responsible for capturing the event

n_press - how many touch/button presses happened with this one

x - the x coordinate, in widget allocation coordinates

y - the y coordinate, in widget allocation coordinates

event - the GdkEvent captured

gtk_gesture_release_event

int gtk_gesture_release_event(long gesture,
 int n_press,
 double x,
 double y,
 long event)

Overrides:

gtk_gesture_release_event in class Control

Parameters:

gesture - the corresponding controller responsible for capturing the event

n_press - how many touch/button presses happened with this one

x - the x coordinate, in widget allocation coordinates

y - the y coordinate, in widget allocation coordinates

event - the GdkEvent captured

gtk4_motion_event

void gtk4_motion_event(long controller,
 double x,
 double y,
 long event)

Overrides:

gtk4_motion_event in class Control

Parameters:

controller - the corresponding controller responsible for capturing the event

x - the x coordinate

y - the y coordinate

event - the GdkEvent captured

gtk4_key_press_event

boolean gtk4_key_press_event(long controller,
 int keyval,
 int keycode,
 int state,
 long event)

Overrides:

gtk4_key_press_event in class Control

Parameters:

controller - the corresponding controller responsible for capturing the event

keyval - the pressed key

keycode - raw code of the pressed key

state - the bitmask, representing the state of the modifier keys and pointer buttons

event - the GdkEvent captured

Returns:

TRUE if the event has been fully/properly handled, otherwise FALSE

gtk_button_press_event

long gtk_button_press_event(long widget,
 long event)

Overrides:

gtk_button_press_event in class Control

gtk_button_release_event

long gtk_button_release_event(long widget,
 long event)

Overrides:

gtk_button_release_event in class Control

gtk_draw

long gtk_draw(long widget,
 long cairo)

Overrides:

gtk_draw in class Control

gtk_focus_in_event

long gtk_focus_in_event(long widget,
 long event)

Overrides:

gtk_focus_in_event in class Control

gtk3_key_press_event

long gtk3_key_press_event(long widget,
 long eventPtr)

Overrides:

gtk3_key_press_event in class Control

gtk_motion_notify_event

long gtk_motion_notify_event(long widget,
 long eventPtr)

Overrides:

gtk_motion_notify_event in class Control

gtk_realize

long gtk_realize(long widget)

Overrides:

gtk_realize in class Control

hookEvents

void hookEvents()

Overrides:

hookEvents in class Control

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control is selected by the user.

Parameters:

listener - the listener which should no longer be notified

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

• SelectionListener
• addSelectionListener(SelectionListener)

setCursor

void setCursor(long cursor)

Overrides:

setCursor in class Control

traversalCode

int traversalCode(int key,
 long event)

Overrides:

traversalCode in class Control