aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/protocol/irc/ControlChar.java
blob: b50a891d1293ff086703e5957d945ae837aea80d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.impl.protocol.irc;

/**
 * Available IRC control characters.
 *
 * @author Danny van Heumen
 */
public abstract class ControlChar
{
    /**
     * HTML tag that expresses the specific formatting requirement.
     */
    private final String tag;

    /**
     * Constructor.
     *
     * @param htmlTag the control code
     */
    private ControlChar(final String htmlTag)
    {
        this.tag = htmlTag;
    }

    /**
     * The specified HTML tag.
     *
     * @return returns the HTML tag.
     */
    public String getTag()
    {
        return this.tag;
    }

    /**
     * Get the HTML start tag.
     *
     * @return returns HTML start tag.
     */
    public String getHtmlStart()
    {
        return "<" + this.tag + ">";
    }

    /**
     * Get the HTML end tag.
     *
     * @return returns the HTML end tag
     */
    public String getHtmlEnd()
    {
        return "</" + this.tag + ">";
    }

    /**
     * Control char representation for 'bold' formatting.
     *
     * @author Danny van Heumen
     */
    static class Bold extends ControlChar
    {
        /**
         * IRC control code.
         */
        public static final char CODE = '\u0002';

        /**
         * Constructor.
         */
        Bold()
        {
            super("b");
        }
    }

    /**
     * Control char representation for 'italics' formatting.
     *
     * @author Danny van Heumen
     */
    static class Italics extends ControlChar
    {
        /**
         * IRC control code.
         */
        public static final char CODE = '\u0016';

        /**
         * Constructor.
         */
        Italics()
        {
            super("i");
        }
    }

    /**
     * Control char representation for underlining.
     *
     * @author Danny van Heumen
     */
    static class Underline extends ControlChar
    {
        /**
         * IRC control code.
         */
        public static final char CODE = '\u001F';

        /**
         * Constructor.
         */
        Underline()
        {
            super("u");
        }
    }

    /**
     * Control char representation for colored text.
     *
     * @author Danny van Heumen
     */
    static class ColorFormat extends ControlChar
    {
        /**
         * IRC control code.
         */
        public static final char CODE = '\u0003';

        /**
         * Foreground color.
         */
        private final Color foreground;

        /**
         * Background color.
         */
        private final Color background;

        /**
         * Constructor.
         *
         * @param foreground foreground color
         * @param background background color
         */
        ColorFormat(final Color foreground, final Color background)
        {
            super("font");
            this.foreground = foreground;
            this.background = background;
        }

        /**
         * Get HTML start tag with foreground and background color codes
         * embedded.
         *
         * @return Returns string containing html start tag including foreground
         *         and background colors.
         */
        public String getHtmlStart()
        {
            StringBuilder result = new StringBuilder("<");
            result.append(getTag());
            if (this.foreground != null)
            {
                result.append(" color=\"");
                result.append(this.foreground.getHtml());
                result.append("\"");
            }
            if (this.background != null)
            {
                result.append(" bgcolor=\"");
                result.append(this.background.getHtml());
                result.append("\"");
            }
            result.append('>');
            return result.toString();
        }
    }

    /**
     * Control char representation for the cancellation of all active formatting
     * options, i.e. return to normal.
     *
     * In the current implementation, you cannot instantiate this control char.
     * Its use is purely symbolic, since it doesn't actually translate in
     * additional HTML formatting tags.
     *
     * @author Danny van Heumen
     */
    abstract static class Normal extends ControlChar
    {
        /**
         * IRC control code.
         */
        public static final char CODE = '\u000F';

        /**
         * Private constructor since it should not be instantiated.
         */
        private Normal()
        {
            super(null);
        }
    }
}