com.objectxp.msg.smart
Class CLIIcon

java.lang.Object
  com.objectxp.msg.Message
      com.objectxp.msg.SmsMessage
          com.objectxp.msg.smart.SmartMessage
              com.objectxp.msg.smart.CLIIcon

All Implemented Interfaces:

MultiPartMessage, java.io.Serializable, java.lang.Cloneable

public class CLIIcon
extends SmartMessage

This class represents a Calling Line Identification Icon (CLI) also known as Caller Group Image for SmartMessaging enabled phones.

Example:

 ...
 SmsService service = new GsmSmsService();
 ...
 CLIIcon icon = new CLIIcon();
 java.awt.Image img = Toolkit.getDefaultToolkit().getImage("c:/tmp/friends.gif");
 icon.setCLIIcon(img);
 icon.setRecipient("+41791234567"); 
 service.sendMessage(icon);
 ...
 

See Also:

Serialized Form

Field Summary

static int	MAX_HEIGTH Maximum height of a Operator Logo (14 pixels)
static int	MAX_WIDTH Maximum width of a Operator Logo (72 pixels)

Fields inherited from class com.objectxp.msg.SmsMessage

CLASS_0, CLASS_1, CLASS_2, CLASS_3, DC_8BIT, DC_DEFAULT, DC_GROUP_DATA, DC_GROUP_GENERAL, DC_GROUP_MSG_WAITING_DISCARD, DC_GROUP_MSG_WAITING_STORE, DC_UCS2, INDICATION_ACTIVE, INDICATION_INACTIVE, INDICATION_TYPE_EMAIL, INDICATION_TYPE_FAX, INDICATION_TYPE_OTHER, INDICATION_TYPE_VOICEMAIL, NO_CLASS

Fields inherited from class com.objectxp.msg.Message

ACK_TIME, MT_BINARY, MT_STATUS, MT_TEXT, SENDER_TYPE_ALPHA, SENDER_TYPE_GUESS, SENDER_TYPE_NUMBER

Constructor Summary

CLIIcon()
Create a new Calling Line Identification Icon Picture Message.

CLIIcon(SmsService service)
Deprecated. since jSMS 1.7, use CLIIcon()

Method Summary

java.awt.Image	getImage() Transformes and returns the OTA image as Image object.
java.lang.String	getMessage() Get the Message (User Data) as String.
byte[]	getOtaImage()
byte[]	getUserData() Get the User Data of this message.
void	setCLIIcon(byte[] bytes) Set the image.
void	setCLIIcon(java.awt.Image img) Set the icon image.
java.lang.String	toString() Constructs a string representation of this Message

Methods inherited from class com.objectxp.msg.smart.SmartMessage

buildParts, buildParts, getParts

Methods inherited from class com.objectxp.msg.SmsMessage

containsUserDataHeader, copyFields, getAlphabet, getBytes, getCodingGroup, getDeferredDeliveryAsDate, getDeferredDeliveryInMinutes, getID, getIndicationState, getIndicationType, getMessageClass, getParent, getPID, getRecipient, getRecipientAddress, getSender, getSenderAddress, getType, getUserDataHeader, getValidityPeriodAsDate, getValidityPeriodInMinutes, hasDeferredDelivery, hasMessageClass, hasValidityPeriod, isCompressed, isMMS, isRejectDuplicates, isRelativeDeferredDelivery, isRelativeValidityPeriod, isReplyPath, requestStatusReport, requestStatusReport, setAlphabet, setCodingGroup, setCompression, setDeferredDelivery, setDeferredDelivery, setIndicationState, setIndicationType, setMessage, setMessage, setMessageClass, setMMS, setParent, setPID, setRecipient, setRecipientAddress, setRejectDuplicates, setReplyPath, setSender, setSenderAddress, setType, setUserData, setUserDataHeader, setUserDataHeader, setValidityPeriod, setValidityPeriod

Methods inherited from class com.objectxp.msg.Message

clone, getProperty, getSenderType, getTimestamp, setID, setProperty, setSenderType

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HEIGTH

public static final int MAX_HEIGTH

Maximum height of a Operator Logo (14 pixels)

See Also:

Constant Field Values

MAX_WIDTH

public static final int MAX_WIDTH

Maximum width of a Operator Logo (72 pixels)

See Also:

Constant Field Values

Constructor Detail

CLIIcon

public CLIIcon()
        throws java.lang.IllegalArgumentException

Create a new Calling Line Identification Icon Picture Message.

Throws:

java.lang.IllegalArgumentException - if the SmsService is null or has not yet been initialized.

CLIIcon

public CLIIcon(SmsService service)

Deprecated. since jSMS 1.7, use CLIIcon()

Create a new Calling Line Identification Icon Picture Message

Parameters:

service - the initialized SmsService used for sending the message

Method Detail

setCLIIcon

public void setCLIIcon(java.awt.Image img)

Set the icon image. The image has to be in the right size (14 pixel height and 72 pixels width). If the image is larger then this, it will be cropped to the maximum size (cropping will start at coordinate 0,0).
If the specified image contains colors or grayscales it will be converted to black and white. To get optimal results, it is strongly recommended to use only monochrome images.

Parameters:

img - a java.awt.Image representing the icon (e.g. GIF or JPEG)

setCLIIcon

public void setCLIIcon(byte[] bytes)

Set the image. The byte[] must represent a ota-image with 14 x 72 pixels and thus contain 130 bytes.

Parameters:

bytes - a byte array holding an OTA image.

getMessage

public java.lang.String getMessage()

Description copied from class: SmsMessage

Get the Message (User Data) as String.

Overrides:

getMessage in class SmsMessage

Returns:

the User Data converted to a String object.

See Also:

SmsMessage.getUserData()

getUserData

public byte[] getUserData()

Description copied from class: SmsMessage

Get the User Data of this message.

Overrides:

getUserData in class SmsMessage

Returns:

the user data or null if the message contains no user data

toString

public java.lang.String toString()

Description copied from class: Message

Constructs a string representation of this Message

Overrides:

toString in class SmsMessage

getImage

public java.awt.Image getImage()

Transformes and returns the OTA image as Image object.

Returns:

the OTA image as Image object

getOtaImage

public byte[] getOtaImage()

Returns:

the OTA image.