com.waveset.object
Class ResultFieldDisplay

java.lang.Object
  extended bycom.waveset.util.AbstractXmlObject
      extended bycom.waveset.object.ResultFieldDisplay
All Implemented Interfaces:
javax.naming.Referenceable, XmlObject

public class ResultFieldDisplay
extends AbstractXmlObject

A class used to represent information about a field display item that can be added to a waveset result. The file display item in turn wraps an HTML item, mostly for access to its xml serialization methods.


Field Summary
static java.lang.String ATT_FIELD_DISPLAY
           
static java.lang.String code_id
           
static java.lang.String ELEMENT
          Our XML element name.
static java.lang.String ITEM_TYPE
          The ResultItem type name for these.
 
Fields inherited from class com.waveset.util.AbstractXmlObject
_trace
 
Constructor Summary
ResultFieldDisplay()
          Build an empty error object, which can be populated manually.
ResultFieldDisplay(org.w3c.dom.Element e)
          Build an display object by parsing its DOM representation.
ResultFieldDisplay(FieldDisplay item)
          Build an error object that captures a single Message object.
 
Method Summary
 java.lang.String getElementName()
          Return the XML element name, required by AbstractXmlObject.
 java.lang.Object getValue()
           
 boolean renderAtBottom()
           
 boolean renderAtMiddle()
           
 boolean renderAtTop()
          Hints for where to render the item.
 boolean renderWithButtons()
           
 void setRenderAtBottom(boolean flag)
           
 void setRenderAtMiddle(boolean flag)
           
 void setRenderAtTop(boolean flag)
           
 void setRenderWithButtons(boolean flag)
           
 void setValue(java.lang.Object value)
           
 void toXml(java.lang.StringBuffer b, int indent)
          Serialize into a buffer with optional indentation.
 
Methods inherited from class com.waveset.util.AbstractXmlObject
addXmlHeader, cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml, toXml, toXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT
Our XML element name.

See Also:
Constant Field Values

ITEM_TYPE

public static final java.lang.String ITEM_TYPE
The ResultItem type name for these. Should this go here or in ResultItem?

See Also:
Constant Field Values

ATT_FIELD_DISPLAY

public static final java.lang.String ATT_FIELD_DISPLAY
See Also:
Constant Field Values
Constructor Detail

ResultFieldDisplay

public ResultFieldDisplay()
Build an empty error object, which can be populated manually.


ResultFieldDisplay

public ResultFieldDisplay(FieldDisplay item)
Build an error object that captures a single Message object. You might use this just to capture random error messages that don't originate through exceptions.


ResultFieldDisplay

public ResultFieldDisplay(org.w3c.dom.Element e)
                   throws WavesetException
Build an display object by parsing its DOM representation.

Method Detail

getElementName

public java.lang.String getElementName()
Return the XML element name, required by AbstractXmlObject.

Specified by:
getElementName in interface XmlObject
Specified by:
getElementName in class AbstractXmlObject

renderAtTop

public boolean renderAtTop()
Hints for where to render the item.


renderAtMiddle

public boolean renderAtMiddle()

renderAtBottom

public boolean renderAtBottom()

renderWithButtons

public boolean renderWithButtons()

setRenderAtTop

public void setRenderAtTop(boolean flag)

setRenderAtMiddle

public void setRenderAtMiddle(boolean flag)

setRenderAtBottom

public void setRenderAtBottom(boolean flag)

setRenderWithButtons

public void setRenderWithButtons(boolean flag)

getValue

public java.lang.Object getValue()

setValue

public void setValue(java.lang.Object value)

toXml

public void toXml(java.lang.StringBuffer b,
                  int indent)
Description copied from class: AbstractXmlObject
Serialize into a buffer with optional indentation. This must be implemented by the subclass.

Specified by:
toXml in interface XmlObject
Specified by:
toXml in class AbstractXmlObject