|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rfid.premises.app.entities.AbstractXmlObject
com.ibm.rfid.premises.app.entities.supplychain.printing.FormData
public class FormData
A form data represents configurable parameters for a physical label in a print job.
For instance, a custom
print template may allow for company's name to be printed
on the physical label. A possible FormData could be defined as
name = "Company Name"
and
value = "International Business
Machines". These FormData pairs are particular to a print template. For
instance, the previous example of a FormData may work for one template and
not another. It is completely dependent upon the properties of the print template.
For more information on these customizable properties, please see your printer
manufacturer's documention on how to create customized print templates, or "labels".
FormData objects are contained within
the Label
object and the LabelList
object.
When under a LabelList, the FormData becomes a default FormData for all Label Objects under LabelList.
Label
,
LabelList
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_FORM_DATA
xml tag name used to represent a default FormData found within a LabelList |
static java.lang.String |
FORM_DATA
xml tag name used to represent a FormData found within a Label |
Fields inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject |
---|
attributes_, EQ, GT, LT, QUOTE, SLASH, tagName_, XML_START |
Constructor Summary | |
---|---|
FormData()
Basic Constructor |
|
FormData(java.lang.String xml)
Constructor that creates a FormData object based on the xml String parameter. |
|
FormData(java.lang.String xml,
boolean isDefault)
Constructor that creates a FormData object based on the xml String parameter. |
Method Summary | |
---|---|
java.lang.String |
getName()
Gets the name of the FormData |
java.lang.String |
getValue()
Gets the value for this FormData |
void |
setDefault(boolean isDefault)
This function is only used by LabelList to denote whether a FormData object should be a default FormData. |
void |
setName(java.lang.String s)
Sets the name of the FormData |
void |
setValue(java.lang.String s)
Sets the new value for the FormData |
java.lang.String |
toXmlString(boolean isTop)
(non-Javadoc) |
Methods inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject |
---|
getEndTag, getNodeListFromString, getStartTag, getStringFromElement |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FORM_DATA
Label
public static final java.lang.String DEFAULT_FORM_DATA
LabelList
Constructor Detail |
---|
public FormData()
public FormData(java.lang.String xml)
xml
- is an XML String representation of an
FormData object.isDefault
- public FormData(java.lang.String xml, boolean isDefault)
xml
- is an XML String representation of an
FormData object.isDefault
- Method Detail |
---|
public void setName(java.lang.String s)
s
- the name of this FormDatapublic java.lang.String getName()
public void setValue(java.lang.String s)
s
- the new Value for this FormDatapublic java.lang.String getValue()
public void setDefault(boolean isDefault)
isDefault
- boolean is this FormData is a defaultLabelList.addDefaultFormData(FormData)
public java.lang.String toXmlString(boolean isTop)
toXmlString
in class AbstractXmlObject
isTop
- decides whether or not the XML_START
field is appended to the output of this method. Should
be true if this AbstractXmlObject is the root element.
AbstractXmlObject.toXmlString(boolean)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |