exe
Interface GAIGSdatastr

All Known Implementing Classes:
GAIGSarray, GAIGSbase, GAIGSgraph, GAIGShashStruct, GAIGSlabel, GAIGSlegend, GAIGSlist, GAIGSMemoryManager, GAIGSNameValueIndex, GAIGSnewArray, GAIGSnewQueue, GAIGSnewStack, GAIGSphylogenetic_forest, GAIGSphylogenetic_tree, GAIGSprimitiveCollection, GAIGSqueue, GAIGSRefStruct, GAIGSstack, GAIGStext, GAIGStree

public interface GAIGSdatastr

The GAIGSdatastr interface provides constants used as default values for the name, color, position and font size of GAIGS structures. It requires methods for getting and setting the name of the structure, and a toXML method, which is used to generate the XML script for a structure.

Version:
6/20/06
Author:
Myles McNally

Field Summary
static java.lang.String DEFAULT_COLOR
          Default color for a GAIGS structure
static double DEFAULT_FONT_SIZE
          Default font size for a GAIGS structure
static java.lang.String DEFAULT_NAME
          Default name for a GAIGS structure
static double DEFAULT_X1
          Default left bound for a GAIGS structure
static double DEFAULT_X2
          Default right bound for a GAIGS structure
static double DEFAULT_Y1
          Default bottom bound for a GAIGS structure
static double DEFAULT_Y2
          Default top bound for a GAIGS structure
 
Method Summary
 java.lang.String getName()
          Get the name for this structure
 void setName(java.lang.String name)
          Set the name for this structure
 java.lang.String toXML()
          Create and return the GAIGS XML script for this structure
 

Field Detail

DEFAULT_NAME

static final java.lang.String DEFAULT_NAME
Default name for a GAIGS structure


DEFAULT_COLOR

static final java.lang.String DEFAULT_COLOR
Default color for a GAIGS structure

See Also:
Constant Field Values

DEFAULT_X1

static final double DEFAULT_X1
Default left bound for a GAIGS structure

See Also:
Constant Field Values

DEFAULT_Y1

static final double DEFAULT_Y1
Default bottom bound for a GAIGS structure

See Also:
Constant Field Values

DEFAULT_X2

static final double DEFAULT_X2
Default right bound for a GAIGS structure

See Also:
Constant Field Values

DEFAULT_Y2

static final double DEFAULT_Y2
Default top bound for a GAIGS structure

See Also:
Constant Field Values

DEFAULT_FONT_SIZE

static final double DEFAULT_FONT_SIZE
Default font size for a GAIGS structure

See Also:
Constant Field Values
Method Detail

toXML

java.lang.String toXML()
Create and return the GAIGS XML script for this structure

Returns:
The String containing the script

getName

java.lang.String getName()
Get the name for this structure

Returns:
The String containing the structure name

setName

void setName(java.lang.String name)
Set the name for this structure

Parameters:
name - The String containing the structure name