cisco.uc.cuae.legacy
Class CiscoIpPhone.AddMenuItemOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CiscoIpPhone

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

See Also:

Serialized Form

Field Summary

java.lang.Boolean	formatURL use: optional; allowMultiple: false; Indicates that URL format validation should be performed on the URL specified.
java.lang.Short	iconIndex use: optional; allowMultiple: false; An index into the list of icon items to indicate which icon should be shown next to this menu item.
java.lang.String	name use: optional; allowMultiple: false; The name of the menu item.
java.lang.Short	touchAreaX1 use: optional; allowMultiple: false; The left side of the touch area associated with this menu item.
java.lang.Short	touchAreaX2 use: optional; allowMultiple: false; The right side of the touch area associated with this menu item.
java.lang.Short	touchAreaY1 use: optional; allowMultiple: false; The top side of the touch area associated with this menu item.
java.lang.Short	touchAreaY2 use: optional; allowMultiple: false; The bottom side of the touch area associated with this menu item.
java.lang.String	uRL use: optional; allowMultiple: false; The URL that the phone will request if this menu item is selected.
java.lang.String	xmlObject

Constructor Summary

CiscoIpPhone.AddMenuItemOptions()
Constructs the AddMenuItemOptions.

CiscoIpPhone.AddMenuItemOptions(java.lang.Short iconIndex, java.lang.String name, java.lang.String uRL, java.lang.Boolean formatURL, java.lang.Short touchAreaX1, java.lang.Short touchAreaX2, java.lang.Short touchAreaY1, java.lang.Short touchAreaY2, java.lang.String xmlObject)
Constructs the AddMenuItemOptions.

Method Summary

java.lang.Boolean	getFormatURL() Gets the value.
java.lang.Short	getIconIndex() Gets the value.
java.lang.String	getName() Gets the value.
java.lang.Short	getTouchAreaX1() Gets the value.
java.lang.Short	getTouchAreaX2() Gets the value.
java.lang.Short	getTouchAreaY1() Gets the value.
java.lang.Short	getTouchAreaY2() Gets the value.
java.lang.String	getURL() Gets the value.
java.lang.String	getXmlObject() Gets the value.
void	setFormatURL(java.lang.Boolean value) Sets the value.
void	setIconIndex(java.lang.Short value) Sets the value.
void	setName(java.lang.String value) Sets the value.
void	setTouchAreaX1(java.lang.Short value) Sets the value.
void	setTouchAreaX2(java.lang.Short value) Sets the value.
void	setTouchAreaY1(java.lang.Short value) Sets the value.
void	setTouchAreaY2(java.lang.Short value) Sets the value.
void	setURL(java.lang.String 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

iconIndex

public java.lang.Short iconIndex

use: optional; allowMultiple: false; An index into the list of icon items to indicate which icon should be shown next to this menu item. This field is valid only when used with a IconMenu or IconFileMenu XML object.

name

public java.lang.String name

use: optional; allowMultiple: false; The name of the menu item. This field is displayed with a menu or an icon menu XML object. With a graphic menu or graphic file menu, it is used as the title of the subsequent XML screen if the item is selected and if the subsequent screen does not specify a title. This field is valid with Menu, IconMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

uRL

public java.lang.String uRL

use: optional; allowMultiple: false; The URL that the phone will request if this menu item is selected. This field is valid with Menu, IconMenu, IconFileMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

formatURL

public java.lang.Boolean formatURL

use: optional; allowMultiple: false; Indicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL.

touchAreaX1

public java.lang.Short touchAreaX1

use: optional; allowMultiple: false; The left side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

touchAreaX2

public java.lang.Short touchAreaX2

use: optional; allowMultiple: false; The right side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

touchAreaY1

public java.lang.Short touchAreaY1

use: optional; allowMultiple: false; The top side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

touchAreaY2

public java.lang.Short touchAreaY2

use: optional; allowMultiple: false; The bottom side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

xmlObject

public java.lang.String xmlObject

Constructor Detail

CiscoIpPhone.AddMenuItemOptions

public CiscoIpPhone.AddMenuItemOptions()

Constructs the AddMenuItemOptions. Don't init any fields.

CiscoIpPhone.AddMenuItemOptions

public CiscoIpPhone.AddMenuItemOptions(java.lang.Short iconIndex,
                                       java.lang.String name,
                                       java.lang.String uRL,
                                       java.lang.Boolean formatURL,
                                       java.lang.Short touchAreaX1,
                                       java.lang.Short touchAreaX2,
                                       java.lang.Short touchAreaY1,
                                       java.lang.Short touchAreaY2,
                                       java.lang.String xmlObject)

Constructs the AddMenuItemOptions.

Parameters:

iconIndex - use: optional; allowMultiple: false; iconIndex An index into the list of icon items to indicate which icon should be shown iconIndex next to this menu item. This field is valid only when used with a IconMenu iconIndex or IconFileMenu XML object.

name - use: optional; allowMultiple: false; name The name of the menu item. This field is displayed with a menu or an icon name menu XML object. With a graphic menu or graphic file menu, it is used name as the title of the subsequent XML screen if the item is selected and if name the subsequent screen does not specify a title. This field is valid with name Menu, IconMenu, IconFileMenu, GraphicMenu, name and GraphicFileMenu.

uRL - use: optional; allowMultiple: false; uRL The URL that the phone will request if this menu item is selected. This uRL field is valid with Menu, IconMenu, IconFileMenu, uRL IconFileMenu, GraphicMenu, and GraphicFileMenu.

formatURL - use: optional; allowMultiple: false; formatURL Indicates that URL format validation should be performed on the URL specified. formatURL This may involve modifications being made to the URL.

touchAreaX1 - use: optional; allowMultiple: false; touchAreaX1 The left side of the touch area associated with this menu item. This field touchAreaX1 is valid only when used with a GraphicFileMenu XML object touchAreaX1 and with phones that have touch-sensitive displays (in pixels).

touchAreaX2 - use: optional; allowMultiple: false; touchAreaX2 The right side of the touch area associated with this menu item. This touchAreaX2 field is valid only when used with a GraphicFileMenu XML object touchAreaX2 and with phones that have touch-sensitive displays (in pixels).

touchAreaY1 - use: optional; allowMultiple: false; touchAreaY1 The top side of the touch area associated with this menu item. This field touchAreaY1 is valid only when used with a GraphicFileMenu XML object touchAreaY1 and with phones that have touch-sensitive displays (in pixels).

touchAreaY2 - use: optional; allowMultiple: false; touchAreaY2 The bottom side of the touch area associated with this menu item. This touchAreaY2 field is valid only when used with a GraphicFileMenu XML object touchAreaY2 and with phones that have touch-sensitive displays (in pixels).

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIconIndex

public java.lang.Short getIconIndex()

Gets the value. use: optional; allowMultiple: false; An index into the list of icon items to indicate which icon should be shown next to this menu item. This field is valid only when used with a IconMenu or IconFileMenu XML object.

Returns:

the value.

setIconIndex

public void setIconIndex(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; An index into the list of icon items to indicate which icon should be shown next to this menu item. This field is valid only when used with a IconMenu or IconFileMenu XML object.

Parameters:

value - the value.

getName

public java.lang.String getName()

Gets the value. use: optional; allowMultiple: false; The name of the menu item. This field is displayed with a menu or an icon menu XML object. With a graphic menu or graphic file menu, it is used as the title of the subsequent XML screen if the item is selected and if the subsequent screen does not specify a title. This field is valid with Menu, IconMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

Returns:

the value.

setName

public void setName(java.lang.String value)

Sets the value. use: optional; allowMultiple: false; The name of the menu item. This field is displayed with a menu or an icon menu XML object. With a graphic menu or graphic file menu, it is used as the title of the subsequent XML screen if the item is selected and if the subsequent screen does not specify a title. This field is valid with Menu, IconMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

Parameters:

value - the value.

getURL

public java.lang.String getURL()

Gets the value. use: optional; allowMultiple: false; The URL that the phone will request if this menu item is selected. This field is valid with Menu, IconMenu, IconFileMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

Returns:

the value.

setURL

public void setURL(java.lang.String value)

Sets the value. use: optional; allowMultiple: false; The URL that the phone will request if this menu item is selected. This field is valid with Menu, IconMenu, IconFileMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu.

Parameters:

value - the value.

getFormatURL

public java.lang.Boolean getFormatURL()

Gets the value. use: optional; allowMultiple: false; Indicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL.

Returns:

the value.

setFormatURL

public void setFormatURL(java.lang.Boolean value)

Sets the value. use: optional; allowMultiple: false; Indicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL.

Parameters:

value - the value.

getTouchAreaX1

public java.lang.Short getTouchAreaX1()

Gets the value. use: optional; allowMultiple: false; The left side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Returns:

the value.

setTouchAreaX1

public void setTouchAreaX1(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The left side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Parameters:

value - the value.

getTouchAreaX2

public java.lang.Short getTouchAreaX2()

Gets the value. use: optional; allowMultiple: false; The right side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Returns:

the value.

setTouchAreaX2

public void setTouchAreaX2(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The right side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Parameters:

value - the value.

getTouchAreaY1

public java.lang.Short getTouchAreaY1()

Gets the value. use: optional; allowMultiple: false; The top side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Returns:

the value.

setTouchAreaY1

public void setTouchAreaY1(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The top side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Parameters:

value - the value.

getTouchAreaY2

public java.lang.Short getTouchAreaY2()

Gets the value. use: optional; allowMultiple: false; The bottom side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

Returns:

the value.

setTouchAreaY2

public void setTouchAreaY2(java.lang.Short value)

Sets the value. use: optional; allowMultiple: false; The bottom side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels).

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.