KeyHotSpot (NetPhantom® 8.0 Java API Specification)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- se.entra.phantom.common.HotSpot
- - se.entra.phantom.client.KeyHotSpot

```
public class KeyHotSpot
extends HotSpot
```
Handles hot spots for function keys and other special keys.
Author:
Christopher Mindus

Field Summary
Fields
Modifier and Type Field and Description
protected int sendKey
The send key for newly created hot spots.
- Fields inherited from class se.entra.phantom.common.HotSpot
  active, NEW_HOTSPOT_DELIMITER, text, width, x

Constructor Summary
Constructors
Constructor and Description
KeyHotSpot()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate(TerminalWindow tw)` Called when the hot spot is activated.
`int`	`check(char[] line, List<HotSpot> hotSpots, int begin, int end)` Checks if a hot spot is found.
`boolean`	`continueChecking(char[] line, char ch, int begin, int end)` Checks if it is OK to keep on checking.
`void`	`initialize(String setup, boolean active)` Performs initialization from the setup data.
`void`	`onCreate(HotSpot parent)` Called when a new hot spot has been instantiated.

Methods inherited from class se.entra.phantom.common.HotSpot
addHotSpot, equals, fillCharBackground, isInside, parse, postPaint, setTextColor

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sendKey
```
protected int sendKey
```
    The send key for newly created hot spots.
- Constructor Detail
  - KeyHotSpot
```
public KeyHotSpot()
```
- Method Detail
  - initialize
```
public void initialize(String setup,
                       boolean active)
```
    Performs initialization from the setup data. Each hyperlink entry in the setup string (that is comma separated) contains the initial string.
    Specified by:
    initialize in class HotSpot
  - onCreate
```
public void onCreate(HotSpot parent)
```
    Called when a new hot spot has been instantiated.
    Overrides:
    onCreate in class HotSpot
  - continueChecking
```
public boolean continueChecking(char[] line,
                                char ch,
                                int begin,
                                int end)
```
    Checks if it is OK to keep on checking.
    Specified by:
    continueChecking in class HotSpot
  - check
```
public int check(char[] line,
                 List<HotSpot> hotSpots,
                 int begin,
                 int end)
```
    Checks if a hot spot is found. If it is, the position returned should be directly after the new hot spot.
    Specified by:
    check in class HotSpot
  - activate
```
public void activate(TerminalWindow tw)
```
    Called when the hot spot is activated.
    Specified by:
    activate in class HotSpot

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Phantom® and NetPhantom® are registered trademarks of Mindus SARL.
© 2026 Mindus SARL. All rights reserved.