Package hec.gfx2d

Class ViewportDrawProp

java.lang.Object

hec.gfx2d.PlotProperties

hec.gfx2d.ViewportDrawProp

All Implemented Interfaces:

GridProperties, PatternProperties, AsciiSerializable, FieldAccessor, Serializable

public class ViewportDrawProp
extends PlotProperties
implements PatternProperties, GridProperties, AsciiSerializable

Drawing properties for gfx2d viewport.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Color	backgroundColor
static final String	BEGIN_TAG
Color	borderColor
float[]	borderStyle
float	borderWeight
static final String	CLS_NAME
boolean	drawBackground
boolean	drawBorder
boolean	drawMajorXGrid	draw vertical grid lines at x axis major tics
boolean	drawMajorYGrid	draw vertical grid lines at y axis major tics
boolean	drawMinorXGrid	draw vertical grid lines at x axis minor tics
boolean	drawMinorYGrid	draw vertical grid lines at y axis minor tics
boolean	drawViewportLegend
String	drawViewportLegendAlign
static final String	END_TAG
int	fillPattern
Vector	glyphProperties
Vector	lineMarkerProperties
Color	majorXGridColor
float[]	majorXGridStyle
float	majorXGridWeight
Color	majorYGridColor
float[]	majorYGridStyle
float	majorYGridWeight
Color	minorXGridColor
float[]	minorXGridStyle
float	minorXGridWeight
Color	minorYGridColor
float[]	minorYGridStyle
float	minorYGridWeight
float	viewportAlpha
int	viewportLegendFontSize

Constructor Summary

Constructors

Constructor	Description
ViewportDrawProp()	Default Constructor
ViewportDrawProp(String cls)

Method Summary

Modifier and Type	Method	Description
void	addGlyphProperties(G2dGlyphDrawProp prop)
void	addLineMarkerProperties(G2dMarkerProperties prop)
void	drawViewportLegend(boolean b)
float	getAlphaComposite()
Color	getBackgroundColor()
int	getBackgroundFill()
boolean	getDrawBackground()
boolean	getDrawLine()
boolean	getDrawViewportLegend()
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
static String	getFileName()
Color	getLineColor()
float[]	getLineStyle()
float	getLineWeight()
Color	getMajorXGridColor()
float[]	getMajorXGridStyle()
float	getMajorXGridWeight()
Color	getMajorYGridColor()
float[]	getMajorYGridStyle()
float	getMajorYGridWeight()
Color	getMinorXGridColor()
float[]	getMinorXGridStyle()
float	getMinorXGridWeight()
Color	getMinorYGridColor()
float[]	getMinorYGridStyle()
float	getMinorYGridWeight()
int	getViewportLegendFontSize()
static void	init()
static boolean	loadDefaults(BufferedReader in)
protected static boolean	loadDefaults(BufferedReader in, String endTag, String cls)
void	readProperties(BufferedReader in, String endTag)
void	setAlphaComposite(float alpha)
void	setBackgroundColor(Color c)
void	setBackgroundFill(int ft)
static void	setDefaults(ViewportDrawProp defaultProps)
protected static void	setDefaults(ViewportDrawProp defaultProps, String cls)
void	setDrawBackground(boolean b)
void	setDrawLine(boolean b)
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	setLineColor(Color c)
void	setLineStyle(float[] s)
void	setLineWeight(float f)
void	setMajorXGridColor(Color c)
void	setMajorXGridStyle(float[] s)
void	setMajorXGridWeight(float w)
void	setMajorYGridColor(Color c)
void	setMajorYGridStyle(float[] s)
void	setMajorYGridWeight(float w)
void	setMinorXGridColor(Color c)
void	setMinorXGridStyle(float[] s)
void	setMinorXGridWeight(float w)
void	setMinorYGridColor(Color c)
void	setMinorYGridStyle(float[] s)
void	setMinorYGridWeight(float w)
void	setShowMajorXGridLines(boolean s)
void	setShowMajorYGridLines(boolean s)
void	setShowMinorXGridLines(boolean s)
void	setShowMinorYGridLines(boolean s)
void	setViewportLegendFontSize(int i)
boolean	showMajorXGridLines()
boolean	showMajorYGridLines()
boolean	showMinorXGridLines()
boolean	showMinorYGridLines()
static boolean	writeDefaults()
static boolean	writeDefaults(BufferedWriter writer)
protected static boolean	writeDefaults(String cls, BufferedWriter writer)
void	writeProperties(BufferedWriter writer, String endTag)
protected void	writeProperties(BufferedWriter writer, String endTag, String cls)

Methods inherited from class hec.gfx2d.PlotProperties

dumpDefaults, getDefaultBoolean, getDefaultColor, getDefaultDouble, getDefaultFloat, getDefaultFloatArray, getDefaultFont, getDefaultInsets, getDefaultInt, getDefaultObject, getDefaults, getDefaultString, isDefault, isDefault, isDefault, isDefault, isDefault, isDefault, isDefault, isDefault, isDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefault, setDefaults

Methods inherited from class java.lang.Object

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

Field Details

CLS_NAME

public static final String CLS_NAME

See Also:

• Constant Field Values

END_TAG

public static final String END_TAG

See Also:

• Constant Field Values

BEGIN_TAG

public static final String BEGIN_TAG

See Also:

• Constant Field Values

drawMajorXGrid

public boolean drawMajorXGrid

draw vertical grid lines at x axis major tics

drawMinorXGrid

public boolean drawMinorXGrid

draw vertical grid lines at x axis minor tics

drawMajorYGrid

public boolean drawMajorYGrid

draw vertical grid lines at y axis major tics

drawMinorYGrid

public boolean drawMinorYGrid

draw vertical grid lines at y axis minor tics

majorXGridWeight

public float majorXGridWeight

minorXGridWeight

public float minorXGridWeight

majorXGridColor

public Color majorXGridColor

minorXGridColor

public Color minorXGridColor

majorXGridStyle

public float[] majorXGridStyle

minorXGridStyle

public float[] minorXGridStyle

majorYGridWeight

public float majorYGridWeight

minorYGridWeight

public float minorYGridWeight

majorYGridColor

public Color majorYGridColor

minorYGridColor

public Color minorYGridColor

majorYGridStyle

public float[] majorYGridStyle

minorYGridStyle

public float[] minorYGridStyle

drawBorder

public boolean drawBorder

drawBackground

public boolean drawBackground

borderStyle

public float[] borderStyle

borderWeight

public float borderWeight

borderColor

public Color borderColor

backgroundColor

public Color backgroundColor

viewportAlpha

public float viewportAlpha

fillPattern

public int fillPattern

drawViewportLegend

public boolean drawViewportLegend

drawViewportLegendAlign

public String drawViewportLegendAlign

viewportLegendFontSize

public int viewportLegendFontSize

lineMarkerProperties

public Vector lineMarkerProperties

glyphProperties

public Vector glyphProperties

Constructor Details

ViewportDrawProp

public ViewportDrawProp()

Default Constructor

ViewportDrawProp

public ViewportDrawProp(String cls)

Method Details

init

public static void init()

setShowMajorXGridLines

public void setShowMajorXGridLines(boolean s)

Specified by:

setShowMajorXGridLines in interface GridProperties

setShowMinorXGridLines

public void setShowMinorXGridLines(boolean s)

Specified by:

setShowMinorXGridLines in interface GridProperties

setShowMajorYGridLines

public void setShowMajorYGridLines(boolean s)

Specified by:

setShowMajorYGridLines in interface GridProperties

setShowMinorYGridLines

public void setShowMinorYGridLines(boolean s)

Specified by:

setShowMinorYGridLines in interface GridProperties

showMajorXGridLines

public boolean showMajorXGridLines()

Specified by:

showMajorXGridLines in interface GridProperties

showMinorXGridLines

public boolean showMinorXGridLines()

Specified by:

showMinorXGridLines in interface GridProperties

showMajorYGridLines

public boolean showMajorYGridLines()

Specified by:

showMajorYGridLines in interface GridProperties

showMinorYGridLines

public boolean showMinorYGridLines()

Specified by:

showMinorYGridLines in interface GridProperties

setMajorXGridWeight

public void setMajorXGridWeight(float w)

Specified by:

setMajorXGridWeight in interface GridProperties

setMinorXGridWeight

public void setMinorXGridWeight(float w)

Specified by:

setMinorXGridWeight in interface GridProperties

setMajorXGridColor

public void setMajorXGridColor(Color c)

Specified by:

setMajorXGridColor in interface GridProperties

setMinorXGridColor

public void setMinorXGridColor(Color c)

Specified by:

setMinorXGridColor in interface GridProperties

setMajorXGridStyle

public void setMajorXGridStyle(float[] s)

Specified by:

setMajorXGridStyle in interface GridProperties

setMinorXGridStyle

public void setMinorXGridStyle(float[] s)

Specified by:

setMinorXGridStyle in interface GridProperties

getMajorXGridWeight

public float getMajorXGridWeight()

Specified by:

getMajorXGridWeight in interface GridProperties

getMinorXGridWeight

public float getMinorXGridWeight()

Specified by:

getMinorXGridWeight in interface GridProperties

getMajorXGridColor

public Color getMajorXGridColor()

Specified by:

getMajorXGridColor in interface GridProperties

getMinorXGridColor

public Color getMinorXGridColor()

Specified by:

getMinorXGridColor in interface GridProperties

getMajorXGridStyle

public float[] getMajorXGridStyle()

Specified by:

getMajorXGridStyle in interface GridProperties

getMinorXGridStyle

public float[] getMinorXGridStyle()

Specified by:

getMinorXGridStyle in interface GridProperties

setMajorYGridWeight

public void setMajorYGridWeight(float w)

Specified by:

setMajorYGridWeight in interface GridProperties

setMinorYGridWeight

public void setMinorYGridWeight(float w)

Specified by:

setMinorYGridWeight in interface GridProperties

setMajorYGridColor

public void setMajorYGridColor(Color c)

Specified by:

setMajorYGridColor in interface GridProperties

setMinorYGridColor

public void setMinorYGridColor(Color c)

Specified by:

setMinorYGridColor in interface GridProperties

setMajorYGridStyle

public void setMajorYGridStyle(float[] s)

Specified by:

setMajorYGridStyle in interface GridProperties

setMinorYGridStyle

public void setMinorYGridStyle(float[] s)

Specified by:

setMinorYGridStyle in interface GridProperties

getMajorYGridWeight

public float getMajorYGridWeight()

Specified by:

getMajorYGridWeight in interface GridProperties

getMinorYGridWeight

public float getMinorYGridWeight()

Specified by:

getMinorYGridWeight in interface GridProperties

getMajorYGridColor

public Color getMajorYGridColor()

Specified by:

getMajorYGridColor in interface GridProperties

getMinorYGridColor

public Color getMinorYGridColor()

Specified by:

getMinorYGridColor in interface GridProperties

getMajorYGridStyle

public float[] getMajorYGridStyle()

Specified by:

getMajorYGridStyle in interface GridProperties

getMinorYGridStyle

public float[] getMinorYGridStyle()

Specified by:

getMinorYGridStyle in interface GridProperties

setDrawLine

public void setDrawLine(boolean b)

Specified by:

setDrawLine in interface PatternProperties

setDrawBackground

public void setDrawBackground(boolean b)

Specified by:

setDrawBackground in interface PatternProperties

setLineColor

public void setLineColor(Color c)

Specified by:

setLineColor in interface PatternProperties

setLineStyle

public void setLineStyle(float[] s)

Specified by:

setLineStyle in interface PatternProperties

setLineWeight

public void setLineWeight(float f)

Specified by:

setLineWeight in interface PatternProperties

setBackgroundColor

public void setBackgroundColor(Color c)

Specified by:

setBackgroundColor in interface PatternProperties

setBackgroundFill

public void setBackgroundFill(int ft)

Specified by:

setBackgroundFill in interface PatternProperties

drawViewportLegend

public void drawViewportLegend(boolean b)

setViewportLegendFontSize

public void setViewportLegendFontSize(int i)

getLineColor

public Color getLineColor()

Specified by:

getLineColor in interface PatternProperties

getLineStyle

public float[] getLineStyle()

Specified by:

getLineStyle in interface PatternProperties

getLineWeight

public float getLineWeight()

Specified by:

getLineWeight in interface PatternProperties

getBackgroundColor

public Color getBackgroundColor()

Specified by:

getBackgroundColor in interface PatternProperties

getDrawLine

public boolean getDrawLine()

Specified by:

getDrawLine in interface PatternProperties

getDrawBackground

public boolean getDrawBackground()

Specified by:

getDrawBackground in interface PatternProperties

getBackgroundFill

public int getBackgroundFill()

Specified by:

getBackgroundFill in interface PatternProperties

getDrawViewportLegend

public boolean getDrawViewportLegend()

getViewportLegendFontSize

public int getViewportLegendFontSize()

setAlphaComposite

public void setAlphaComposite(float alpha)

Specified by:

setAlphaComposite in interface PatternProperties

getAlphaComposite

public float getAlphaComposite()

Specified by:

getAlphaComposite in interface PatternProperties

addGlyphProperties

public void addGlyphProperties(G2dGlyphDrawProp prop)

writeProperties

public void writeProperties(BufferedWriter writer,
 String endTag)

writeProperties

protected void writeProperties(BufferedWriter writer,
 String endTag,
 String cls)

readProperties

public void readProperties(BufferedReader in,
 String endTag)

addLineMarkerProperties

public void addLineMarkerProperties(G2dMarkerProperties prop)

getFileName

public static String getFileName()

loadDefaults

public static boolean loadDefaults(BufferedReader in)

loadDefaults

protected static boolean loadDefaults(BufferedReader in,
 String endTag,
 String cls)

setDefaults

public static void setDefaults(ViewportDrawProp defaultProps)

setDefaults

protected static void setDefaults(ViewportDrawProp defaultProps,
 String cls)

writeDefaults

public static boolean writeDefaults()

writeDefaults

public static boolean writeDefaults(BufferedWriter writer)

writeDefaults

protected static boolean writeDefaults(String cls,
 BufferedWriter writer)

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful