pl.mbdev.openstage
Class IppDisplay

java.lang.Object
  extended by pl.mbdev.openstage.Xml
      extended by pl.mbdev.openstage.IppDisplay

public class IppDisplay
extends Xml

Definition of IppDisplay, required sub-node of IppPhone. It may also be used as a optional root according to the programmer's guide, but it is highly recommended to use IppPhone as a root. This SDK will automatically wrap the IppDisplay with IppPhone if the attempt to send IppDisplay shall occur - via sendTo() method inherited from Xml.

 Copyright 2011 Mateusz Bysiek,
     mb@mbdev.pl, http://mbdev.pl/
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 

Author:
Mateusz Bysiek

Field Summary
private  java.lang.Integer initialScreen
          ID of the initial IppScreen in this IppDisplay.
private  int updateScreen
          Optional ID of another screen that will be updated in the background.
 
Constructor Summary
IppDisplay(java.lang.Integer initialScreen, int updateScreen)
          Creates new, empty IppDisplay object.
 
Method Summary
 void add(IppScreen s)
          Adds the provided IppScreen to this IppDisplay
protected  java.lang.StringBuffer attributesToXmlString()
          Should be overridden by classes that have some attributes.
 
Methods inherited from class pl.mbdev.openstage.Xml
add, add, addAndReturn, attributeToXml, firstAttributesToXmlString, getContents, getLogicalRoot, getParent, getSubNode, getSubNodeIndex, getSubNodes, getXmlHeader, isEmpty, logicalAdd, sendTo, setContents, setParent, subObjectsCount, subObjectsToXmlString, toXmlString, wrapWithIppItem
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

initialScreen

private java.lang.Integer initialScreen
ID of the initial IppScreen in this IppDisplay.


updateScreen

private int updateScreen
Optional ID of another screen that will be updated in the background.

Constructor Detail

IppDisplay

public IppDisplay(java.lang.Integer initialScreen,
                  int updateScreen)
Creates new, empty IppDisplay object.

Parameters:
initialScreen - ID of the initial IppScreen in this IppDisplay
updateScreen - Optional ID of another screen that will be updated in the background
Method Detail

add

public void add(IppScreen s)
Adds the provided IppScreen to this IppDisplay

Parameters:
s - screen, IppScreen

attributesToXmlString

protected java.lang.StringBuffer attributesToXmlString()
Description copied from class: Xml
Should be overridden by classes that have some attributes.

Overrides:
attributesToXmlString in class Xml
Returns:
XML-text containing all attributes of the object