Control (Console Utilities 0.2.0 API)

java.lang.Object
- net.morimekta.console.Control

All Implemented Interfaces:

Char

Direct Known Subclasses:

Color
```
public class Control
extends Object
implements Char
```
https://en.wikipedia.org/wiki/C0_and_C1_control_codes

Field Summary

Fields
Modifier and Type	Field and Description
`static Control`	`CTRL_DOWN`
`static Control`	`CTRL_LEFT`
`static Control`	`CTRL_RIGHT`
`static Control`	`CTRL_UP`
`static Control`	`CURSOR_ERASE`
`static Control`	`CURSOR_RESTORE`
`static Control`	`CURSOR_SAVE`
`static Control`	`DELETE`
`static Control`	`DOWN`
`static Control`	`DPAD_MID`
`static Control`	`END`
`static Control`	`F1`
`static Control`	`F2`
`static Control`	`F3`
`static Control`	`F4`
`static Control`	`F5`
`static Control`	`F6`
`static Control`	`F7`
`static Control`	`F8`
`static Control`	`F9`
`static Control`	`HOME`
`static Control`	`INSERT`
`static Control`	`LEFT`
`static Control`	`PAGE_DOWN`
`static Control`	`PAGE_UP`
`static Control`	`RIGHT`
`static Control`	`UP`

Constructor Summary

Constructors
Constructor and Description

Control(CharSequence str)

Constructors
Constructor and Description
`Control(CharSequence str)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`codepoint()` Unicode codepoint representing this character.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`int`	`length()` Number of utf-16 characters that this character takes up if enclosed in a java string.
`int`	`printableWidth()` The number of character spaces taken up by this symbol.
`String`	`toString()`

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

Field Detail

UP
```
public static final Control UP
```

DOWN
```
public static final Control DOWN
```

RIGHT
```
public static final Control RIGHT
```

LEFT
```
public static final Control LEFT
```

CTRL_UP
```
public static final Control CTRL_UP
```

CTRL_DOWN
```
public static final Control CTRL_DOWN
```

CTRL_RIGHT
```
public static final Control CTRL_RIGHT
```

CTRL_LEFT
```
public static final Control CTRL_LEFT
```

CURSOR_ERASE

public static final Control CURSOR_ERASE

CURSOR_SAVE

public static final Control CURSOR_SAVE

CURSOR_RESTORE

public static final Control CURSOR_RESTORE

DPAD_MID
```
public static final Control DPAD_MID
```

INSERT
```
public static final Control INSERT
```

DELETE
```
public static final Control DELETE
```

HOME
```
public static final Control HOME
```

END
```
public static final Control END
```

PAGE_UP
```
public static final Control PAGE_UP
```

PAGE_DOWN
```
public static final Control PAGE_DOWN
```

F1
```
public static final Control F1
```

F2
```
public static final Control F2
```

F3
```
public static final Control F3
```

F4
```
public static final Control F4
```

F5
```
public static final Control F5
```

F6
```
public static final Control F6
```

F7
```
public static final Control F7
```

F8
```
public static final Control F8
```

F9
```
public static final Control F9
```

Constructor Detail
- Control
```
public Control(CharSequence str)
```

Method Detail
- codepoint
```
public int codepoint()
```
  Description copied from interface: Char
  
  Unicode codepoint representing this character.
  
  Specified by:
  
  codepoint in interface Char
  
  Returns:
  
  The 31 bit unsigned unicode code-point, or -1 if not representing a single unicode character.
- printableWidth
```
public int printableWidth()
```
  Description copied from interface: Char
  
  The number of character spaces taken up by this symbol. Usually 1, but 0 for control sequences, control characters, and 2 for wide symbols like CJK characters.
  
  Specified by:
  
  printableWidth in interface Char
  
  Returns:
  
  The printable width of the character.
- length
```
public int length()
```
  Description copied from interface: Char
  
  Number of utf-16 characters that this character takes up if enclosed in a java string.
  
  Specified by:
  
  length in interface Char
  
  Returns:
  
  The char count of the character.
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object

Class Control

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UP

DOWN

RIGHT

LEFT

CTRL_UP

CTRL_DOWN

CTRL_RIGHT

CTRL_LEFT

CURSOR_ERASE

CURSOR_SAVE

CURSOR_RESTORE

DPAD_MID

INSERT

DELETE

HOME

END

PAGE_UP

PAGE_DOWN

F1

F2

F3

F4

F5

F6

F7

F8

F9

Constructor Detail

Control

Method Detail

codepoint

printableWidth

length

toString

equals

hashCode