Package pl.mbdev.openstage

This package contains definitions of UI (user interface) objects recognised by OpenStage VoIP phones.

See:
          Description

Class Summary
Image Shows an image on the screen of phone.
IppAction Entity used to perform an action on OpenStage phone.
IppAlert Used to display alerts to the user and after the alert is sent away, user can see normal content of the IppScreen.
IppButton Can be added to IppForm.
IppChoiceGroup Choice element, which can be added to IppForm, and is similar to the IppList.
IppCommand Allows user's interaction with many aspects of the OpenStage phone.
IppDateField A field with a date and time that can be added to IppForm.
IppDisplay Definition of IppDisplay, required sub-node of IppPhone.
IppForm Important type of XML object, used to send user-created data from the OpenStage phone to the external server.
IppGauge Automated or user editable gauge, which can be added to IppForm.
IppHidden Can store key-value pairs that are sent to the server when an IppCommand of type IppCommand.Type.SELECT is used.
IppImageItem Item with an image that can be added to IppForm.
IppItem Used to attach IppCommands to single entries of the IppForm.
IppKey Element that allows direct input of the pressed keys values to the remote server.
IppList Used to create lists of elements, one or more of which then can be selected, according to the list type.
IppPhone Recommended, and one of two possible root nodes of a XML application.
IppPhoneNumber Enables translation of a phone number stored in a local phone book of OpenStage.
IppPlayer Player is designed for applications that involve audio streaming.
IppScreen Sub-node of IppDisplay object.
IppSpacer Separates two consecutive entries of the IppForm with a blank, empty line.
IppStringItem This simple item can be added to IppForm, and consists of single line of static text with two columns.
IppTextBox Multi-line box with editable text, which is similar to IppTextField, but can be added directly to IppScreen and cannot be added to IppForm.
IppTextField Can be added to IppForm and is in appearance similar to IppStringItem, but IppTextField can be edited.
IppTicker Ticker is a piece of text, which is displayed underneath the title bar and moves from right to left across the display.
Option Options are added to the IppList.
OptionText Text field of the Option of the IppList.
Xml General definition of an XML object that represents the common part of all XML entities used by OpenStage 60/80 VoIP phones, according to the "OpenStage 60/80 - XML Applications, Developer's Guide" available in September 2011.
XmlDate Defines the date and time formats used by the OpenStage phones.
XmlFormItem Abstract parent of all form items, all of which can be wrapped with IppItem to associate command with them.
XmlText Superclass of IppTextBox, and also used in IppTextField.
XmlWithKey A superclass of various objects that have a key attribute.
 

Enum Summary
IppAction.Type Defines types of IppAction.
IppAlert.Type Possible kinds of alerts (see IppAlert) are defined here.
IppButton.Type Defines possible types of the IppButton.
IppChoiceGroup.Type Defines possible types of the IppChoiceGroup.
IppCommand.Default Possible values of a field that indicates whether this command will be a default command in the context menu.
IppCommand.DisplayOn Defines places where the IppCommand will be displayed.
IppCommand.Select For commands added to implicit IppList Possible valued of a field that indicates whether the command is selected by default or not.
IppCommand.Type Available types of the IppCommand.
IppDateField.Default Defines the possible kinds of default values of the IppDateField.
IppDateField.Mode Defines possible modes of an IppDateField.
IppForm.Proportion Available values of proportion parameter in the constructor of IppForm, they define proportions between left and right column of the form.
IppGauge.Interactive Defines types of IppGauge in the context of it being interactive.
IppHidden.Type Defines possible types of values.
IppKey.BufferKeys Setting of buffering of input of the IppKey element.
IppKey.Keypad Keypad key presses may be ignored or not, while IppKey element is present on the screen.
IppKey.SendKeys The input from IppKey element may be sent to the remote server or not.
IppList.Type Defines possible types of IppList.
IppPhoneNumber.ImageType Defines possible types of images attached to a IppPhoneNumber.
IppPhoneNumber.NumberType Defines possible options of how to display a number attached to a IppPhoneNumber.
IppPlayer.Mode Defines possible modes of the IppPlayer.
IppPlayer.State Defines possible states of the IppPlayer.
IppSpacer.NewLine As of September 2011, unused.
IppTextBox.Constraint Defines kinds of IppTextBox input.
IppTextBox.DefaultValue Defined possible kinds of default value for IppTextBox objects.
IppTextField.Constraint Narrows the set of possible characters of the IppTextField, and sometimes changes the method by which they are entered.
IppTextField.DefaultValue Possible kinds of default values of IppTextField.
Option.Selected Defines possible Option selection states.
XmlText.Password Possible settings for IppTextField or IppTextBox being a password.
XmlText.Uneditable Possible settings for the ability of the IppTextField or IppTextBox to be edited.
 

Package pl.mbdev.openstage Description

This package contains definitions of UI (user interface) objects recognised by OpenStage VoIP phones. The objects are made according to "OpenStage 60/80 - XML Applications, Developer's Guide" available in September 2011. Features of these devices are currently partially developed, therefore the documentation of the objects will sometimes simply say "in development". Changes are to be expected in the future.