wt.query.report
Class DefaultBarChartColumnInfo

java.lang.Object
  extended bywt.query.report.DefaultBarChartColumnInfo
All Implemented Interfaces:
BarChartColumnInfo

public class DefaultBarChartColumnInfo
extends Object
implements BarChartColumnInfo

This class implements the BarChartColumnInfo interface with default values for each column.

Supported API: false

Extendable: false


Field Summary
private static String CLASSNAME
           
private  Color color
           
private  int fixedPadding
           
private  int leftMargin
           
private static String RESOURCE
           
private  int rightMargin
           
 
Constructor Summary
DefaultBarChartColumnInfo(int a_fixedPadding, int a_leftMargin, int a_rightMargin, Color a_color)
          

Supported API: false
 
Method Summary
private  void colorValidate(Color a_Color)
           
private  void fixedPaddingValidate(int a_FixedPadding)
           
 Color getColor()
          Gets the value of the attribute: color; Color.
 Color getColor(int a_columnIndex)
          Return the column's color.
 int getFixedPadding()
          Gets the value of the attribute: fixedPadding; Fixed padding.
 int getFixedPadding(int a_columnIndex)
          Return the column's fixed padding.
 String getHeading(TableModel a_dataModel, int a_rowIndex, Locale a_locale)
          Returns a heading for the column.
 int getHeadingSpan(TableModel a_dataModel, int a_rowIndex)
          Returnsthe number of rows/columns that this heading spans.
 int getLeftMargin()
          Gets the value of the attribute: leftMargin; Left Margin.
 int getLeftMargin(int a_columnIndex)
          Return the column's left margin.
 int getRightMargin()
          Gets the value of the attribute: rightMargin; Right Margin.
 int getRightMargin(int a_columnIndex)
          Return the column's right margin.
private  void leftMarginValidate(int a_LeftMargin)
           
private  void rightMarginValidate(int a_RightMargin)
           
 void setColor(Color a_Color)
          Sets the value of the attribute: color; Color.
 void setFixedPadding(int a_FixedPadding)
          Sets the value of the attribute: fixedPadding; Fixed padding.
 void setLeftMargin(int a_LeftMargin)
          Sets the value of the attribute: leftMargin; Left Margin.
 void setRightMargin(int a_RightMargin)
          Sets the value of the attribute: rightMargin; Right Margin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

fixedPadding

private int fixedPadding

leftMargin

private int leftMargin

rightMargin

private int rightMargin

color

private Color color
Constructor Detail

DefaultBarChartColumnInfo

public DefaultBarChartColumnInfo(int a_fixedPadding,
                                 int a_leftMargin,
                                 int a_rightMargin,
                                 Color a_color)
                          throws WTPropertyVetoException


Supported API: false

Parameters:
a_fixedPadding -
a_leftMargin -
a_rightMargin -
a_color -
Throws:
WTPropertyVetoException
Method Detail

getFixedPadding

public int getFixedPadding()
Gets the value of the attribute: fixedPadding; Fixed padding.

Supported API: false

Returns:
int

setFixedPadding

public void setFixedPadding(int a_FixedPadding)
                     throws WTPropertyVetoException
Sets the value of the attribute: fixedPadding; Fixed padding.

Supported API: false

Parameters:
a_FixedPadding -
Throws:
WTPropertyVetoException

fixedPaddingValidate

private void fixedPaddingValidate(int a_FixedPadding)
                           throws WTPropertyVetoException
Parameters:
a_FixedPadding -
Throws:
WTPropertyVetoException

getLeftMargin

public int getLeftMargin()
Gets the value of the attribute: leftMargin; Left Margin.

Supported API: false

Returns:
int

setLeftMargin

public void setLeftMargin(int a_LeftMargin)
                   throws WTPropertyVetoException
Sets the value of the attribute: leftMargin; Left Margin.

Supported API: false

Parameters:
a_LeftMargin -
Throws:
WTPropertyVetoException

leftMarginValidate

private void leftMarginValidate(int a_LeftMargin)
                         throws WTPropertyVetoException
Parameters:
a_LeftMargin -
Throws:
WTPropertyVetoException

getRightMargin

public int getRightMargin()
Gets the value of the attribute: rightMargin; Right Margin.

Supported API: false

Returns:
int

setRightMargin

public void setRightMargin(int a_RightMargin)
                    throws WTPropertyVetoException
Sets the value of the attribute: rightMargin; Right Margin.

Supported API: false

Parameters:
a_RightMargin -
Throws:
WTPropertyVetoException

rightMarginValidate

private void rightMarginValidate(int a_RightMargin)
                          throws WTPropertyVetoException
Parameters:
a_RightMargin -
Throws:
WTPropertyVetoException

getColor

public Color getColor()
Gets the value of the attribute: color; Color.

Supported API: false

Returns:
Color

setColor

public void setColor(Color a_Color)
              throws WTPropertyVetoException
Sets the value of the attribute: color; Color.

Supported API: false

Parameters:
a_Color -
Throws:
WTPropertyVetoException

colorValidate

private void colorValidate(Color a_Color)
                    throws WTPropertyVetoException
Parameters:
a_Color -
Throws:
WTPropertyVetoException

getFixedPadding

public int getFixedPadding(int a_columnIndex)
                    throws WTException
Return the column's fixed padding.

Supported API: false

Specified by:
getFixedPadding in interface BarChartColumnInfo
Parameters:
a_columnIndex - Column index to use to retrive the information.
Returns:
int
Throws:
WTException

getLeftMargin

public int getLeftMargin(int a_columnIndex)
                  throws WTException
Return the column's left margin.

Supported API: false

Specified by:
getLeftMargin in interface BarChartColumnInfo
Parameters:
a_columnIndex - Column index to use to retrive the information.
Returns:
int
Throws:
WTException

getRightMargin

public int getRightMargin(int a_columnIndex)
                   throws WTException
Return the column's right margin.

Supported API: false

Specified by:
getRightMargin in interface BarChartColumnInfo
Parameters:
a_columnIndex - Column index to use to retrive the information.
Returns:
int
Throws:
WTException

getColor

public Color getColor(int a_columnIndex)
               throws WTException
Return the column's color.

Supported API: false

Specified by:
getColor in interface BarChartColumnInfo
Parameters:
a_columnIndex - Column index to use to retrive the information.
Returns:
Color
Throws:
WTException

getHeading

public String getHeading(TableModel a_dataModel,
                         int a_rowIndex,
                         Locale a_locale)
                  throws WTException
Returns a heading for the column.

Supported API: false

Specified by:
getHeading in interface BarChartColumnInfo
Parameters:
a_dataModel - Data model to use in generating the heading.
a_rowIndex - Row index to use for generating the heading.
a_locale - Locale to use in generating the heading.
Returns:
String
Throws:
WTException

getHeadingSpan

public int getHeadingSpan(TableModel a_dataModel,
                          int a_rowIndex)
                   throws WTException
Returnsthe number of rows/columns that this heading spans.

Supported API: false

Specified by:
getHeadingSpan in interface BarChartColumnInfo
Parameters:
a_dataModel - Data model to use in generating the heading span.
a_rowIndex - Row index to use for generating the heading span.
Returns:
int
Throws:
WTException