pl.mbdev.openstage
Class XmlText

java.lang.Object
  extended by pl.mbdev.openstage.Xml
      extended by pl.mbdev.openstage.XmlText
Direct Known Subclasses:
IppTextBox

public abstract class XmlText
extends Xml

Superclass of IppTextBox, and also used in IppTextField.

 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
protected static class XmlText.Password
          Possible settings for IppTextField or IppTextBox being a password.
static class XmlText.Uneditable
          Possible settings for the ability of the IppTextField or IppTextBox to be edited.
 
Field Summary
private  boolean isPassword
          If true, OpenStage device will treat the value of the text field/box as confidential, and try to obscure/hide it whenever possible.
private  boolean isUneditable
          Field/box value cannot be edited by the user, if true.
private  int maxSize
          Maximum length of the input, ignored if negative.
protected  java.lang.String text
          Used only when defaultValue is set to TEXT.
 
Constructor Summary
XmlText(java.lang.String nodeName, java.lang.String text, int maxSize, boolean isPassword, boolean isUneditable)
          Default constructor.
 
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

text

protected java.lang.String text
Used only when defaultValue is set to TEXT.


maxSize

private int maxSize
Maximum length of the input, ignored if negative.


isPassword

private boolean isPassword
If true, OpenStage device will treat the value of the text field/box as confidential, and try to obscure/hide it whenever possible.


isUneditable

private boolean isUneditable
Field/box value cannot be edited by the user, if true.

Constructor Detail

XmlText

public XmlText(java.lang.String nodeName,
               java.lang.String text,
               int maxSize,
               boolean isPassword,
               boolean isUneditable)
Default constructor.

Parameters:
nodeName - name of the text node
text - used only when defaultValue is set to TEXT
maxSize - maximum length of the input, ignored if negative
isPassword - if true, OpenStage device will treat the value of the field/box as confidential, and try to obscure/hide it whenever possible
isUneditable - field/box value cannot be edited by the user, if true
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