com.f1j.chart
Interface Format

public interface Format

extends Format, Constants

The chart format class, providing information about chart formatting. This interface can be used to get and set formatting values on all elements within the chart. Certain formatting options only apply to certain parts of the chart. This object can be reused, so there is no need to create a new one for each object to be formatted.

Fields inherited from class com.f1j.util.Format

eFontBold, eFontColor, eFontItalic, eFontName, eFontOutline, eFontShadow, eFontSize, eFontStrikeout, eFontUnderline, eHorizontalAlignment, eHorizontalAlignmentCenter, eHorizontalAlignmentCenterAcrossCells, eHorizontalAlignmentFill, eHorizontalAlignmentGeneral, eHorizontalAlignmentJustify, eHorizontalAlignmentLeft, eHorizontalAlignmentRight, eIndent, eLineAuto, eLineColor, eLineDash, eLineDashDot, eLineDashDotDot, eLineLongDash, eLineLongDashDot, eLineLongDashDotDot, eLineNull, eLineRoundDot, eLineSolid, eLineSquareDot, eLineStyle, eLineWeight, eOrientation, eOrientationAuto, eOrientationClockwise, eOrientationCounterClockwise, eOrientationNone, eOrientationTopToBottom, ePattern, ePattern10Percent, ePattern20Percent, ePattern25Percent, ePattern30Percent, ePattern40Percent, ePattern50Percent, ePattern5Percent, ePattern60Percent, ePattern70Percent, ePattern75Percent, ePattern80Percent, ePattern90Percent, ePatternAuto, ePatternBG, ePatternBlueTissuePaper, ePatternBouquet, ePatternBrownMarble, ePatternCanvas, ePatternCenterGradient, ePatternCork, ePatternDarkDownwardDiagonal, ePatternDarkHorizontal, ePatternDarkUpwardDiagonal, ePatternDarkVertical, ePatternDashedDownwardDiagonal, ePatternDashedHorizontal, ePatternDashedUpwardDiagonal, ePatternDashedVertical, ePatternDenim, ePatternDiagGradient, ePatternDiagonalBrick, ePatternDivot, ePatternDottedDiamond, ePatternDottedGrid, ePatternFG, ePatternFishFossil, ePatternGranite, ePatternGreenMarble, ePatternHorizontalBrick, ePatternHorzGradient, ePatternHorzVertGradient, ePatternLargeCheckerBoard, ePatternLargeConfetti, ePatternLargeGrid, ePatternLightDownwardDiagonal, ePatternLightHorizontal, ePatternLightUpwardDiagonal, ePatternLightVertical, ePatternMediumWood, ePatternMidDiagGradient, ePatternMidGradient, ePatternMidHorzGradient, ePatternMidRevDiagGradient, ePatternMidVertGradient, ePatternName, ePatternNarrowHorizontal, ePatternNarrowVertical, ePatternNewsPrint, ePatternNull, ePatternOak, ePatternOutlinedDiamond, ePatternPaperBag, ePatternPapyrus, ePatternParchment, ePatternPinkTissuePaper, ePatternPlaid, ePatternPurpleMesh, ePatternRecycledPaper, ePatternRevDiagGradient, ePatternRevHorzVertGradient, ePatternRevVertHorzGradient, ePatternSand, ePatternShingle, ePatternSmallCheckerBoard, ePatternSmallConfetti, ePatternSmallGrid, ePatternSolid, ePatternSolidDiamond, ePatternSphere, ePatternStationary, ePatternTrellis, ePatternURL, ePatternVertGradient, ePatternVertHorzGradient, ePatternWalnut, ePatternWaterDroplets, ePatternWave, ePatternWeave, ePatternWhiteMarble, ePatternWideDownwardDiagonal, ePatternWideUpwardDiagonal, ePatternWovenMat, ePatternZigZag, eValueFormat, eValueFormatType, eValueFormatTypeCurrency, eValueFormatTypeDate, eValueFormatTypeDateTime, eValueFormatTypeFraction, eValueFormatTypeGeneral, eValueFormatTypeNumber, eValueFormatTypePercent, eValueFormatTypeScientific, eValueFormatTypeString, eVerticalAlignment, eVerticalAlignmentBottom, eVerticalAlignmentCenter, eVerticalAlignmentJustify, eVerticalAlignmentTop, eWordWrap

Fields inherited from class com.f1j.chart.Constants

eArea, eBar, eBopPop, eBubble, eCategoryScale, eColumn, eCombination, eDataLabelBubbleSize, eDataLabelCategory, eDataLabelCategoryAndPercent, eDataLabelNone, eDataLabelPercent, eDataLabelPercentageMask, eDataLabelPosition, eDataLabelPositionAbove, eDataLabelPositionAuto, eDataLabelPositionAxis, eDataLabelPositionBelow, eDataLabelPositionCenter, eDataLabelPositionDefault, eDataLabelPositionInside, eDataLabelPositionLeft, eDataLabelPositionOutside, eDataLabelPositionRight, eDataLabelSeriesNameMask, eDataLabelSizeValueMask, eDataLabelType, eDataLabelValue, eDataLabelXValueMask, eDataLabelYValueMask, eDoughnut, eFillShadow, eLegendPlacementBottom, eLegendPlacementBottomLeftCorner, eLegendPlacementBottomRightCorner, eLegendPlacementCorner, eLegendPlacementLeft, eLegendPlacementRight, eLegendPlacementTop, eLegendPlacementTopLeftCorner, eLegendPlacementTopRightCorner, eLine, eMarkerAuto, eMarkerBackground, eMarkerCircle, eMarkerDiamond, eMarkerDowJonesClose, eMarkerDowJonesOpen, eMarkerDownTriangle, eMarkerForeground, eMarkerNone, eMarkerPlus, eMarkerSize, eMarkerSquare, eMarkerStar, eMarkerStdDeviation, eMarkerStyle, eMarkerTriangle, eMarkerX, eOrientationAuto, ePie, ePlotEmptyValuesInterpolated, ePlotEmptyValuesNone, ePlotEmptyValuesZero, ePrintActualSize, ePrintFullPage, ePrintScaleToPage, eScatter, eSelectionAxis, eSelectionAxisTitle, eSelectionChart, eSelectionChartTitle, eSelectionDataLabelLines, eSelectionDataPoint, eSelectionDataPointLabel, eSelectionDropLines, eSelectionHighLowLines, eSelectionLegend, eSelectionLegendItem, eSelectionMajorGridLines, eSelectionMinorGridLines, eSelectionNone, eSelectionOpenCloseBarsDown, eSelectionOpenCloseBarsUp, eSelectionPlot, eSelectionSeries, eSelectionSeriesDataPointLabel, eSelectionSeriesLines, eSelectionTrendLine, eStep, eTickCross, eTickInside, eTickLabelPositionHigh, eTickLabelPositionLow, eTickLabelPositionNextToAxis, eTickLabelPositionNone, eTickNone, eTickOutside, eTimeScale, eTimeScaleUnitDays, eTimeScaleUnitHours, eTimeScaleUnitMinutes, eTimeScaleUnitMonths, eTimeScaleUnitQuarters, eTimeScaleUnitSeconds, eTimeScaleUnitWeeks, eTimeScaleUnitYears, eTrendLineExponential, eTrendLineLinear, eTrendLineLogarithmic, eTrendLineMovingAverage, eTrendLinePolynomial, eTrendLinePower, eValueFormatLinked, eValueScale, eXAxis, eYAxis

Fields inherited from class com.f1j.mvc.Constants

kPaper10x14, kPaper11x17, kPaperA3, kPaperA4, kPaperA4Small, kPaperA5, kPaperB4, kPaperB5, kPaperCSheet, kPaperDSheet, kPaperEnv10, kPaperEnv11, kPaperEnv12, kPaperEnv14, kPaperEnv9, kPaperEnvB4, kPaperEnvB5, kPaperEnvB6, kPaperEnvC3, kPaperEnvC4, kPaperEnvC5, kPaperEnvC6, kPaperEnvC65, kPaperEnvDL, kPaperEnvItaly, kPaperEnvMonarch, kPaperEnvPersonal, kPaperESheet, kPaperExecutive, kPaperFanfoldLglGerman, kPaperFanfoldStdGerman, kPaperFanfoldUS, kPaperFolio, kPaperLedger, kPaperLegal, kPaperLetter, kPaperLetterSmall, kPaperNote, kPaperQuarto, kPaperStatement, kPaperTabloid

Method Summary

AlignFormat	align() Gets the AlignFormat associated with this Format.
DataLabelFormat	dataLabel() Gets the DataLabelFormat associated with this Format.
FillFormat	fill() Gets the FillFormat associated with this Format.
FontFormat	font() Gets the FontFormat associated with this Format.
short	getDataLabelPosition() Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getPosition()
java.lang.String	getDataLabelSeparator() Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getSeparator()
short	getDataLabelType() Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getType()
int	getDataLabelTypes() Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getType()
int	getMarkerBackground() Deprecated. Replaced by com.f1j.chart.MarkerFormat.getBackColor()
int	getMarkerForeground() Deprecated. Replaced by com.f1j.chart.MarkerFormat.getForeColor()
int	getMarkerSize() Deprecated. Replaced by com.f1j.chart.MarkerFormat.getSizeTwips()
short	getMarkerStyle() Deprecated. Replaced by com.f1j.chart.MarkerFormat.getStyle()
boolean	isFillShadow() Deprecated. Replaced by com.f1j.chart.FillFormat.isFillShadow
boolean	isMarkerAuto() Deprecated. Replaced by com.f1j.chart.MarkerFormat.isAuto()
boolean	isValueFormatLinkedToDataSource() Deprecated. Replaced by com.f1j.chart.NumberFormat.isLinkedToDataSource()
LineFormat	line() Gets the LineFormat associated with this Format.
MarkerFormat	marker() Gets the MarkerFormat associated with this Format.
NumberFormat	number() Gets the NumberFormat associated with this Format.
void	setDataLabelPosition(short sPosition) Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setPosition(EPosition)
void	setDataLabelSeparator(java.lang.String separator) Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setSeparator(String)
void	setDataLabelType(short sType) Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setType(int)
void	setDataLabelTypes(int iType) Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setType(int)
void	setFillShadow(boolean b) Deprecated. Replaced by com.f1j.chart.FillFormat.setFillShadow(boolean)
void	setMarkerAuto(boolean b) Deprecated. Replaced by com.f1j.chart.MarkerFormat.setAuto(boolean)
void	setMarkerBackground(int iBackground) Deprecated. Replaced by com.f1j.chart.MarkerFormat.setBackColor(int)
void	setMarkerForeground(int iForeground) Deprecated. Replaced by com.f1j.chart.MarkerFormat.setForeColor(int)
void	setMarkerSize(int iSize) Deprecated. Replaced by com.f1j.chart.MarkerFormat.setSizeTwips(int)
void	setMarkerStyle(short sStyle) Deprecated. Replaced by com.f1j.chart.MarkerFormat.setStyle(EStyle)
void	setValueFormatLinkedToDataSource(boolean b) Deprecated. Replaced by com.f1j.chart.NumberFormat.setLinkedToDataSource(boolean)

Methods inherited from interface com.f1j.util.Format

getFontColor, getFontName, getFontSize, getFontSizeInPoints, getHorizontalAlignment, getLineColor, getLineStyle, getLineWeight, getOrientation, getPattern, getPatternBG, getPatternFG, getPatternURL, getValueFormat, getValueFormatLocal, getValueFormatType, getVerticalAlignment, isFontBold, isFontItalic, isFontOutline, isFontShadow, isFontStrikeout, isFontUnderline, isLineAuto, isPatternAuto, isUndefined, isUsed, isWordWrap, setFontBold, setFontColor, setFontItalic, setFontName, setFontOutline, setFontShadow, setFontSize, setFontSizeInPoints, setFontStrikeout, setFontUnderline, setHorizontalAlignment, setLineAuto, setLineColor, setLineStyle, setLineWeight, setOrientation, setPattern, setPatternAuto, setPatternBG, setPatternFG, setPatternURL, setUndefined, setValueFormat, setValueFormatLocal, setVerticalAlignment, setWordWrap, useAllFormats

Method Detail

align

public AlignFormat align()

Gets the AlignFormat associated with this Format.

Returns:

the AlignFormat.

dataLabel

public DataLabelFormat dataLabel()

Gets the DataLabelFormat associated with this Format.

Returns:

the DataLabelFormat.

fill

public FillFormat fill()

Gets the FillFormat associated with this Format.

Returns:

the FillFormat.

font

public FontFormat font()

Gets the FontFormat associated with this Format.

Returns:

the FontFormat.

getDataLabelPosition

public short getDataLabelPosition()

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getPosition()

Returns the data label position value.

Returns:

a short describing label position.

Data Label Position Constants.

eDataLabelPositionOutside	eDataLabelPositionAbove	eDataLabelPositionAuto
eDataLabelPositionAxis	eDataLabelPositionBelow	eDataLabelPositionCenter
eDataLabelPositionDefault	eDataLabelPositionInside	eDataLabelPositionLeft
eDataLabelPositionRight

See Also:

Constants, setDataLabelPosition(short)

getDataLabelSeparator

public java.lang.String getDataLabelSeparator()

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getSeparator()

Returns the data label separator value.

Returns:

a String representing the separator

See Also:

setDataLabelSeparator(String)

getDataLabelType

public short getDataLabelType()

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getType()

Returns the data label type value.

Returns:

a short describing the label type.

Data Label Type Constants

eDataLabelCategory	eDataLabelCategoryAndPercent	eDataLabelBubbleSize
eDataLabelNone	eDataLabelValue	eDataLabelPercent

See Also:

Constants, setDataLabelType(short)

getDataLabelTypes

public int getDataLabelTypes()

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.getType()

Returns the types of the data label.

Returns:

an int containing the label types as a masked value.

Data Label Type Mask Constants

eDataLabelSeriesNameMask	eDataLabelXValueMask	eDataLabelYValueMask
eDataLabelNone	eDataLabelPercentageMask	eDataLabelSizeValueMask

See Also:

Constants, setDataLabelTypes(int)

getMarkerBackground

public int getMarkerBackground()

Deprecated. Replaced by com.f1j.chart.MarkerFormat.getBackColor()

Returns the marker background color as an RGB value. The color is returned as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

Returns:

an integer indicating the background color.

See Also:

setMarkerBackground(int)

getMarkerForeground

public int getMarkerForeground()

Deprecated. Replaced by com.f1j.chart.MarkerFormat.getForeColor()

Returns the marker foreground color as an RGB value. The color is returned as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

Returns:

an integer indicating the foreground color.

See Also:

setMarkerForeground(int)

getMarkerSize

public int getMarkerSize()

Deprecated. Replaced by com.f1j.chart.MarkerFormat.getSizeTwips()

Returns the marker size in twips.

Returns:

an integer indicating the marker size.

See Also:

setMarkerSize(int)

getMarkerStyle

public short getMarkerStyle()

Deprecated. Replaced by com.f1j.chart.MarkerFormat.getStyle()

Returns the marker style.

Returns:

a short describing the marker style.

Marker Style Constants

eMarkerCircle	eMarkerDiamond	eMarkerDowJonesClose
eMarkerDowJonesOpen	eMarkerDownTriangle	eMarkerPlus
eMarkerSquare	eMarkerStar	eMarkerStdDeviation
eMarkerTriangle	eMarkerX

See Also:

Constants, setMarkerStyle(short)

isFillShadow

public boolean isFillShadow()

Deprecated. Replaced by com.f1j.chart.FillFormat.isFillShadow

Returns whether the object has a shadow behind it.

Returns:

boolean. true or false.

See Also:

setFillShadow(boolean)

isMarkerAuto

public boolean isMarkerAuto()

Deprecated. Replaced by com.f1j.chart.MarkerFormat.isAuto()

Returns whether to use automatic formatting for a marker.

Returns:

boolean. true or false.

See Also:

setMarkerAuto(boolean)

isValueFormatLinkedToDataSource

public boolean isValueFormatLinkedToDataSource()

Deprecated. Replaced by com.f1j.chart.NumberFormat.isLinkedToDataSource()

Returns whether the object gets the value format from the data source. true = value format from data source.

Returns:

boolean. true or false.

See Also:

setValueFormatLinkedToDataSource(boolean)

line

public LineFormat line()

Gets the LineFormat associated with this Format.

Returns:

the LineFormat.

marker

public MarkerFormat marker()

Gets the MarkerFormat associated with this Format.

Returns:

the MarkerFormat.

number

public NumberFormat number()

Gets the NumberFormat associated with this Format.

Returns:

the NumberFormat.

setDataLabelPosition

public void setDataLabelPosition(short sPosition)
                          throws F1Exception

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setPosition(EPosition)

Sets position of the data label.

Parameters:

sPosition - a constant indicating tick label position.

Data Label Position Constants

eDataLabelPositionOutside	eDataLabelPositionAbove	eDataLabelPositionAuto
eDataLabelPositionAxis	eDataLabelPositionBelow	eDataLabelPositionCenter
eDataLabelPositionDefault	eDataLabelPositionInside	eDataLabelPositionLeft
eDataLabelPositionRight

Throws:

F1Exception - if argument is invalid.

See Also:

Constants, getDataLabelPosition()

setDataLabelSeparator

public void setDataLabelSeparator(java.lang.String separator)

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setSeparator(String)

Sets the data label separator.

Parameters:

separator - a String specifying the data label separator.

See Also:

getDataLabelSeparator()

setDataLabelType

public void setDataLabelType(short sType)
                      throws F1Exception

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setType(int)

Sets the type of data label to use.

Parameters:

sType - a constant designating a data label type.

Data Label Type Constants

eDataLabelCategory	eDataLabelCategoryAndPercent	eDataLabelBubbleSize
eDataLabelNone	eDataLabelValue	eDataLabelPercent

Throws:

F1Exception - if argument is invalid.

See Also:

Constants, getDataLabelType()

setDataLabelTypes

public void setDataLabelTypes(int iType)
                       throws F1Exception

Deprecated. Replaced by com.f1j.chart.DataLabelFormat.setType(int)

Sets the types of data label to use.

Parameters:

iType - an integer designating the data label types, which are OR'd together.

Data Label Type Mask Constants

eDataLabelSeriesNameMask	eDataLabelXValueMask	eDataLabelYValueMask
eDataLabelNone	eDataLabelPercentageMask	eDataLabelSizeValueMask

Throws:

F1Exception - if argument is invalid.

See Also:

Constants, getDataLabelTypes()

setMarkerAuto

public void setMarkerAuto(boolean b)

Deprecated. Replaced by com.f1j.chart.MarkerFormat.setAuto(boolean)

Sets the marker type to be assigned automatically.

Parameters:

b - boolean. true/false. true = marker type set automatically.

See Also:

isMarkerAuto()

setMarkerBackground

public void setMarkerBackground(int iBackground)

Deprecated. Replaced by com.f1j.chart.MarkerFormat.setBackColor(int)

Sets marker background color as an RGB value. The color is returned as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

Parameters:

iBackground - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

See Also:

getMarkerBackground()

setMarkerForeground

public void setMarkerForeground(int iForeground)

Deprecated. Replaced by com.f1j.chart.MarkerFormat.setForeColor(int)

Sets marker foreground color as an RGB value. The color is returned as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

Parameters:

iForeground - an int that describes the border color as a four-byte integer in the format 0x00RRGGBB. getPaletteRGB} method for more information.

See Also:

getMarkerForeground()

setMarkerSize

public void setMarkerSize(int iSize)
                   throws F1Exception

Deprecated. Replaced by com.f1j.chart.MarkerFormat.setSizeTwips(int)

Sets marker size in twips.

Parameters:

iSize - an integer between 0 and 1440.

Throws:

F1Exception - if argument is invalid.

See Also:

getMarkerSize()

setMarkerStyle

public void setMarkerStyle(short sStyle)
                    throws F1Exception

Deprecated. Replaced by com.f1j.chart.MarkerFormat.setStyle(EStyle)

Sets marker style.

Markers may be used in line and XY charts and on line series in combination charts only.

Parameters:

sStyle - a constant designating the marker style.

Marker Style Constants

eMarkerCircle	eMarkerDiamond	eMarkerDowJonesClose
eMarkerDowJonesOpen	eMarkerDownTriangle	eMarkerPlus
eMarkerSquare	eMarkerStar	eMarkerStdDeviation
eMarkerTriangle	eMarkerX	eMarkerNone

Throws:

F1Exception - if argument is invalid.

See Also:

Constants, getMarkerStyle()

setFillShadow

public void setFillShadow(boolean b)

Deprecated. Replaced by com.f1j.chart.FillFormat.setFillShadow(boolean)

Sets whether an object includes a shadow behind it.

Parameters:

b - boolean. true/false. true = add a shadow.

See Also:

isFillShadow()

setValueFormatLinkedToDataSource

public void setValueFormatLinkedToDataSource(boolean b)

Deprecated. Replaced by com.f1j.chart.NumberFormat.setLinkedToDataSource(boolean)

Sets whether the object gets the value format from the data source.

Parameters:

b - boolean. true/false. true = set value format from data source.

See Also:

isValueFormatLinkedToDataSource()