aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/gui/utils/Smiley.java
blob: 955a4758d07168de25512e07f64e69b7c91d3f4a (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
/*
 * SIP Communicator, 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.gui.utils;

import java.net.*;

import net.java.sip.communicator.impl.gui.*;
import net.java.sip.communicator.service.resources.*;

/**
 * The <tt>Smiley</tt> is used to store a smiley.
 * 
 * @author Yana Stamcheva
 */
public class Smiley {

    private ImageID imageID;

    private String[] smileyStrings;

    /**
     * Creates an instance of <tt>Smily</tt>, by specifying the smily
     * image identifier and the strings corresponding to it.
     * @param imageID The image identifier of the smily icon.
     * @param smileyStrings A set of strings corresponding to the smily
     * icon.
     */
    public Smiley(ImageID imageID, String[] smileyStrings) {

        this.imageID = imageID;

        this.setSmileyStrings(smileyStrings);
    }

    /**
     * Returns the set of Strings corresponding to this smily.
     * @return the set of Strings corresponding to this smily.
     */
    public String[] getSmileyStrings() {

        return smileyStrings;
    }

    /**
     * Sets the set of Strings corresponding to this smily. They could be
     * ":-)", ":)", ":))" for example.
     * @param smileyStrings the set of Strings corresponding to this smily.
     */
    public void setSmileyStrings(String[] smileyStrings) {

        this.smileyStrings = smileyStrings;
    }

    /**
     * Returns the default String corresponding for this smily. For example
     * ":-)".
     * @return the default String corresponding for this smily.
     */
    public String getDefaultString() {

        return this.smileyStrings[0];
    }

    /**
     * Returns the identifier of the image corresponding to this smily. 
     * @return the identifier of the image corresponding to this smily.
     */
    public ImageID getImageID() {

        return this.imageID;
    }

    /**
     * Returns the path of the image corresponding to this smily.
     * @return the path of the image corresponding to this smily.
     */
    public String getImagePath() 
    {
        URL url = GuiActivator.getResources().
            getImageURL(this.getImageID().getId());
        
        if(url == null)
            return null;
        
        return url.toString();
    }
}