|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpl.mbdev.openstage.Xml
pl.mbdev.openstage.IppScreen
public class IppScreen
Sub-node of IppDisplay
object. The IppDisplay may contain up to 5 IppScreens.
IppScreen cannot be a root node, but this SDK will wrap IppScreen with IppPhone
and IppDisplay if the attempt to send only IppScreen is made.
Also please notice that IppScreen must have one of the sub-nodes provided below, and
can have only one of them: IppAlert
, IppList
, IppTextBox
,
IppForm
or IppPlayer
.
There are no restrictions on other elements. This SDK will automatically prevent adding
of too many objects to the screen and will inform about possible errors.
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.
Field Summary | |
---|---|
private int |
commandCount
Number of commands currently present in this screen. |
private boolean |
hasUniqueElement
Indicates that this IppScreen has as a child an element which prevents other unique elements to be added. |
private int |
hiddenCount
Number of hidden fields currently present in this screen. |
private java.lang.Integer |
id
ID of this screen. |
private int |
uniqueIndex
Index of the unique element on the list of sub-nodes. |
Constructor Summary | |
---|---|
IppScreen(java.lang.Integer id)
Creates a new IppScreen. |
Method Summary | |
---|---|
void |
add(IppAction a)
Adds a new IppAction to this screen. |
Xml |
add(IppAlert al)
Adds a new IppAlert to this screen, remember that the screen can have only
one alert, and cannot have any other IppList , IppTextBox ,
IppPlayer or IppForm if it has an alert. |
void |
add(IppCommand c)
Adds a new IppCommand to this screen. |
Xml |
add(IppForm f)
Adds the provided IppForm to this IppScreen, remember that the screen can
have only one form, and cannot have any other IppAlert , IppList ,
IppTextBox or IppPlayer if it has a form. |
void |
add(IppHidden h)
Adds a new IppHidden to this screen. |
void |
add(IppKey k)
Adds a new IppKey to this screen. |
Xml |
add(IppList l)
Adds a new IppList to this screen, remember that the screen can have only
one list, and cannot have any other IppAlert , IppTextBox ,
IppPlayer or IppForm if it has a list. |
Xml |
add(IppPlayer pl)
Adds a new IppPlayer to this screen, remember that the screen can have only
one player, and cannot have any other IppList , IppTextBox ,
IppAlert or IppForm if it has a player. |
Xml |
add(IppTextBox t)
Adds a new IppTextBox to this screen, remember that the screen can have only
one text box, and cannot have any other IppAlert , IppList ,
IppPlayer or IppForm if it has a text box. |
void |
add(IppTicker ti)
Adds a new IppTicker to this screen. |
private Xml |
addUnique(Xml o)
Adds an element to this screen's sub-nodes, which is supposed to be unique. |
protected java.lang.StringBuffer |
attributesToXmlString()
Should be overridden by classes that have some attributes. |
protected java.lang.StringBuffer |
subObjectsToXmlString(int indent)
Goes through every sub-object of this object, creates its XML-text representation, and returns all of them in a single StringBuffer. |
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, toXmlString, wrapWithIppItem |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.Integer id
private int hiddenCount
private int commandCount
private boolean hasUniqueElement
private int uniqueIndex
Constructor Detail |
---|
public IppScreen(java.lang.Integer id)
IppDisplay
can have up to five
IppScreens.
id
- ID of this screen, it should be a positive integerMethod Detail |
---|
public void add(IppCommand c)
IppCommand
to this screen.
c
- command, IppCommandpublic void add(IppHidden h)
IppHidden
to this screen.
h
- hidden data, IppHiddenpublic void add(IppKey k)
IppKey
to this screen.
k
- key, IppKeypublic void add(IppAction a)
IppAction
to this screen.
a
- action, IppActionpublic void add(IppTicker ti)
IppTicker
to this screen.
ti
- ticker, IppTickerpublic Xml add(IppAlert al)
IppAlert
to this screen, remember that the screen can have only
one alert, and cannot have any other IppList
, IppTextBox
,
IppPlayer
or IppForm
if it has an alert.
al
- alert, IppAlert
public Xml add(IppList l)
IppList
to this screen, remember that the screen can have only
one list, and cannot have any other IppAlert
, IppTextBox
,
IppPlayer
or IppForm
if it has a list.
l
- list, IppList
public Xml add(IppTextBox t)
IppTextBox
to this screen, remember that the screen can have only
one text box, and cannot have any other IppAlert
, IppList
,
IppPlayer
or IppForm
if it has a text box.
t
- text box, IppTextBox
public Xml add(IppPlayer pl)
IppPlayer
to this screen, remember that the screen can have only
one player, and cannot have any other IppList
, IppTextBox
,
IppAlert
or IppForm
if it has a player.
pl
- player, IppPlayer
public Xml add(IppForm f)
IppForm
to this IppScreen, remember that the screen can
have only one form, and cannot have any other IppAlert
, IppList
,
IppTextBox
or IppPlayer
if it has a form.
f
- form, IppForm
private Xml addUnique(Xml o)
o
- element which is supposed to be unique; one of the following:
IppList
, IppTextBox
, IppAlert
, IppPlayer
or IppForm
protected java.lang.StringBuffer subObjectsToXmlString(int indent)
Xml
subObjectsToXmlString
in class Xml
indent
- indent of the output of this function, done by tab character
protected java.lang.StringBuffer attributesToXmlString()
Xml
attributesToXmlString
in class Xml
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |