com.dynalivery.harmoni
Class HTMLFormatOptions

java.lang.Object
  |
  +--com.dynalivery.harmoni.FormatOptions
        |
        +--com.dynalivery.harmoni.HTMLFormatOptions

public class HTMLFormatOptions

extends FormatOptions

implements java.io.Serializable

This class defines the HTML formatting options for a Saffron export

See Also:

Serialized Form

Constructor Summary

HTMLFormatOptions()
Creates new HTMLFormatOptions

HTMLFormatOptions(int imageType, boolean frames)
Creates new HTMLFormatOptions

Method Summary

boolean	getFrames() Returns true if frames should be used
int	getImageType() Returns the image type to be used when generating HTML
byte[]	getXML() Returns the XML String that represents these HTML formatting options
void	setFrames(boolean frames) Sets whether frames should be used
void	setImageType(int imageType) Sets the image type to be used when generating HTML
java.lang.String	toString() Creates display string for format options.

Methods inherited from class com.dynalivery.harmoni.FormatOptions

getFileType, setFileType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HTMLFormatOptions

public HTMLFormatOptions(int imageType,
                         boolean frames)
                  throws InvalidParameterException

Creates new HTMLFormatOptions

Parameters:

imageType - the integer image type (e.g. ImageType.JPG)

frames - true if frames should be used

baseFileName - the base filename String to be used when generating HTML

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

HTMLFormatOptions

public HTMLFormatOptions()
                  throws InvalidParameterException

Creates new HTMLFormatOptions

Method Detail

setImageType

public void setImageType(int imageType)
                  throws InvalidParameterException

Sets the image type to be used when generating HTML

Parameters:

imageType - the integer image type (ImageType.JPG)

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

setFrames

public void setFrames(boolean frames)

Sets whether frames should be used

Parameters:

frames - true if frames should be used

getFrames

public boolean getFrames()

Returns true if frames should be used

Returns:

true if frames should be used

getImageType

public int getImageType()

Returns the image type to be used when generating HTML

Returns:

the integer image type (e.g. ImageType.JPG)

getXML

public byte[] getXML()
              throws InvalidParameterException

Returns the XML String that represents these HTML formatting options

Overrides:

getXML in class FormatOptions

Returns:

the XML String that represents these HTML formatting options

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

toString

public java.lang.String toString()

Creates display string for format options.

Overrides:

toString in class FormatOptions

Tags copied from class: FormatOptions

Returns:

display string for format options. Must be overridden in subclasses.