|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibble.pircbot.Colors
The Colors class provides several static fields and methods that you may find useful when writing an IRC Bot.
This class contains constants that are useful for formatting lines sent to IRC servers. These constants allow you to apply various formatting to the lines, such as colours, boldness, underlining and reverse text.
The class contains static methods to remove colours and formatting from lines of IRC text.
Here are some examples of how to use the contants from within a class that extends PircBot and imports org.jibble.pircbot.*;
sendMessage("#cs", Colors.BOLD + "A bold hello!"); A bold hello! sendMessage("#cs", Colors.RED + "Red" + Colors.NORMAL + " text"); Red text sendMessage("#cs", Colors.BOLD + Colors.RED + "Bold and red"); Bold and redPlease note that some IRC channels may be configured to reject any messages that use colours. Also note that older IRC clients may be unable to correctly display lines that contain colours and other control characters.
Note that this class name has been spelt in the American style in order to remain consistent with the rest of the Java API.
Field Summary | |
static java.lang.String |
BLACK
Black coloured text. |
static java.lang.String |
BLUE
Blue coloured text. |
static java.lang.String |
BOLD
Bold text. |
static java.lang.String |
BROWN
Brown coloured text. |
static java.lang.String |
CYAN
Cyan coloured text. |
static java.lang.String |
DARK_BLUE
Dark blue coloured text. |
static java.lang.String |
DARK_GRAY
Dark gray coloured text. |
static java.lang.String |
DARK_GREEN
Dark green coloured text. |
static java.lang.String |
GREEN
Green coloured text. |
static java.lang.String |
LIGHT_GRAY
Light gray coloured text. |
static java.lang.String |
MAGENTA
Magenta coloured text. |
static java.lang.String |
NORMAL
Removes all previously applied color and formatting attributes. |
static java.lang.String |
OLIVE
Olive coloured text. |
static java.lang.String |
PURPLE
Purple coloured text. |
static java.lang.String |
RED
Red coloured text. |
static java.lang.String |
REVERSE
Reversed text (may be rendered as italic text in some clients). |
static java.lang.String |
TEAL
Teal coloured text. |
static java.lang.String |
UNDERLINE
Underlined text. |
static java.lang.String |
WHITE
White coloured text. |
static java.lang.String |
YELLOW
Yellow coloured text. |
Method Summary | |
static java.lang.String |
removeColors(java.lang.String line)
Removes all colours from a line of IRC text. |
static java.lang.String |
removeFormatting(java.lang.String line)
Remove formatting from a line of IRC text. |
static java.lang.String |
removeFormattingAndColors(java.lang.String line)
Removes all formatting and colours from a line of IRC text. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String NORMAL
public static final java.lang.String BOLD
public static final java.lang.String UNDERLINE
public static final java.lang.String REVERSE
public static final java.lang.String WHITE
public static final java.lang.String BLACK
public static final java.lang.String DARK_BLUE
public static final java.lang.String DARK_GREEN
public static final java.lang.String RED
public static final java.lang.String BROWN
public static final java.lang.String PURPLE
public static final java.lang.String OLIVE
public static final java.lang.String YELLOW
public static final java.lang.String GREEN
public static final java.lang.String TEAL
public static final java.lang.String CYAN
public static final java.lang.String BLUE
public static final java.lang.String MAGENTA
public static final java.lang.String DARK_GRAY
public static final java.lang.String LIGHT_GRAY
Method Detail |
public static java.lang.String removeColors(java.lang.String line)
line
- the input text.
public static java.lang.String removeFormatting(java.lang.String line)
line
- the input text.
public static java.lang.String removeFormattingAndColors(java.lang.String line)
line
- the input text.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |