TextCaret (kfc 1.2.0 API)

java.lang.Object
- jp.kyasu.awt.text.TextCaret

すべての実装されたインタフェース:

java.awt.event.ActionListener, java.io.Serializable, java.util.EventListener
```
public class TextCaret
extends java.lang.Object
implements java.awt.event.ActionListener, java.io.Serializable
```
The TextCaret class implements a caret showing in the TextEditView object.

関連項目:

TextEditView, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`BAR_CARET` The caret style constant for the bar caret.
`static int`	`BLINK_INTERVAL` The default interval of blinking.
`protected boolean`	`caretShowing`
`protected Timer`	`caretTimer`
`protected jp.kyasu.awt.text.TextCaret.CaretContext`	`context`
`static java.awt.Color`	`DEFAULT_CARET_COLOR` The default caret color.
`static int`	`DEFAULT_CARET_STYLE` The default caret style.
`static boolean`	`DEFAULT_DO_BLINK` The default flag that determines to blink the caret.
`protected static java.awt.Toolkit`	`DefaultToolkit`
`protected boolean`	`doBlink`
`static int`	`HAT_CARET` The caret style constant for the hat caret.
`protected int`	`style`
`protected java.awt.Component`	`target`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`TextCaret()` Constructs a text caret with the default style and the default flag determining to do blink.
`TextCaret(boolean doBlink)` Constructs a text caret with the default style and the specified flag determining to do blink.
`TextCaret(int style)` Constructs a text caret with the specified style and the default flag determining to do blink.
`TextCaret(int style, boolean doBlink)` Constructs a text caret with the specified style and flag determining to do blink.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`actionPerformed(java.awt.event.ActionEvent e)` Invoked when a timer action occurs.
`boolean`	`doBlink()` Tests if this caret does blinking.
`int`	`getStyle()` Returns the style of this caret.
`protected java.awt.Component`	`getTarget()` Returns the target component into whitch the caret shows.
`void`	`hideCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Hides this caret with the specified graphics, offset, text position, and color.
`boolean`	`isBlinking()` Tests if this caret is blinking.
`protected void`	`safeToggleCaret()` Shows or hides this caret safely with the caret context.
`protected void`	`safeToggleCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Shows ot hides this caret safely with the specified graphics, offset, text position, and color.
`protected void`	`setStyle(int style)` Sets the style of this caret.
`protected void`	`setTarget(java.awt.Component target)` Sets the target component into whitch the caret shows.
`void`	`showCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Shows this caret with the specified graphics, offset, text position, and color.
`void`	`start()` Starts the blinking.
`void`	`stop()` Stops the blinking.
`protected void`	`toggleBarCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Shows ot hides this caret as a bar caret with the specified graphics, offset, text position, and color.
`protected void`	`toggleCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Shows ot hides this caret with the specified graphics, offset, text position, and color.
`protected void`	`toggleHatCaret(java.awt.Graphics g, java.awt.Point offset, TextPositionInfo posInfo, java.awt.Color caretColor)` Shows ot hides this caret as a hat caret with the specified graphics, offset, text position, and color.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - style
```
protected int style
```
  - doBlink
```
protected boolean doBlink
```
  - caretShowing
```
protected boolean caretShowing
```
  - caretTimer
```
protected Timer caretTimer
```
  - target
```
protected java.awt.Component target
```
  - context
```
protected transient jp.kyasu.awt.text.TextCaret.CaretContext context
```
  - DefaultToolkit
```
protected static java.awt.Toolkit DefaultToolkit
```
  - BAR_CARET
```
public static final int BAR_CARET
```
    The caret style constant for the bar caret.
    
    関連項目:
    
    定数フィールド値
  - HAT_CARET
```
public static final int HAT_CARET
```
    The caret style constant for the hat caret.
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_CARET_STYLE
```
public static final int DEFAULT_CARET_STYLE
```
    The default caret style.
  - DEFAULT_CARET_COLOR
```
public static final java.awt.Color DEFAULT_CARET_COLOR
```
    The default caret color.
  - DEFAULT_DO_BLINK
```
public static final boolean DEFAULT_DO_BLINK
```
    The default flag that determines to blink the caret.
  - BLINK_INTERVAL
```
public static final int BLINK_INTERVAL
```
    The default interval of blinking.
- コンストラクタの詳細
  - TextCaret
```
public TextCaret()
```
    Constructs a text caret with the default style and the default flag determining to do blink.
  - TextCaret
```
public TextCaret(int style)
```
    Constructs a text caret with the specified style and the default flag determining to do blink.
    
    パラメータ:
    
    style - the caret style.
  - TextCaret
```
public TextCaret(boolean doBlink)
```
    Constructs a text caret with the default style and the specified flag determining to do blink.
    
    パラメータ:
    
    doBlink - the flag determining to do blink.
  - TextCaret
```
public TextCaret(int style,
                 boolean doBlink)
```
    Constructs a text caret with the specified style and flag determining to do blink.
    
    パラメータ:
    
    style - the caret style.
    
    doBlink - the flag determining to do blink.
- メソッドの詳細
  - doBlink
```
public boolean doBlink()
```
    Tests if this caret does blinking.
  - getStyle
```
public int getStyle()
```
    Returns the style of this caret.
  - setStyle
```
protected void setStyle(int style)
```
    Sets the style of this caret.
    
    パラメータ:
    
    style - the caret style.
    
    関連項目:
    
    BAR_CARET, HAT_CARET
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
    Invoked when a timer action occurs.
    
    定義:
    
    actionPerformed インタフェース内 java.awt.event.ActionListener
  - start
```
public void start()
```
    Starts the blinking.
  - stop
```
public void stop()
```
    Stops the blinking.
  - isBlinking
```
public boolean isBlinking()
```
    Tests if this caret is blinking.
  - showCaret
```
public void showCaret(java.awt.Graphics g,
                      java.awt.Point offset,
                      TextPositionInfo posInfo,
                      java.awt.Color caretColor)
```
    Shows this caret with the specified graphics, offset, text position, and color.
    
    パラメータ:
    
    g - the graphics object.
    
    offset - the offset of the graphics object.
    
    posInfo - the text position to show the caret.
    
    caretColor - the caret color.
  - hideCaret
```
public void hideCaret(java.awt.Graphics g,
                      java.awt.Point offset,
                      TextPositionInfo posInfo,
                      java.awt.Color caretColor)
```
    Hides this caret with the specified graphics, offset, text position, and color.
    
    パラメータ:
    
    g - the graphics object.
    
    offset - the offset of the graphics object.
    
    posInfo - the text position to hide the caret.
    
    caretColor - the caret color.
  - getTarget
```
protected java.awt.Component getTarget()
```
    Returns the target component into whitch the caret shows.
  - setTarget
```
protected void setTarget(java.awt.Component target)
```
    Sets the target component into whitch the caret shows.
  - safeToggleCaret
```
protected void safeToggleCaret()
```
    Shows or hides this caret safely with the caret context.
  - safeToggleCaret
```
protected void safeToggleCaret(java.awt.Graphics g,
                               java.awt.Point offset,
                               TextPositionInfo posInfo,
                               java.awt.Color caretColor)
```
    Shows ot hides this caret safely with the specified graphics, offset, text position, and color.
  - toggleCaret
```
protected void toggleCaret(java.awt.Graphics g,
                           java.awt.Point offset,
                           TextPositionInfo posInfo,
                           java.awt.Color caretColor)
```
    Shows ot hides this caret with the specified graphics, offset, text position, and color.
  - toggleBarCaret
```
protected void toggleBarCaret(java.awt.Graphics g,
                              java.awt.Point offset,
                              TextPositionInfo posInfo,
                              java.awt.Color caretColor)
```
    Shows ot hides this caret as a bar caret with the specified graphics, offset, text position, and color.
  - toggleHatCaret
```
protected void toggleHatCaret(java.awt.Graphics g,
                              java.awt.Point offset,
                              TextPositionInfo posInfo,
                              java.awt.Color caretColor)
```
    Shows ot hides this caret as a hat caret with the specified graphics, offset, text position, and color.

クラス TextCaret

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

style

doBlink

caretShowing

caretTimer

target

context

DefaultToolkit

BAR_CARET

HAT_CARET

DEFAULT_CARET_STYLE

DEFAULT_CARET_COLOR

DEFAULT_DO_BLINK

BLINK_INTERVAL

コンストラクタの詳細

TextCaret

TextCaret

TextCaret

TextCaret

メソッドの詳細

doBlink

getStyle

setStyle

actionPerformed

start

stop

isBlinking

showCaret

hideCaret

getTarget

setTarget

safeToggleCaret

safeToggleCaret

toggleCaret

toggleBarCaret

toggleHatCaret