icy.network

Class IRCUtil

java.lang.Object

icy.network.IRCUtil

public class IRCUtil
extends java.lang.Object

IRC utilities class.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IRCUtil.IRCAttribute
static class	IRCUtil.IRCAttributeSet

Field Summary

Fields

Modifier and Type	Field and Description
static char	CHAR_BOLD
static char	CHAR_COLOR
static char	CHAR_ITALIC
static char	CHAR_RESET
static char	CHAR_UNDERLINE

Constructor Summary

Constructors

Constructor and Description
IRCUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	applyAttribute(IRCUtil.IRCAttributeSet set, IRCUtil.IRCAttribute attr) Apply the specified IRC attribute on specified IRC attributes set.
static javax.swing.text.SimpleAttributeSet	createAttributeSet(javax.swing.text.SimpleAttributeSet defaultAttributes, IRCUtil.IRCAttributeSet ircAttributes) Return a new AttributeSet from the given default set and IRC attributes.
static IRCUtil.IRCAttribute	getAttribute(java.lang.String ircString, int index) Return the IRC attribute corresponding to the control code at specified index.
static java.lang.String	getBoldString(java.lang.String value) Returns IRC bold version of specified string.
static java.awt.Color	getIRCColor(int num) Return the color corresponding to the specified IRC color code.
static java.lang.String	getItalicString(java.lang.String value) Returns IRC italic version of specified string.
static java.lang.String	getUnderlineString(java.lang.String value) Returns IRC underline version of specified string.
static void	insertString(java.lang.String ircString, javax.swing.text.Document doc, javax.swing.text.SimpleAttributeSet defaultAttributes) Insert the specified IRC string into specified Document.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHAR_BOLD

public static final char CHAR_BOLD

See Also:

Constant Field Values

CHAR_ITALIC

public static final char CHAR_ITALIC

See Also:

Constant Field Values

CHAR_UNDERLINE

public static final char CHAR_UNDERLINE

See Also:

Constant Field Values

CHAR_COLOR

public static final char CHAR_COLOR

See Also:

Constant Field Values

CHAR_RESET

public static final char CHAR_RESET

See Also:

Constant Field Values

Constructor Detail

IRCUtil

public IRCUtil()

Method Detail

insertString

public static void insertString(java.lang.String ircString,
                javax.swing.text.Document doc,
                javax.swing.text.SimpleAttributeSet defaultAttributes)
                         throws javax.swing.text.BadLocationException

Insert the specified IRC string into specified Document.

Parameters:

ircString - IRC string containing IRC code.

doc - doc when we want to insert the IRC styled string.

defaultAttributes - default string attributes.

Throws:

javax.swing.text.BadLocationException

getAttribute

public static IRCUtil.IRCAttribute getAttribute(java.lang.String ircString,
                                int index)

Return the IRC attribute corresponding to the control code at specified index.

applyAttribute

public static void applyAttribute(IRCUtil.IRCAttributeSet set,
                  IRCUtil.IRCAttribute attr)

Apply the specified IRC attribute on specified IRC attributes set.
Some IRC attribute work as switch :
If bold is already set and you apply bold again, then bold is removed from set.

Parameters:

set - IRC attributes set.

attr - IRC single attribute.

createAttributeSet

public static javax.swing.text.SimpleAttributeSet createAttributeSet(javax.swing.text.SimpleAttributeSet defaultAttributes,
                                                     IRCUtil.IRCAttributeSet ircAttributes)

Return a new AttributeSet from the given default set and IRC attributes.

Parameters:

defaultAttributes - default Attribute Set we use as base attributes.

ircAttributes - IRC attributes used to modifying default attributes.

getIRCColor

public static java.awt.Color getIRCColor(int num)

Return the color corresponding to the specified IRC color code.

getBoldString

public static java.lang.String getBoldString(java.lang.String value)

Returns IRC bold version of specified string.

getItalicString

public static java.lang.String getItalicString(java.lang.String value)

Returns IRC italic version of specified string.

getUnderlineString

public static java.lang.String getUnderlineString(java.lang.String value)

Returns IRC underline version of specified string.