pl.mbdev.openstage
Class Option

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

public class Option
extends Xml

Options are added to the IppList. To be successfully added, Option must have as many OptionTexts as there are columns in the IppList.

 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 Option.Selected
          Defines possible Option selection states.
 
Field Summary
private  java.lang.String key
          Key from key-value pair, which is sent to the remote server.
private  int optionTextCount
          Number of option texts (see OptionText) present in this option.
private  boolean selected
          Indicates that this option is preselected.
private  java.lang.String value
          Value from key-value pair, which is sent to the remote server.
 
Constructor Summary
Option(Image image, boolean selected, java.lang.String key, java.lang.String value)
          Creates new option, initially without any OptionText.
Option(OptionText[] optionTexts, Image image, boolean selected, java.lang.String key, java.lang.String value)
          Creates new option with single or multiple OptionTexts, and with all other parameters available to set.
Option(OptionText optionText, Image image, boolean selected, java.lang.String key, java.lang.String value)
          Creates new option with a single OptionText.
Option(java.lang.String optionText, Image image, boolean selected, java.lang.String key, java.lang.String value)
          Creates new option with a single text inside.
 
Method Summary
 void add(OptionText ot)
          Adds a new OptionText to this option.
 void add(java.lang.String optionText)
          Adds a new option's text to this option.
protected  java.lang.StringBuffer attributesToXmlString()
          Should be overridden by classes that have some attributes.
 int getOptionTextCount()
          Returns the number of OptionTexts present in this Option.
 
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

selected

private final boolean selected
Indicates that this option is preselected.


key

private java.lang.String key
Key from key-value pair, which is sent to the remote server.


value

private java.lang.String value
Value from key-value pair, which is sent to the remote server.


optionTextCount

private int optionTextCount
Number of option texts (see OptionText) present in this option.

Constructor Detail

Option

public Option(Image image,
              boolean selected,
              java.lang.String key,
              java.lang.String value)
Creates new option, initially without any OptionText.

Parameters:
image - optional image for this IppList option
selected - if true, indicates that this option is preselected
key - key from key-value pair, which is sent to the remote server
value - value from key-value pair, which is sent to the remote server

Option

public Option(java.lang.String optionText,
              Image image,
              boolean selected,
              java.lang.String key,
              java.lang.String value)
Creates new option with a single text inside.

Parameters:
optionText - the text for this option
image - optional image for this IppList option
selected - if true, indicates that this option is preselected
key - key from key-value pair, which is sent to the remote server
value - value from key-value pair, which is sent to the remote server

Option

public Option(OptionText optionText,
              Image image,
              boolean selected,
              java.lang.String key,
              java.lang.String value)
Creates new option with a single OptionText.

Parameters:
optionText - the text for this option, OptionText
image - optional image for this IppList option
selected - if true, indicates that this option is preselected
key - key from key-value pair, which is sent to the remote server
value - value from key-value pair, which is sent to the remote server

Option

public Option(OptionText[] optionTexts,
              Image image,
              boolean selected,
              java.lang.String key,
              java.lang.String value)
Creates new option with single or multiple OptionTexts, and with all other parameters available to set.

Parameters:
optionTexts - array of OptionText objects, from 1 to 3 option texts
image - optional image for this IppList option
selected - if true, indicates that this option is preselected
key - key from key-value pair, which is sent to the remote server
value - value from key-value pair, which is sent to the remote server
Method Detail

add

public void add(OptionText ot)
Adds a new OptionText to this option.

Parameters:
ot - option's text, OptionText

add

public void add(java.lang.String optionText)
Adds a new option's text to this option.

Parameters:
optionText - option's text, a string of characters

getOptionTextCount

public int getOptionTextCount()
Returns the number of OptionTexts present in this Option.

Returns:
OptionText object count of this Option

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