com.dynalivery.saffron.client
Class HTMLFormatOptions

java.lang.Object
  com.dynalivery.saffron.client.FormatOptions
      com.dynalivery.saffron.client.HTMLFormatOptions

All Implemented Interfaces:

java.io.Serializable

public class HTMLFormatOptions

extends FormatOptions

implements java.io.Serializable

This class defines the HTML formatting options for a Saffron export

See Also:

Serialized Form

Field Summary

Fields inherited from class com.dynalivery.saffron.client.FormatOptions

fileType

Constructor Summary

HTMLFormatOptions(int imageType, boolean frames, java.lang.String baseFileName)
Creates new HTMLFormatOptions

Method Summary

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

Methods inherited from class com.dynalivery.saffron.client.FormatOptions

getFileType, setFileType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HTMLFormatOptions

public HTMLFormatOptions(int imageType,
                         boolean frames,
                         java.lang.String baseFileName)
                  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:

InvalidParameterException

Method Detail

setImageType

public void setImageType(int imageType)
                  throws InvalidParameterException

Sets the base filename String to be used when generating HTML

Parameters:

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

Throws:

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 base filename String to be used when generating HTML

Returns:

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

setBaseFileName

public void setBaseFileName(java.lang.String baseFileName)

Sets the base filename String to be used when generating HTML

Parameters:

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

getBaseFileName

public java.lang.String getBaseFileName()

Returns the base filename String to be used when generating HTML

Returns:

the base filename String to be used when generating HTML

getXML

public byte[] getXML()
              throws InvalidParameterException

Returns the XML String that represents these HTML formatting options

Specified by:

getXML in class FormatOptions

Returns:

the XML String that represents these HTML formatting options

Throws:

InvalidParameterException

toString

public java.lang.String toString()

Creates display string for format options.

Overrides:

toString in class FormatOptions

Returns:

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