netcharts.pro.common.rectangular
Class NFAxisMargin

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.rectangular.NFAxisMargin

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFAxisMargin
extends NFBaseClass
implements NFCDLGenerator

The NFAxisMargin object specifies a padding to add before and after the plot area of a graph.

Constructor Summary

NFAxisMargin()
Constructs a default margin.

NFAxisMargin(int beginMargin, int endMargin)
Constructs a margin using the supplied margins.

Method Summary

int	getBeginMargin() Gets the beginning margin.
java.lang.String	getCDL() Generate CDL parameters representing this margin.
void	getCDL(java.lang.StringBuffer sb, boolean includeParens) Append CDL parameters representing this margin to the given StringBuffer.
int	getEndMargin() Gets the ending margin.
void	setBeginMargin(int beginMargin) Sets the beginning margin.
void	setCDL(java.lang.String cdl) Configures this margin from a CDL parameter representation.
int	setCDL(java.lang.String[] elements, int offset) Configures this object from a CDL parameter representation.
void	setEndMargin(int endMargin) Sets the ending margin.
java.lang.String	toString() Returns a new String object representing this margin.

Methods inherited from class netcharts.pro.common.NFBaseClass

clone, getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

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

Constructor Detail

NFAxisMargin

public NFAxisMargin()

Constructs a default margin.

NFAxisMargin

public NFAxisMargin(int beginMargin,
                    int endMargin)

Constructs a margin using the supplied margins.

Parameters:

beginMargin - Value representing the amount of padding to include preceding the plot area.

endMargin - Value representing the amount of padding to include after the plot area.

Method Detail

setBeginMargin

public void setBeginMargin(int beginMargin)

Sets the beginning margin.

Parameters:

beginMargin - Value representing the amount of padding to include preceding the plot area.

getBeginMargin

public int getBeginMargin()

Gets the beginning margin.

Returns:

The amount of padding to include preceding the plot area.

setEndMargin

public void setEndMargin(int endMargin)

Sets the ending margin.

Parameters:

endMargin - Value representing the amount of padding to include after the plot area.

getEndMargin

public int getEndMargin()

Gets the ending margin.

Returns:

The amount of padding to include after the plot area.

toString

public java.lang.String toString()

Returns a new String object representing this margin.

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class java.lang.Object

Returns:

A new String object in the same form as that given by getCDL().

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this margin.

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (beginMargin,endMargin)

getCDL

public void getCDL(java.lang.StringBuffer sb,
                   boolean includeParens)

Append CDL parameters representing this margin to the given StringBuffer.

Parameters:

sb - Target buffer to append the CDL parameters

includeParens - If true, this will cause the parameters to be delimited with parenthesis.

setCDL

public void setCDL(java.lang.String cdl)

Configures this margin from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in the form: (beginMargin,endMargin)

setCDL

public int setCDL(java.lang.String[] elements,
                  int offset)

Configures this object from a CDL parameter representation.

Parameters:

elements - Array of parameter elements. This array is expected to contain consecutive elements containing the beginning margin and ending margin information.

offset - Offset into the elements array.