Package gov.nasa.gsfc.spdf.ssc

Class GraphFormatOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.GraphFormatOptions

public class GraphFormatOptions
extends java.lang.Object

This class represents formating options for an SSC graph request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
GraphFormatOptions()	Constructs a GraphFormatOption object with a default value that specifies automatic labeling, a character size of 1, and a symbol and tick size of 0.8.
GraphFormatOptions(GraphLabelOptions customLabelOptions, float charSize, float symbolSize)	Constructs a GraphFormatOption object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
float	getCharSize()	Gets the character size.
GraphLabelOptions	getCustomLabelOptions()	Gets the custom label options.
float	getSymbolSize()	Gets the symbol and tick size.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setCharSize(float value)	Sets the character size.
void	setCustomLabelOptions(GraphLabelOptions value)	Sets the custom label options.
void	setSymbolSize(float value)	Sets the symbol and tick size.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphFormatOptions

public GraphFormatOptions()

Constructs a GraphFormatOption object with a default value that specifies automatic labeling, a character size of 1, and a symbol and tick size of 0.8.

GraphFormatOptions

public GraphFormatOptions(GraphLabelOptions customLabelOptions,
                          float charSize,
                          float symbolSize)

Constructs a GraphFormatOption object with the given attribute values.

Parameters:

customLabelOptions - specifies custom labels. A null value indicates that automatic labeling should be employed.

charSize - specifies the character size

symbolSize - specifies the symbol and tick size

Method Detail

getCustomLabelOptions

public GraphLabelOptions getCustomLabelOptions()

Gets the custom label options.

Returns:

custom label options or null if none (automatic labeling).

See Also:

setCustomLabelOptions(gov.nasa.gsfc.spdf.ssc.GraphLabelOptions)

setCustomLabelOptions

public void setCustomLabelOptions(GraphLabelOptions value)

Sets the custom label options.

Parameters:

value - new custom label options. A null value indicates that automatic labeling is to be employed.

See Also:

getCustomLabelOptions()

getCharSize

public float getCharSize()

Gets the character size.

Returns:

character size

See Also:

setCharSize(float)

setCharSize

public void setCharSize(float value)

Sets the character size.

Parameters:

value - new character size

See Also:

getCharSize()

getSymbolSize

public float getSymbolSize()

Gets the symbol and tick size.

Returns:

symbol and tick size

See Also:

setSymbolSize(float)

setSymbolSize

public void setSymbolSize(float value)

Sets the symbol and tick size.

Parameters:

value - new symbol and tick size

See Also:

getSymbolSize()

list

public void list(java.io.PrintStream out)

Prints this object's value to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream