package org.eclipse.swt.widgets; | |
/* | |
* (c) Copyright IBM Corp. 2000, 2001. | |
* All Rights Reserved | |
*/ | |
import org.eclipse.swt.internal.win32.*; | |
import org.eclipse.swt.*; | |
import org.eclipse.swt.graphics.*; | |
/** | |
* Instances of this class provide an i-beam that is typically used | |
* as the insertion point for text. | |
* <dl> | |
* <dt><b>Styles:</b></dt> | |
* <dd>(none)</dd> | |
* <dt><b>Events:</b></dt> | |
* <dd>(none)</dd> | |
* </dl> | |
* <p> | |
* IMPORTANT: This class is intended to be subclassed <em>only</em> | |
* within the SWT implementation. | |
* </p> | |
*/ | |
public class Caret extends Widget { | |
Canvas parent; | |
int x, y, width, height; | |
boolean moved, resized; | |
boolean isVisible; | |
Image image; | |
Font font; | |
LOGFONT oldFont; | |
/** | |
* Constructs a new instance of this class given its parent | |
* and a style value describing its behavior and appearance. | |
* <p> | |
* The style value is either one of the style constants defined in | |
* class <code>SWT</code> which is applicable to instances of this | |
* class, or must be built by <em>bitwise OR</em>'ing together | |
* (that is, using the <code>int</code> "|" operator) two or more | |
* of those <code>SWT</code> style constants. The class description | |
* for all SWT widget classes should include a comment which | |
* describes the style constants which are applicable to the class. | |
* </p> | |
* | |
* @param parent a composite control which will be the parent of the new instance (cannot be null) | |
* @param style the style of control to construct | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> | |
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> | |
* </ul> | |
* | |
* @see SWT | |
* @see Widget#checkSubclass | |
* @see Widget#getStyle | |
*/ | |
public Caret (Canvas parent, int style) { | |
super (parent, style); | |
this.parent = parent; | |
createWidget (); | |
} | |
void createWidget () { | |
isVisible = true; | |
if (parent.getCaret () == null) { | |
parent.setCaret (this); | |
} | |
} | |
int defaultFont () { | |
int hwnd = parent.handle; | |
int hwndIME = OS.ImmGetDefaultIMEWnd (hwnd); | |
if (hwndIME == 0) return parent.defaultFont (); | |
int hFont = OS.SendMessage (hwndIME, OS.WM_GETFONT, 0, 0); | |
if (hFont == 0) return parent.defaultFont (); | |
return hFont; | |
} | |
/** | |
* Returns a rectangle describing the receiver's size and location | |
* relative to its parent (or its display if its parent is null). | |
* | |
* @return the receiver's bounding rectangle | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Rectangle getBounds () { | |
checkWidget(); | |
if (image != null) { | |
Rectangle rect = image.getBounds (); | |
return new Rectangle (x, y, rect.width, rect.height); | |
} | |
return new Rectangle (x, y, width, height); | |
} | |
public Display getDisplay () { | |
Composite parent = this.parent; | |
if (parent == null) error (SWT.ERROR_WIDGET_DISPOSED); | |
return parent.getDisplay (); | |
} | |
/** | |
* Returns the font that the receiver will use to paint textual information. | |
* | |
* @return the receiver's font | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Font getFont () { | |
checkWidget(); | |
if (font == null) { | |
int hFont = defaultFont (); | |
return Font.win32_new (getDisplay (), hFont); | |
} | |
return font; | |
} | |
/** | |
* Returns the image that the receiver will use to paint the caret. | |
* | |
* @return the receiver's image | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Image getImage () { | |
checkWidget(); | |
return image; | |
} | |
/** | |
* Returns a point describing the receiver's location relative | |
* to its parent (or its display if its parent is null). | |
* | |
* @return the receiver's location | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Point getLocation () { | |
checkWidget(); | |
return new Point (x, y); | |
} | |
/** | |
* Returns the receiver's parent, which must be a <code>Canvas</code>. | |
* | |
* @return the receiver's parent | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Canvas getParent () { | |
checkWidget(); | |
return parent; | |
} | |
/** | |
* Returns a point describing the receiver's size. | |
* | |
* @return the receiver's size | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Point getSize () { | |
checkWidget(); | |
if (image != null) { | |
Rectangle rect = image.getBounds (); | |
return new Point (rect.width, rect.height); | |
} | |
return new Point (width, height); | |
} | |
/** | |
* Returns <code>true</code> if the receiver is visible, and | |
* <code>false</code> otherwise. | |
* <p> | |
* 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. | |
* </p> | |
* | |
* @return the receiver's visibility state | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public boolean getVisible () { | |
checkWidget(); | |
return isVisible; | |
} | |
boolean hasFocus () { | |
return parent.handle == OS.GetFocus (); | |
} | |
boolean isFocusCaret () { | |
return parent.caret == this && hasFocus (); | |
} | |
/** | |
* Returns <code>true</code> if the receiver is visible, and | |
* <code>false</code> otherwise. | |
* <p> | |
* 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. | |
* </p> | |
* | |
* @return the receiver's visibility state | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public boolean isVisible () { | |
checkWidget(); | |
return isVisible && parent.isVisible () && hasFocus (); | |
} | |
void killFocus () { | |
OS.DestroyCaret (); | |
if (font != null) restoreIMEFont (); | |
} | |
void move () { | |
moved = false; | |
if (!OS.SetCaretPos (x, y)) return; | |
if (OS.IsDBLocale) { | |
POINT ptCurrentPos = new POINT (); | |
if (!OS.GetCaretPos (ptCurrentPos)) return; | |
COMPOSITIONFORM lpCompForm = new COMPOSITIONFORM (); | |
lpCompForm.dwStyle = OS.CFS_POINT; | |
lpCompForm.x = ptCurrentPos.x; | |
lpCompForm.y = ptCurrentPos.y; | |
int hwnd = parent.handle; | |
int hIMC = OS.ImmGetContext (hwnd); | |
OS.ImmSetCompositionWindow (hIMC, lpCompForm); | |
OS.ImmReleaseContext (hwnd, hIMC); | |
} | |
} | |
void releaseChild () { | |
super.releaseChild (); | |
if (this == parent.getCaret ()) parent.setCaret (null); | |
} | |
void releaseWidget () { | |
super.releaseWidget (); | |
parent = null; | |
image = null; | |
font = null; | |
oldFont = null; | |
} | |
void resize () { | |
resized = false; | |
int hwnd = parent.handle; | |
OS.DestroyCaret (); | |
int hBitmap = 0; | |
if (image != null) hBitmap = image.handle; | |
OS.CreateCaret (hwnd, hBitmap, width, height); | |
OS.SetCaretPos (x, y); | |
OS.ShowCaret (hwnd); | |
move (); | |
} | |
void restoreIMEFont () { | |
if (!OS.IsDBLocale) return; | |
if (oldFont == null) return; | |
int hwnd = parent.handle; | |
int hIMC = OS.ImmGetContext (hwnd); | |
OS.ImmSetCompositionFont (hIMC, oldFont); | |
OS.ImmReleaseContext (hwnd, hIMC); | |
oldFont = null; | |
} | |
void saveIMEFont () { | |
if (!OS.IsDBLocale) return; | |
if (oldFont != null) return; | |
int hwnd = parent.handle; | |
int hIMC = OS.ImmGetContext (hwnd); | |
oldFont = new LOGFONT (); | |
if (OS.ImmGetCompositionFont (hIMC, oldFont)) oldFont = null; | |
OS.ImmReleaseContext (hwnd, hIMC); | |
} | |
/** | |
* Sets the receiver's size and location to the rectangular | |
* area specified by the arguments. The <code>x</code> and | |
* <code>y</code> arguments are relative to the receiver's | |
* parent (or its display if its parent is null). | |
* | |
* @param x the new x coordinate for the receiver | |
* @param y the new y coordinate for the receiver | |
* @param width the new width for the receiver | |
* @param height the new height for the receiver | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setBounds (int x, int y, int width, int height) { | |
checkWidget(); | |
boolean samePosition = this.x == x && this.y == y; | |
boolean sameExtent = this.width == width && this.height == height; | |
if (samePosition && sameExtent) return; | |
this.x = x; this.y = y; | |
this.width = width; this.height = height; | |
if (sameExtent) { | |
moved = true; | |
if (isVisible && hasFocus ()) move (); | |
} else { | |
resized = true; | |
if (isVisible && hasFocus ()) resize (); | |
} | |
} | |
/** | |
* Sets the receiver's size and location to the rectangular | |
* area specified by the argument. The <code>x</code> and | |
* <code>y</code> fields of the rectangle are relative to | |
* the receiver's parent (or its display if its parent is null). | |
* | |
* @param rect the new bounds for the receiver | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setBounds (Rectangle rect) { | |
if (rect == null) error (SWT.ERROR_NULL_ARGUMENT); | |
setBounds (rect.x, rect.y, rect.width, rect.height); | |
} | |
void setFocus () { | |
int hwnd = parent.handle; | |
int hBitmap = 0; | |
if (image != null) hBitmap = image.handle; | |
OS.CreateCaret (hwnd, hBitmap, width, height); | |
move (); | |
if (font != null) { | |
int hFont = font.handle; | |
saveIMEFont (); | |
setIMEFont (hFont); | |
} | |
if (isVisible) OS.ShowCaret (hwnd); | |
} | |
/** | |
* 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. | |
* | |
* @param font the new font (or null) | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_ARGUMENT - if the font has been disposed</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setFont (Font font) { | |
checkWidget(); | |
if (font != null && font.isDisposed ()) { | |
error (SWT.ERROR_INVALID_ARGUMENT); | |
} | |
this.font = font; | |
if (isVisible && hasFocus ()) { | |
int hFont = 0; | |
if (font != null) hFont = font.handle; | |
if (hFont == 0) hFont = defaultFont (); | |
saveIMEFont (); | |
setIMEFont (hFont); | |
} | |
} | |
/** | |
* 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 | |
* | |
* @param font the new font (or null) | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setImage (Image image) { | |
checkWidget(); | |
if (image != null && image.isDisposed ()) { | |
error (SWT.ERROR_INVALID_ARGUMENT); | |
} | |
this.image = image; | |
if (isVisible && hasFocus ()) resize (); | |
} | |
void setIMEFont (int hFont) { | |
if (!OS.IsDBLocale) return; | |
LOGFONT logFont = new LOGFONT (); | |
if (OS.GetObject (hFont, LOGFONT.sizeof, logFont) != 0) { | |
int hwnd = parent.handle; | |
int hIMC = OS.ImmGetContext (hwnd); | |
OS.ImmSetCompositionFont (hIMC, logFont); | |
OS.ImmReleaseContext (hwnd, hIMC); | |
} | |
} | |
/** | |
* 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). | |
* | |
* @param x the new x coordinate for the receiver | |
* @param y the new y coordinate for the receiver | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setLocation (int x, int y) { | |
checkWidget(); | |
if (this.x == x && this.y == y) return; | |
this.x = x; this.y = y; | |
moved = true; | |
if (isVisible && hasFocus ()) move (); | |
} | |
/** | |
* 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). | |
* | |
* @param location the new location for the receiver | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setLocation (Point location) { | |
checkWidget(); | |
if (location == null) error (SWT.ERROR_NULL_ARGUMENT); | |
setLocation (location.x, location.y); | |
} | |
/** | |
* Sets the receiver's size to the point specified by the arguments. | |
* | |
* @param width the new width for the receiver | |
* @param height the new height for the receiver | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setSize (int width, int height) { | |
checkWidget(); | |
if (this.width == width && this.height == height) return; | |
this.width = width; this.height = height; | |
resized = true; | |
if (isVisible && hasFocus ()) resize (); | |
} | |
/** | |
* Sets the receiver's size to the point specified by the argument. | |
* | |
* @param size the new extent for the receiver | |
* @param height the new height for the receiver | |
* | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT - if the point is null</li> | |
* </ul> | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setSize (Point size) { | |
checkWidget(); | |
if (size == null) error (SWT.ERROR_NULL_ARGUMENT); | |
setSize (size.x, size.y); | |
} | |
/** | |
* Marks the receiver as visible if the argument is <code>true</code>, | |
* and marks it invisible otherwise. | |
* <p> | |
* 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. | |
* </p> | |
* | |
* @param visible the new visibility state | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setVisible (boolean visible) { | |
checkWidget(); | |
if (visible == isVisible) return; | |
isVisible = visible; | |
int hwnd = parent.handle; | |
if (OS.GetFocus () != hwnd) return; | |
if (!isVisible) { | |
OS.HideCaret (hwnd); | |
} else { | |
if (resized) { | |
resize (); | |
} else { | |
if (moved) move (); | |
} | |
OS.ShowCaret (hwnd); | |
} | |
} | |
} |