cisco.uc.cuae.legacy
Class CiscoIpPhone.AddIconItemOptions

java.lang.Object
  cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CiscoIpPhone

public static class CiscoIpPhone.AddIconItemOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	data use: optional; allowMultiple: false; The image data to be displayed.
java.lang.Short	depth use: optional; allowMultiple: false; The color depth of the image.
java.lang.Short	height use: optional; allowMultiple: false; The height of the icon (in pixels).
java.lang.Short	index use: optional; allowMultiple: false; The index of the icon.
java.lang.String	uRL use: optional; allowMultiple: false; The URL of the PNG image to display.
java.lang.Short	width use: optional; allowMultiple: false; The width of the icon (in pixels).
java.lang.String	xmlObject

Constructor Summary

CiscoIpPhone.AddIconItemOptions()
Constructs the AddIconItemOptions.

CiscoIpPhone.AddIconItemOptions(java.lang.Short index, java.lang.Short height, java.lang.Short width, java.lang.Short depth, java.lang.String data, java.lang.String uRL, java.lang.String xmlObject)
Constructs the AddIconItemOptions.

Method Summary

java.lang.String	getData() Gets the value.
java.lang.Short	getDepth() Gets the value.
java.lang.Short	getHeight() Gets the value.
java.lang.Short	getIndex() Gets the value.
java.lang.String	getURL() Gets the value.
java.lang.Short	getWidth() Gets the value.
java.lang.String	getXmlObject() Gets the value.
void	setData(java.lang.String value) Sets the value.
void	setDepth(java.lang.Short value) Sets the value.
void	setHeight(java.lang.Short value) Sets the value.
void	setIndex(java.lang.Short value) Sets the value.
void	setURL(java.lang.String value) Sets the value.
void	setWidth(java.lang.Short value) Sets the value.
void	setXmlObject(java.lang.String value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

index

public java.lang.Short index

use: optional; allowMultiple: false; The index of the icon.

height

public java.lang.Short height

use: optional; allowMultiple: false; The height of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

width

public java.lang.Short width

use: optional; allowMultiple: false; The width of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

depth

public java.lang.Short depth

use: optional; allowMultiple: false; The color depth of the image. This value should only be specified if one is saving the ResultData to IconMenu.

data

public java.lang.String data

use: optional; allowMultiple: false; The image data to be displayed. There are no utilities to help format this data. Refer to the Cisco IP Phone Developer documentation. This value should only be specified if one is saving the ResultData to IconMenu.

uRL

public java.lang.String uRL

use: optional; allowMultiple: false; The URL of the PNG image to display. This URL must be accessible to the phone. This value should only be specified if one is saving the ResultData to IconFileMenu.

xmlObject

public java.lang.String xmlObject

Constructor Detail

CiscoIpPhone.AddIconItemOptions

public CiscoIpPhone.AddIconItemOptions()

Constructs the AddIconItemOptions. Don't init any fields.

CiscoIpPhone.AddIconItemOptions

public CiscoIpPhone.AddIconItemOptions(java.lang.Short index,
                                       java.lang.Short height,
                                       java.lang.Short width,
                                       java.lang.Short depth,
                                       java.lang.String data,
                                       java.lang.String uRL,
                                       java.lang.String xmlObject)

Constructs the AddIconItemOptions.

Parameters:

index - use: optional; allowMultiple: false; index The index of the icon.

height - use: optional; allowMultiple: false; height The height of the icon (in pixels). This value should only be specified height if one is saving the ResultData to IconMenu.

width - use: optional; allowMultiple: false; width The width of the icon (in pixels). This value should only be specified width if one is saving the ResultData to IconMenu.

depth - use: optional; allowMultiple: false; depth The color depth of the image. This value should only be specified if one depth is saving the ResultData to IconMenu.

data - use: optional; allowMultiple: false; data The image data to be displayed. There are no utilities to help format data this data. Refer to the Cisco IP Phone Developer documentation. This value data should only be specified if one is saving the ResultData to data IconMenu.

uRL - use: optional; allowMultiple: false; uRL The URL of the PNG image to display. This URL must be accessible to the uRL phone. This value should only be specified if one is saving the ResultData uRL to IconFileMenu.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIndex

public java.lang.Short getIndex()

Gets the value. use: optional; allowMultiple: false; The index of the icon.

Returns:

the value.

setIndex

public void setIndex(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The index of the icon.

Parameters:

value - the value.

getHeight

public java.lang.Short getHeight()

Gets the value. use: optional; allowMultiple: false; The height of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

Returns:

the value.

setHeight

public void setHeight(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The height of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

Parameters:

value - the value.

getWidth

public java.lang.Short getWidth()

Gets the value. use: optional; allowMultiple: false; The width of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

Returns:

the value.

setWidth

public void setWidth(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The width of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu.

Parameters:

value - the value.

getDepth

public java.lang.Short getDepth()

Gets the value. use: optional; allowMultiple: false; The color depth of the image. This value should only be specified if one is saving the ResultData to IconMenu.

Returns:

the value.

setDepth

public void setDepth(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The color depth of the image. This value should only be specified if one is saving the ResultData to IconMenu.

Parameters:

value - the value.

getData

public java.lang.String getData()

Gets the value. use: optional; allowMultiple: false; The image data to be displayed. There are no utilities to help format this data. Refer to the Cisco IP Phone Developer documentation. This value should only be specified if one is saving the ResultData to IconMenu.

Returns:

the value.

setData

public void setData(java.lang.String value)

Sets the value. use: optional; allowMultiple: false; The image data to be displayed. There are no utilities to help format this data. Refer to the Cisco IP Phone Developer documentation. This value should only be specified if one is saving the ResultData to IconMenu.

Parameters:

value - the value.

getURL

public java.lang.String getURL()

Gets the value. use: optional; allowMultiple: false; The URL of the PNG image to display. This URL must be accessible to the phone. This value should only be specified if one is saving the ResultData to IconFileMenu.

Returns:

the value.

setURL

public void setURL(java.lang.String value)

Sets the value. use: optional; allowMultiple: false; The URL of the PNG image to display. This URL must be accessible to the phone. This value should only be specified if one is saving the ResultData to IconFileMenu.

Parameters:

value - the value.

getXmlObject

public java.lang.String getXmlObject()

Gets the value.

Returns:

the value.

setXmlObject

public void setXmlObject(java.lang.String value)

Sets the value.

Parameters:

value - the value.