Class Caret

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Caret

public class Caret
extends Widget

Instances of this class provide an i-beam that is typically used as the insertion point for text.

Styles:

(none)

Events:

(none)

IMPORTANT: This class is not intended to be subclassed.

See Also:

• Caret snippets
• SWT Example: ControlExample, Canvas tab
• Sample code and further information

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	blinkRate
(package private) static final int	DEFAULT_WIDTH
(package private) Composite	embeddedInto
(package private) Font	font
(package private) int	height
(package private) Image	image
(package private) boolean	isShowing
(package private) boolean	isVisible
(package private) Canvas	parent
(package private) int	width
(package private) int	x
(package private) int	y

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, 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
Caret(Canvas 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
(package private) boolean	blinkCaret()
(package private) void	createWidget(int index)
(package private) boolean	drawCaret()
private void	drawInCellEditor(long window)
Rectangle	getBounds()	Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null).
Font	getFont()	Returns the font that the receiver will use to paint textual information.
Image	getImage()	Returns the image that the receiver will use to paint the caret.
Point	getLocation()	Returns a point describing the receiver's location relative to its parent (or its display if its parent is null).
Canvas	getParent()	Returns the receiver's parent, which must be a Canvas.
Point	getSize()	Returns a point describing the receiver's size.
boolean	getVisible()	Returns true if the receiver is visible, and false otherwise.
(package private) boolean	hideCaret()
(package private) boolean	isFocusCaret()
boolean	isVisible()	Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.
(package private) void	killFocus()
(package private) void	releaseParent()
(package private) void	releaseWidget()
void	setBounds(int x, int y, int width, int height)	Sets the receiver's size and location to the rectangular area specified by the arguments.
void	setBounds(Rectangle rect)	Sets the receiver's size and location to the rectangular area specified by the argument.
(package private) void	setFocus()
void	setFont(Font font)	Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.
void	setImage(Image image)	Sets the image that the receiver will use to paint the caret to the image specified by the argument, or to the default which is a filled rectangle if the argument is null
void	setLocation(int x, int y)	Sets the receiver's location to the point specified by the arguments which are relative to the receiver's parent (or its display if its parent is null).
void	setLocation(Point location)	Sets the receiver's location to the point specified by the argument which is relative to the receiver's parent (or its display if its parent is null).
void	setSize(int width, int height)	Sets the receiver's size to the point specified by the arguments.
void	setSize(Point size)	Sets the receiver's size to the point specified by the argument.
void	setVisible(boolean visible)	Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
(package private) boolean	showCaret()

Methods inherited from class Widget

_addListener, addDisposeListener, addListener, addTypedListener, cellDataProc, checkBits, checkOpen, checkOrientation, checkParent, checkSubclass, checkWidget, convertPangoFontDescriptionToCss, createHandle, cssHandle, deregister, destroyWidget, 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_button_press_event, gtk_button_release_event, gtk_cell_renderer_get_preferred_size, gtk_change_value, gtk_changed, gtk_clicked, gtk_close_request, gtk_commit, 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_draw, gtk_enter_notify_event, gtk_expand_collapse_cursor_row, gtk_focus, gtk_focus_in_event, gtk_focus_out_event, gtk_gesture_press_event, gtk_gesture_release_event, gtk_grab_focus, gtk_hide, gtk_icon_release, gtk_input, gtk_insert_text, gtk_leave_notify_event, gtk_map, gtk_map_event, gtk_menu_popped_up, gtk_mnemonic_activate, gtk_month_changed, gtk_motion_notify_event, gtk_move_focus, gtk_output, gtk_populate_popup, gtk_preedit_changed, gtk_realize, gtk_row_activated, gtk_row_has_child_toggled, gtk_scroll_child, gtk_scroll_event, gtk_select, gtk_selection_done, gtk_show, gtk_size_allocate, gtk_start_interactive_search, gtk_status_icon_popup_menu, gtk_style_updated, 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_unrealize, 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, gtk3_event_after, gtk3_key_press_event, 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_press_event, gtk4_key_release_event, gtk4_leave_event, gtk4_motion_event, gtk4_scroll_event, hookEvents, hooks, hoverProc, isActive, isAutoDirection, isDisposed, isListening, isValidSubclass, isValidThread, keyPressReleaseProc, leaveProc, mnemonicHit, mnemonicMatch, notifyCreationTracker, notifyDisposalTracker, notifyListeners, notifyProc, notifyState, paintSurface, paintWindow, postEvent, postEvent, register, release, releaseChildren, releaseHandle, 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, setOrientation, setTabGroupFocus, setTabItemFocus, setToolTipText, shellMapProc, sizeAllocateProc, sizeRequestProc, snapshotToDraw, timerProc, topHandle, toString, translateTraversal, windowActiveProc, windowProc, windowProc, windowProc, windowProc, windowProc

Methods inherited from class Object

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

Field Details

parent

Canvas parent

embeddedInto

Composite embeddedInto

x

int x

y

int y

width

int width

height

int height

isVisible

boolean isVisible

isShowing

boolean isShowing

blinkRate

int blinkRate

image

Image image

font

Font font

DEFAULT_WIDTH

static final int DEFAULT_WIDTH

See Also:

• Constant Field Values

Constructor Details

Caret

public Caret(Canvas 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
• Widget.checkSubclass()
• Widget.getStyle()

Method Details

blinkCaret

boolean blinkCaret()

createWidget

void createWidget(int index)

Overrides:

createWidget in class Widget

drawCaret

boolean drawCaret()

drawInCellEditor

private void drawInCellEditor(long window)

getBounds

public Rectangle getBounds()

Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null).

Returns:

the receiver's bounding rectangle

Throws:

SWTException -

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

getFont

public Font getFont()

Returns the font that the receiver will use to paint textual information.

Returns:

the receiver's font

Throws:

SWTException -

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

getImage

public Image getImage()

Returns the image that the receiver will use to paint the caret.

Returns:

the receiver's image

Throws:

SWTException -

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

getLocation

public Point getLocation()

Returns a point describing the receiver's location relative to its parent (or its display if its parent is null).

Returns:

the receiver's location

Throws:

SWTException -

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

getParent

public Canvas getParent()

Returns the receiver's parent, which must be a Canvas.

Returns:

the receiver's parent

Throws:

SWTException -

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

getSize

public Point getSize()

Returns a point describing the receiver's size.

Returns:

the receiver's size

Throws:

SWTException -

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

getVisible

public boolean getVisible()

Returns true if the receiver is visible, and false otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Returns:

the receiver's visibility state

Throws:

SWTException -

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

hideCaret

boolean hideCaret()

isVisible

public boolean isVisible()

Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

Returns:

the receiver's visibility state

Throws:

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:

• getVisible()

isFocusCaret

boolean isFocusCaret()

killFocus

void killFocus()

releaseParent

void releaseParent()

Overrides:

releaseParent in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

setBounds

public void setBounds(int x,
 int y,
 int width,
 int height)

Sets the receiver's size and location to the rectangular area specified by the arguments. The x and y arguments are relative to the receiver's parent (or its display if its parent is null).

Parameters:

x - the new x coordinate for the receiver

y - the new y coordinate for the receiver

width - the new width for the receiver

height - the new height for the receiver

Throws:

SWTException -

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

setBounds

public void setBounds(Rectangle rect)

Sets the receiver's size and location to the rectangular area specified by the argument. The x and y fields of the rectangle are relative to the receiver's parent (or its display if its parent is null).

Parameters:

rect - the new bounds for the receiver

Throws:

SWTException -

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

setFocus

void setFocus()

setFont

public void setFont(Font font)

Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.

Parameters:

font - the new font (or null)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the font has been disposed

SWTException -

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

setImage

public void setImage(Image image)

Sets the image that the receiver will use to paint the caret to the image specified by the argument, or to the default which is a filled rectangle if the argument is null

Parameters:

image - the new image (or null)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the image has been disposed

SWTException -

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

setLocation

public void setLocation(int x,
 int y)

Sets the receiver's location to the point specified by the arguments which are relative to the receiver's parent (or its display if its parent is null).

Parameters:

x - the new x coordinate for the receiver

y - the new y coordinate for the receiver

Throws:

SWTException -

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

setLocation

public void setLocation(Point location)

Sets the receiver's location to the point specified by the argument which is relative to the receiver's parent (or its display if its parent is null).

Parameters:

location - the new location for the receiver

Throws:

SWTException -

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

setSize

public void setSize(int width,
 int height)

Sets the receiver's size to the point specified by the arguments.

Parameters:

width - the new width for the receiver

height - the new height for the receiver

Throws:

SWTException -

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

setSize

public void setSize(Point size)

Sets the receiver's size to the point specified by the argument.

Parameters:

size - the new extent for the receiver

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point 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

setVisible

public void setVisible(boolean visible)

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Parameters:

visible - the new visibility state

Throws:

SWTException -

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

showCaret

boolean showCaret()