net.sourceforge.chart2d
Class TextListArea

java.lang.Object
  |
  +--net.sourceforge.chart2d.Area
        |
        +--net.sourceforge.chart2d.FontArea
              |
              +--net.sourceforge.chart2d.TextListArea

Direct Known Subclasses:

HorizontalTextListArea, VerticalTextListArea

abstract class TextListArea

extends FontArea

An abstract class for shared methods between HorizontalTextListArea and VerticalTextListArea.

Fields inherited from class net.sourceforge.chart2d.Area

BETWEEN, BOTTOM, CENTER, CENTERED, CONTINUOUS, DASHED, DOTTED, FLOAT, HEIGHT, HORIZONTAL, INTEGER, LABELSBOTTOM, LABELSLEFT, LEFT, LEFTBOTTOM, LEFTRIGHT, LEFTTOP, LESSER, MAX, MAXMODEL, MIN, RIGHT, RIGHTBOTTOM, RIGHTTOP, TOP, TOPBOTTOM, VERTICAL, WIDTH

Constructor Summary

(package private)

TextListArea()

Method Summary

(package private) abstract int	getBetweenBulletsAndLabelsGapThicknessModel() Returns the model minimum thickness of the gap between the labels and the bullets.
(package private) abstract int	getBetweenBulletsGapThicknessModel() Returns the model thickness of the minimum gap between bullets.
(package private) abstract int	getBetweenLabelsGapThicknessModel() Returns the model thickness of the minimum gap between labels.
(package private) abstract java.awt.Rectangle[]	getBullets(java.awt.Graphics2D g2D) Returns the bounds for each bullet.
(package private) abstract int	getBulletsAlignment()
(package private) abstract boolean	getBulletsOutline() Specifies whether the bullets should have a small outline.
(package private) abstract java.awt.Color	getBulletsOutlineColor() Specifies the color of the bullets outline.
(package private) abstract java.awt.Dimension	getBulletsSizeModel() Returns the model size of the bullets.
(package private) abstract TextArea[]	getLabels(java.awt.Graphics2D g2D) Returns the labels.
(package private) abstract boolean	getLabelsExistence() Returns true if the labels of the text list exist; false otherwise.
(package private) abstract java.lang.String[]	getLabelStrings() Returns the label strings of this text list.
(package private) abstract void	setAllowSelfSize(boolean allow) Allows this text list area to determine its minimum size and reset its own size.
(package private) abstract void	setBetweenBulletsAndLabelsGapExistence(boolean existence) Specifies the existence of a minimum gap between the labels and the bullets.
(package private) abstract void	setBetweenBulletsAndLabelsGapThicknessModel(int model) Specifies the model minimum thickness of the gap between the labels and the bullets.
(package private) abstract void	setBetweenBulletsGapExistence(boolean existence) Specifies the existence of a minimum gap between each bullets.
(package private) abstract void	setBetweenBulletsGapThicknessModel(int model) Specifies the model minimum thickness of the gap between each bullet.
(package private) abstract void	setBetweenLabelsGapExistence(boolean existence) Specifies whether the minimum amount of space between each label, the gap, shall be enforced.
(package private) abstract void	setBetweenLabelsGapThicknessModel(int model) Specifies the model minimum thickness of the gap between the labels.
(package private) abstract void	setBulletColors(java.awt.Color[] colors) Specifies the colors of the bullets.
(package private) abstract void	setBulletsAlignment(int alignment)
(package private) abstract void	setBulletsOutline(boolean outline) Specifies whether the bullets should have a small black outline.
(package private) abstract void	setBulletsOutlineColor(java.awt.Color color) Specifies the color of the bullets outline.
(package private) abstract void	setBulletsRelation(int relation)
(package private) abstract void	setBulletsSizeModel(java.awt.Dimension model) Specifies the model size (width and height) of the bullets.
(package private) abstract void	setLabels(java.lang.String[] labels) Specifies the text for the labels.
(package private) abstract void	setLabelsExistence(boolean existence) Specifies whether the labels exist.

Methods inherited from class net.sourceforge.chart2d.FontArea

getFont, getFontAreaNeedsUpdate, getFontColor, getFontName, getFontPointModel, getFontStyle, paintComponent, resetFontAreaModel, setFontColor, setFontName, setFontPointModel, setFontStyle, updateFontArea

Methods inherited from class net.sourceforge.chart2d.Area

applyRatio, getAreaNeedsUpdate, getAutoSize, getBackgroundColor, getBackgroundExistence, getBorderColor, getBorderColor, getBorderExistence, getBorderExistence, getBorderThickness, getBorderThickness, getBorderThicknessModel, getBorderThicknessModel, getGapThickness, getGapThicknessModel, getJustifications, getRatio, getResetAreaModel, getSize, getSizeLocation, getSpaceSize, getSpaceSizeLocation, resetAreaModel, setAutoJustifys, setAutoSizes, setBackgroundColor, setBackgroundExistence, setBorderAssociations, setBorderColor, setBorderColors, setBorderCornerAssociations, setBorderExistence, setBorderExistences, setBorderThicknessModel, setBorderThicknessModels, setCustomRatio, setGapAssociations, setGapExistence, setGapExistences, setGapThicknessModel, setGapThicknessModels, setJustifications, setLockRatios, setSize, setSizeLocation, setSpaceSize, setSpaceSizeLocation, updateArea

Methods inherited from class java.lang.Object

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

Constructor Detail

TextListArea

TextListArea()

Method Detail

setAllowSelfSize

abstract void setAllowSelfSize(boolean allow)

Allows this text list area to determine its minimum size and reset its own size. This is useful when you want the component to be able to figure out its minimum size, but not always to set itself to that miniumum size.

Parameters:

allow - If true, then the component can reset its own minimum size. This is only relevant when auto minimum sizing is enabled.

setLabelsExistence

abstract void setLabelsExistence(boolean existence)

Specifies whether the labels exist. If this is false, then the labels are not used in calculations or painting.

Parameters:

existence - The existence of these labels.

setLabels

abstract void setLabels(java.lang.String[] labels)

Specifies the text for the labels. This value cannot be null; however, a zero or greater length array is fine.

Parameters:

labels - An array of the strings to be used for the labels.

setBulletsSizeModel

abstract void setBulletsSizeModel(java.awt.Dimension model)

Specifies the model size (width and height) of the bullets. A ratio based on maximum size / model size will be applied to this to find the actual bullet size -- when auto sizing the model maximum size is disabled. Otherwise, the actual size will be this size.

Parameters:

model - The model size of a bullet.

setBulletsAlignment

abstract void setBulletsAlignment(int alignment)

setBulletsRelation

abstract void setBulletsRelation(int relation)

setBulletColors

abstract void setBulletColors(java.awt.Color[] colors)

Specifies the colors of the bullets. Each bullet can have a different color so an array must be passed. The number of colors must be equal to the number of bullets. If the bullets alignment is between the labels and the lables do exist, then there should be one bullet less than the number of labels. If the bullets alignment is centered and the labels do exist, then there should be the same number of bullets as labels. Otherwise, choose any number of bullets. Number of bullets is set by setting the bullet colors. The number of bullets always equals the number of colors.

Parameters:

colors - An array filled with a color for each bullet. The first bullet from left to right gets the lowest order color in the array.

setBulletsOutline

abstract void setBulletsOutline(boolean outline)

Specifies whether the bullets should have a small black outline. Outline is 1 pixel on all sides, at all times, and is black. Outlien is included in size of bullet.

Parameters:

outline - If true, then the outline will exist.

setBulletsOutlineColor

abstract void setBulletsOutlineColor(java.awt.Color color)

Specifies the color of the bullets outline.

Parameters:

color - The outline color.

setBetweenLabelsGapExistence

abstract void setBetweenLabelsGapExistence(boolean existence)

Specifies whether the minimum amount of space between each label, the gap, shall be enforced. If the gap does not exist, then it will not be included in calculations.

Parameters:

existence - The existence of the gap. If true, then it exists.

setBetweenLabelsGapThicknessModel

abstract void setBetweenLabelsGapThicknessModel(int model)

Specifies the model minimum thickness of the gap between the labels.

Parameters:

model - The model minimum thickness of the gap. Note: The gap may end up being more depending on sizing properties.

setBetweenBulletsGapExistence

abstract void setBetweenBulletsGapExistence(boolean existence)

Specifies the existence of a minimum gap between each bullets. If the gap doesn't exist, then it will not be included in calculations.

Parameters:

existence - The existence of the minimum gap. If true, then the gap does exist.

setBetweenBulletsGapThicknessModel

abstract void setBetweenBulletsGapThicknessModel(int model)

Specifies the model minimum thickness of the gap between each bullet.

Parameters:

model - The model minimum thickness of the gap. Note: The gap may end up being more depending on sizing properties.

setBetweenBulletsAndLabelsGapExistence

abstract void setBetweenBulletsAndLabelsGapExistence(boolean existence)

Specifies the existence of a minimum gap between the labels and the bullets. If the gap doesn't exist, then it will not be included in calculations.

Parameters:

boolean - The existence of the minimum gap. If true, then the gap does exist.

setBetweenBulletsAndLabelsGapThicknessModel

abstract void setBetweenBulletsAndLabelsGapThicknessModel(int model)

Specifies the model minimum thickness of the gap between the labels and the bullets.

Parameters:

model - The model minimum thickness of the gap. Note: The gap may end up being more depending on sizing properties.

getLabelStrings

abstract java.lang.String[] getLabelStrings()

Returns the label strings of this text list.

Returns:

The label strings.

getLabelsExistence

abstract boolean getLabelsExistence()

Returns true if the labels of the text list exist; false otherwise.

Returns:

True if exists.

getLabels

abstract TextArea[] getLabels(java.awt.Graphics2D g2D)

Returns the labels. This is useful if other components need to be aligned exactly with the label's location or should be the exact same size.

Parameters:

g2D - The graphics context used for calculations.

Returns:

The array of TextArea's which are the labels.

getBetweenBulletsGapThicknessModel

abstract int getBetweenBulletsGapThicknessModel()

Returns the model thickness of the minimum gap between bullets.

Returns:

int The model thickness.

getBetweenLabelsGapThicknessModel

abstract int getBetweenLabelsGapThicknessModel()

Returns the model thickness of the minimum gap between labels.

Returns:

The model thickness.

getBetweenBulletsAndLabelsGapThicknessModel

abstract int getBetweenBulletsAndLabelsGapThicknessModel()

Returns the model minimum thickness of the gap between the labels and the bullets.

Returns:

The model minimum thickness of the gap.

getBullets

abstract java.awt.Rectangle[] getBullets(java.awt.Graphics2D g2D)

Returns the bounds for each bullet. This is useful if other components need to be aligned exactly with the bullet's location or should be the exact same size.

Parameters:

g2D - The graphics context used for calculations.

Returns:

The array of rectangles which bound each bullet.

getBulletsSizeModel

abstract java.awt.Dimension getBulletsSizeModel()

Returns the model size of the bullets.

Returns:

The size.

getBulletsAlignment

abstract int getBulletsAlignment()

getBulletsOutline

abstract boolean getBulletsOutline()

Specifies whether the bullets should have a small outline. Outline is 1 pixel on all sides, at all times, and is black. Outline is included in size of bullet.

Returns:

outline If true, then the outline will exist.

getBulletsOutlineColor

abstract java.awt.Color getBulletsOutlineColor()

Specifies the color of the bullets outline.

Returns:

color The outline color.