pl.mbdev.openstage
Class IppAlert

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

public class IppAlert
extends Xml

Used to display alerts to the user and after the alert is sent away, user can see normal content of the IppScreen.

 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

Nested Class Summary
static class IppAlert.Type
          Possible kinds of alerts (see IppAlert) are defined here.
 
Field Summary
private  java.lang.Integer delay
          Delay in milliseconds, or, if null, delay is set to FOREVER.
private  IppAlert.Type type
          Type of alert, value from IppAlert.Type.
 
Constructor Summary
IppAlert(java.lang.String title, java.lang.String text)
          Constructs new information alert, it has type IppAlert.Type.INFO.
IppAlert(java.lang.String title, java.lang.String url, java.lang.String text, IppPhoneNumber phoneNumber, Image image, IppAlert.Type type, java.lang.Integer delay)
          Constructs IppAlert with all options available to set.
 
Method Summary
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

type

private IppAlert.Type type
Type of alert, value from IppAlert.Type.


delay

private java.lang.Integer delay
Delay in milliseconds, or, if null, delay is set to FOREVER.

Constructor Detail

IppAlert

public IppAlert(java.lang.String title,
                java.lang.String text)
Constructs new information alert, it has type IppAlert.Type.INFO.

Parameters:
title - title of this alert
text - text

IppAlert

public IppAlert(java.lang.String title,
                java.lang.String url,
                java.lang.String text,
                IppPhoneNumber phoneNumber,
                Image image,
                IppAlert.Type type,
                java.lang.Integer delay)
Constructs IppAlert with all options available to set.

Parameters:
title - title of this alert
url - address used when a custom command is used to dismiss an alert, and only if that command has type that causes communication with the server
text - text
phoneNumber - phone number
image - custom image for this alert
type - type of alert, value from IppAlert.Type
delay - delay in milliseconds, or, if null, delay is set to FOREVER
Method Detail

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