HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform
Class RenderingSet

java.lang.Object
  extended by java.util.AbstractCollection
      extended by java.util.AbstractList
          extended by java.util.ArrayList
              extended by com.ibm.hats.transform.RenderingSet
All Implemented Interfaces:
Serializable, Cloneable, Iterable, Collection, List, RandomAccess

public class RenderingSet
extends ArrayList
implements Cloneable

See Also:
Serialized Form

Field Summary
static String ALIGNMENT_LEFT
           
static String ALIGNMENT_RIGHT
           
static String ATTR_ALIGNMENT
           
static String ATTR_DESC
           
static String ATTR_LAYOUT
           
static String ATTR_NAME
           
protected static String CLASSNAME
           
static String COMPACT_LAYOUT
          The layout for displaying the default rendering to use a minimal amount of space.
protected static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
static String DEFAULT_LAYOUT
           
static String DEFAULT_RENDERING_SET_NAME
           
static String TABLE_LAYOUT
          The layout for the default display of default rendering, which is to use a table to layout the screen in a manner similar to the host.
static String TAG_RENDERING_SET
           
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
RenderingSet()
          Constructor for RenderingSet.
RenderingSet(Element set)
           
RenderingSet(Element set, String name)
          Constructor for RenderingSet
RenderingSet(String name)
           
 
Method Summary
 Object clone()
           
 String getAlignment()
           
 String getDescription()
           
 String getLayout()
          Returns a non-null String object, which is used for the layout.
 String getName()
           
 RenderingSet replicate()
           
 void setAlignment(String alignment)
           
 void setDescription(String description)
           
 void setLayout(String layout)
          Accepts a String object, which will be used for the layout.
 void setName(String name)
           
 Element toElement(Document doc)
           
 Element toElement(Document doc, boolean enptuiSupport)
           
 Element toElement(Document doc, boolean enptuiSupport, boolean subfileSupport)
           
 Element toElement(Document doc, boolean enptuiSupport, boolean subfileSupport, boolean lightPenSupport)
           
 String toString()
           
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Field Detail

COPYRIGHT

protected static final String COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

CLASSNAME

protected static final String CLASSNAME
See Also:
Constant Field Values

DEFAULT_RENDERING_SET_NAME

public static final String DEFAULT_RENDERING_SET_NAME
See Also:
Constant Field Values

TAG_RENDERING_SET

public static final String TAG_RENDERING_SET
See Also:
Constant Field Values

ATTR_NAME

public static final String ATTR_NAME
See Also:
Constant Field Values

ATTR_DESC

public static final String ATTR_DESC
See Also:
Constant Field Values

ATTR_LAYOUT

public static final String ATTR_LAYOUT
See Also:
Constant Field Values

ATTR_ALIGNMENT

public static final String ATTR_ALIGNMENT
See Also:
Constant Field Values

ALIGNMENT_LEFT

public static final String ALIGNMENT_LEFT
See Also:
Constant Field Values

ALIGNMENT_RIGHT

public static final String ALIGNMENT_RIGHT
See Also:
Constant Field Values

TABLE_LAYOUT

public static final String TABLE_LAYOUT
The layout for the default display of default rendering, which is to use a table to layout the screen in a manner similar to the host.

See Also:
Constant Field Values

COMPACT_LAYOUT

public static final String COMPACT_LAYOUT
The layout for displaying the default rendering to use a minimal amount of space.

See Also:
Constant Field Values

DEFAULT_LAYOUT

public static final String DEFAULT_LAYOUT
See Also:
Constant Field Values
Constructor Detail

RenderingSet

public RenderingSet()
Constructor for RenderingSet.


RenderingSet

public RenderingSet(String name)

RenderingSet

public RenderingSet(Element set,
                    String name)
Constructor for RenderingSet

Parameters:
set - XML Element defining items in set.

RenderingSet

public RenderingSet(Element set)
Method Detail

setName

public void setName(String name)

getName

public String getName()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

toString

public String toString()
Overrides:
toString in class AbstractCollection

toElement

public Element toElement(Document doc)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupport)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupport,
                         boolean subfileSupport)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupport,
                         boolean subfileSupport,
                         boolean lightPenSupport)

getLayout

public String getLayout()
Returns a non-null String object, which is used for the layout. RenderingSet.TABLE_LAYOUT or RenderingSet.COMPACT_LAYOUT are expected. Other string responses may be returned but will be unsupported through the API and should be considered as a response of the default RenderingSet.TABLE_LAYOUT.

Returns:
a non-null String object.

setLayout

public void setLayout(String layout)
Accepts a String object, which will be used for the layout. RenderingSet.TABLE_LAYOUT or RenderingSet.COMPACT_LAYOUT are expected. Other string responses may be set but will be unsupported through the API and should be considered as invalid input with unpredictable results

Parameters:
layout - a String object. RenderingSet.TABLE_LAYOUT or RenderingSet.COMPACT_LAYOUT are expected.

setAlignment

public void setAlignment(String alignment)

getAlignment

public String getAlignment()

replicate

public RenderingSet replicate()

clone

public Object clone()
Overrides:
clone in class ArrayList

HATS 7.5.1 (201005110649)