|
JClass 4.5.0 API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--com.klg.jclass.swing.gauge.JCGauge | +--com.klg.jclass.swing.gauge.JCCircularGauge | +--com.klg.jclass.swing.gauge.beans.JCCircularGaugeBean
A bean which exposes gauge properties suitable for editing in an Integrated Development Environment (IDE).
Inner classes inherited from class com.klg.jclass.swing.gauge.JCCircularGauge |
JCCircularGauge.GaugeType |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary | |
static int |
DIRECTION_CLOCKWISE
Scale values increase in a clockwise direction. |
static int |
DIRECTION_COUNTERCLOCKWISE
Scale values increase in a counterclockwise direction. |
protected JCScale.Direction[] |
directions
|
protected JCCircularGauge.GaugeType[] |
gaugeTypes
|
static int |
INTERACTION_CLICK
The needle snaps to a mouse click. |
static int |
INTERACTION_CLICK_DRAG
The needle responds to both mouse click and mouse drag actions. |
static int |
INTERACTION_DRAG
The needle follows a mouse drag action. |
static int |
INTERACTION_NONE
Neither clicking nor dragging affects the needle. |
protected JCNeedle.InteractionType[] |
interactionTypes
Interaction type to enum mapping |
static int |
NEEDLE_ARROW
Arrow polygon using these points. |
static int |
NEEDLE_POINTER
A pointer needle using these points, |
static int |
NEEDLE_TAILED_ARROW
Tailed Arrow polygon |
static int |
NEEDLE_TAILED_POINTER
A tailed pointer needle (tail extends beyond center). |
static int |
NEEDLE_TRIANGLE
Triangle |
protected JCNeedleStyle[] |
needleStyles
|
static int |
TICK_CIRCLE
Circle tick style. |
static int |
TICK_DIAMOND
Diamond |
static int |
TICK_LINE
Line tick style. |
static int |
TICK_RECTANGLE
Rectangle tick style. |
static int |
TICK_REVERSE_TRIANGLE
Reverse Triangle |
static int |
TICK_TRIANGLE
Triangle tick style. |
protected JCTickStyle[] |
tickStyles
JCTickStyle to enum mapping |
static int |
TYPE_BOTTOM_HALF_CIRCLE
The scale is a semicircle oriented so that its diameter is horizontal and its circumference is below its base. |
static int |
TYPE_FULL_CIRCLE
The scale is a full circle. |
static int |
TYPE_LEFT_HALF_CIRCLE
The scale is a semicircle oriented so that its diameter is vertical and its circumference is to the left of its base. |
static int |
TYPE_LOWER_LEFT_QUARTER_CIRCLE
A quadrant whose arc lies southwest. |
static int |
TYPE_LOWER_RIGHT_QUARTER_CIRCLE
A quadrant whose arc lies southeast. |
static int |
TYPE_RIGHT_HALF_CIRCLE
The scale is a semicircle oriented so that its diameter is vertical and its circumference is to the right of its base. |
static int |
TYPE_TOP_HALF_CIRCLE
The scale is a semicircle oriented so that its diameter is horizontal and its circumference is above its base. |
static int |
TYPE_UPPER_LEFT_QUARTER_CIRCLE
A quadrant whose arc lies northwest. |
static int |
TYPE_UPPER_RIGHT_QUARTER_CIRCLE
A quadrant whose arc lies northeast. |
Fields inherited from class com.klg.jclass.swing.gauge.JCCircularGauge |
center,
gaugeType,
labels |
Fields inherited from class com.klg.jclass.swing.gauge.JCGauge |
draggedNeedle,
footer,
footerLayoutHints,
gaugeArea,
gaugeAreaLayoutHints,
header,
headerLayoutHints,
legend,
legendLayoutHints,
needles,
pickListeners,
ranges,
repaintEnabled,
scale,
snapToValue |
Fields inherited from class javax.swing.JComponent |
accessibleContext,
listenerList,
TOOL_TIP_TEXT_KEY,
ui,
UNDEFINED_CONDITION,
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,
WHEN_FOCUSED,
WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT,
CENTER_ALIGNMENT,
LEFT_ALIGNMENT,
RIGHT_ALIGNMENT,
TOP_ALIGNMENT |
Constructor Summary | |
JCCircularGaugeBean()
JCCircularGaugeBean no arg constructor. |
Method Summary | |
void |
addPropertyChangeListener(PropertyChangeListener l)
Add a property change listener for needle value changes. |
boolean |
getAutoTickGeneration()
Returns the automatic Boolean for this tick object. |
Color |
getCenterColor()
Get the center's color. |
double |
getCenterRadius()
Gets the radius of the center. |
int |
getDirection()
Returns the direction enum for this gauge. |
int |
getDirectionIndex(JCScale.Direction direction)
Return the enum for a given JCCircularScale.Direction. |
boolean |
getDrawTickLabels()
Returns the Boolean controlling the drawing of labels. |
boolean |
getDrawTickMarks()
Returns the Boolean controlling the drawing of ticks. |
int |
getGaugeTypeIndex(JCCircularGauge.GaugeType type)
Return the enum for a given JCCircularGauge.GaugeType. |
int |
getInteractionTypeIndex(JCNeedle.InteractionType type)
Return the enum index for a needle interaction type. |
Color |
getNeedleColor()
Return the color of the needle. |
int |
getNeedleInteractionType()
Returns the interation type for this needle. |
int |
getNeedleStyle()
Returns the JCNeedleStyle for this needle. |
int |
getNeedleStyleIndex(JCNeedleStyle style)
Return the enum for a given JCNeedleStyle. |
double |
getNeedleValue()
Return the scale value at which the needle is currently pointing. |
double |
getNeedleWidth()
Return the width of the needle in pixels. |
boolean |
getPaintCompleteBackground()
Paints the complete background defined by the GaugeType ,
not just area swept by scale. |
int |
getPrecision()
Returns the format for numbers in a tick label: positive values denote the number of places after the decimal point (for example, 3 means multiples of 0.001); negative values indicate the positive number of zeros are used before the decimal place (for example, -3 means numbering will be in multiples of 1000). |
boolean |
getPrecisionUseDefault()
If true, uses gauge-determined precision for tick labels, otherwise uses setPrecision to label tick marks. |
Color |
getScaleColor()
Get the scale's color. |
double |
getScaleExtent()
Return the extent to which the scale's background will be draw from the center. |
double |
getScaleMax()
Return the value which will appear at the scale's stopAngle. |
double |
getScaleMin()
Return the value which will appear at the scale's startAngle |
double |
getStartAngle()
Get the start angle of the scale. |
double |
getStopAngle()
Get the stop angle of the scale. |
Color |
getTickColor()
Return the color in which tick marks will be drawn |
Font |
getTickFont()
Return the font in which ticks are to be drawn. |
Color |
getTickFontColor()
Return the color in which tick labels will be drawn |
double |
getTickIncrement()
In non-automatic mode, uses this value as the increment value, that is, places ticks at every incrementValue along the scale. |
double |
getTickInnerExtent()
Returns the percentage of the scale's radius (as a decimal) at at which to begin drawing ticks radially outward. |
double |
getTickLabelExtent()
Returns the position, expressed as a decimal fraction of the scale's radius, where tick labels are placed. |
double |
getTickOuterExtent()
Returns the percentage of the scale's radius (as a decimal) at which to stop drawing the ticks. |
double |
getTickStartValue()
In non-automatic mode, uses this value as the start value. |
double |
getTickStopValue()
In non-automatic mode, uses this value as the stop value. |
int |
getTickStyle()
Returns the JCTickStyle controlling the shape of the tick. |
int |
getTickStyleIndex(JCTickStyle style)
Return the enum for a given JCTickStyle. |
double |
getTickWidth()
Returns the width in pixels of the tick mark. |
int |
getType()
Returns the JCCircularGauge type for this gauge. |
void |
removePropertyChangeListener(PropertyChangeListener l)
Remove a property change listener for needle value changes. |
void |
setAutoTickGeneration(boolean b)
Sets the automatic Boolean for this tick object. |
void |
setCenterColor(Color color)
Set the center's color. |
void |
setCenterRadius(double radius)
Sets the radius of the disk. |
void |
setDirection(int direction)
Sets the direction enum for this gauge. |
void |
setDrawTickLabels(boolean b)
Sets the Boolean controlling the drawing of labels.True means draw the labels, false means hide the labels. |
void |
setDrawTickMarks(boolean b)
Sets the Boolean controlling the drawing of ticks.True means draw the ticks, false means hide the ticks. |
void |
setNeedleColor(Color color)
Set the color of the needle. |
void |
setNeedleInteractionType(int type)
Sets the interation type for this needle. |
void |
setNeedleStyle(int style)
Sets the JCNeedleStyle for this needle. |
void |
setNeedleValue(double value)
Move the needle to point at this scale value. |
void |
setNeedleWidth(double width)
Set the width of the needle in pixels. |
void |
setPaintCompleteBackground(boolean b)
If true, paints the complete background for this GaugeType ,
not just area between the scale's start and stop angles. |
void |
setPrecision(int precision)
Sets the format for numbers in a tick label: positive values denote the number of places after the decimal point (for example, 3 means multiples of 0.001); negative values indicate the positive number of zeros are used before the decimal place (for example, -3 means numbering will be in multiples of 1000). |
void |
setPrecisionUseDefault(boolean b)
If true, uses gauge-determined precision for tick labels, otherwise uses setPrecision to label tick marks. |
void |
setScaleColor(Color color)
Set the scale's color. |
void |
setScaleExtent(double extent)
Set the extent to which the scale's background will be draw from the center. |
void |
setScaleMax(double max)
Set the value which will appear at the scale's stopAngle. |
void |
setScaleMin(double min)
Set the value which will appear at the scale's startAngle. |
void |
setStartAngle(double angle)
Set the start angle of the scale. |
void |
setStopAngle(double angle)
Set the stop angle of the scale. |
void |
setTickColor(Color color)
Set the color in which tick marks will be drawn. |
void |
setTickFont(Font font)
Set the font in which ticks are to be drawn. |
void |
setTickFontColor(Color color)
Set the color in which tick labels will be drawn. |
void |
setTickIncrement(double value)
In non-automatic mode, uses this value as the increment value, that is, places ticks at every incrementValue along the scale. |
void |
setTickInnerExtent(double extent)
Sets the percentage of the scale's radius (as a decimal) at at which to begin drawing ticks radially outward. |
void |
setTickLabelExtent(double extent)
Sets the percentage, expressed as a decimal fraction of the scale's radius, at which to place the center of the tick label objects. |
void |
setTickOuterExtent(double extent)
Sets the percentage of the scale's radius (as a decimal) at which to stop drawing the ticks. |
void |
setTickStartValue(double value)
In non-automatic mode, uses this value as the start value. |
void |
setTickStopValue(double value)
In non-automatic mode, uses this value as the stop value. |
void |
setTickStyle(int style)
Sets the JCTickStyle controlling the shape of the tick. |
void |
setTickWidth(double width)
Sets the width in pixels of the tick mark. |
void |
setType(int type)
Sets the JCCircularGaugeBean type for this gauge. |
Methods inherited from class com.klg.jclass.swing.gauge.JCCircularGauge |
addLabel,
addLabel,
getArcBounds,
getCenter,
getClosestNeedle,
getGaugeType,
mouseClicked,
mouseDragged,
paintComponent,
redraw,
removeLabel,
setCenter,
setCenter,
setGaugeType,
valueToAngle |
Methods inherited from class com.klg.jclass.swing.gauge.JCGauge |
addNeedle,
addNeedle,
addPickListener,
addRange,
addRange,
addTick,
addTick,
getComponentArea,
getDrawingAreaHeight,
getDrawingAreaWidth,
getFooter,
getGaugeArea,
getHeader,
getLayoutHints,
getLegend,
getNeedles,
getRanges,
getRepaintEnabled,
getScale,
getSnapToValue,
getTicks,
mouseEntered,
mouseExited,
mouseMoved,
mousePressed,
mouseReleased,
pick,
removeNeedle,
removePickListener,
removeRange,
removeTick,
sendPickEvent,
setFooter,
setGaugeArea,
setHeader,
setLegend,
setRepaintEnabled,
setScale,
setSnapToValue |
Methods inherited from class java.awt.Container |
add,
add,
add,
add,
add,
addContainerListener,
addImpl,
countComponents,
deliverEvent,
doLayout,
findComponentAt,
findComponentAt,
getComponent,
getComponentAt,
getComponentAt,
getComponentCount,
getComponents,
getLayout,
insets,
invalidate,
isAncestorOf,
layout,
list,
list,
locate,
minimumSize,
paintComponents,
preferredSize,
print,
printComponents,
processContainerEvent,
processEvent,
remove,
remove,
removeAll,
removeContainerListener,
setCursor,
setLayout,
validate,
validateTree |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int INTERACTION_NONE
public static final int INTERACTION_DRAG
public static final int INTERACTION_CLICK
public static final int INTERACTION_CLICK_DRAG
protected JCNeedle.InteractionType[] interactionTypes
public static final int TICK_DIAMOND
public static final int TICK_TRIANGLE
public static final int TICK_REVERSE_TRIANGLE
public static final int TICK_RECTANGLE
public static final int TICK_LINE
public static final int TICK_CIRCLE
protected JCTickStyle[] tickStyles
public static final int NEEDLE_POINTER
public static final int NEEDLE_TAILED_POINTER
public static final int NEEDLE_ARROW
public static final int NEEDLE_TAILED_ARROW
public static final int NEEDLE_TRIANGLE
protected JCNeedleStyle[] needleStyles
public static final int TYPE_FULL_CIRCLE
public static final int TYPE_TOP_HALF_CIRCLE
public static final int TYPE_BOTTOM_HALF_CIRCLE
public static final int TYPE_LEFT_HALF_CIRCLE
public static final int TYPE_RIGHT_HALF_CIRCLE
public static final int TYPE_UPPER_RIGHT_QUARTER_CIRCLE
public static final int TYPE_LOWER_RIGHT_QUARTER_CIRCLE
public static final int TYPE_UPPER_LEFT_QUARTER_CIRCLE
public static final int TYPE_LOWER_LEFT_QUARTER_CIRCLE
protected JCCircularGauge.GaugeType[] gaugeTypes
public static final int DIRECTION_CLOCKWISE
JCTick
public static final int DIRECTION_COUNTERCLOCKWISE
JCTick
protected JCScale.Direction[] directions
Constructor Detail |
public JCCircularGaugeBean()
Method Detail |
public void addPropertyChangeListener(PropertyChangeListener l)
public void removePropertyChangeListener(PropertyChangeListener l)
public double getCenterRadius()
public void setCenterRadius(double radius)
radius
parameter is a decimal fraction of the scale's radius.radius
- The radius of the center as a proportion of the circular
scale's radius.public Color getCenterColor()
public void setCenterColor(Color color)
color
- the center's colorpublic double getNeedleWidth()
public void setNeedleWidth(double width)
width
- the width in pixelspublic double getNeedleValue()
public void setNeedleValue(double value)
value
- the value at which to pointpublic int getNeedleInteractionType()
JCNeedle.InteractionType
for this needlepublic void setNeedleInteractionType(int type)
interactionType
- The JCNeedle.InteractionType
for this
needle, one of InteractionType NONE
InteractionType DRAG
InteractionType.CLICK
InteractionType CLICK_DRAG
public int getNeedleStyle()
JCNeedleStyle
for this needle.JCNeedleStyle
of this needlepublic void setNeedleStyle(int style)
JCNeedleStyle
for this needle.needleStyle
- The JCNeedleStyle
for this needlepublic Color getNeedleColor()
return
- the color of the needlepublic void setNeedleColor(Color color)
color
- the color of the needlepublic Color getScaleColor()
public void setScaleColor(Color color)
color
- the scale colorpublic double getStartAngle()
public void setStartAngle(double angle)
angle
- set the angle at which the scale starts; angles
increase counterclockwise from 3 o'clock -- 0 degreespublic double getStopAngle()
public void setStopAngle(double angle)
angle
- set the angle at which the scale terminates; angles
increase counterclockwise from 3 o'clock -- 0 degreespublic double getScaleExtent()
public void setScaleExtent(double extent)
extent
- the extentpublic double getScaleMin()
public void setScaleMin(double min)
min
- the value which will appear at the scale's startAnglepublic double getScaleMax()
public void setScaleMax(double max)
max
- the value which will appear at the scale's stopAngle.public boolean getPaintCompleteBackground()
GaugeType
,
not just area swept by scale. For instance, you can have a
scale defined from 0° to 270° for a FULL_CIRCLE
, yet have the full
circle background painted, not just from 0° to 270°. The default is
false.public void setPaintCompleteBackground(boolean b)
GaugeType
,
not just area between the scale's start and stop angles. For instance, a
scale defined from 0° to 270° and having gauge type FULL_CIRCLE
has the full
circular background painted, not just the part from 0° to 270°. The default is
false.paintCompleteBackground
- True means paint all of the background
consistent with the gauge type.public boolean getAutoTickGeneration()
automatic
Boolean for this tick object.startValue
, stopValue
and
incrementValue
are used to lay out ticks.public void setAutoTickGeneration(boolean b)
automatic
Boolean for this tick object.automatic
- The automatic setting for this tick, true means ticks and
increments are dynamically determined by the gauge. Otherwise,
startValue
, stopValue
and
incrementValue
are used to lay out ticks.public double getTickStartValue()
public void setTickStartValue(double value)
startValue
- The startValuepublic double getTickStopValue()
public void setTickStopValue(double value)
stopValue
- The stopValuepublic double getTickIncrement()
incrementValue
along the scale.public void setTickIncrement(double value)
incrementValue
along the scale.incrementValue
- The spacing between adjacent tick markspublic boolean getDrawTickLabels()
public void setDrawTickLabels(boolean b)
drawLabels
- the boolean controlling the drawing of labels.public boolean getDrawTickMarks()
public void setDrawTickMarks(boolean b)
drawTicks
- the boolean controlling the drawing of ticks.public double getTickWidth()
public void setTickWidth(double width)
tickWidth
- The width of the tick to be drawn in pixelspublic double getTickInnerExtent()
public void setTickInnerExtent(double extent)
innerExtent
- The inner extent of the tick markpublic double getTickOuterExtent()
public void setTickOuterExtent(double extent)
outerExtent
- The outerExtent of the tick markpublic int getTickStyle()
JCTickStyle
controlling the shape of the tick.JCTickStyle
public void setTickStyle(int style)
JCTickStyle
controlling the shape of the tick.
Users may define their own tick style, if desired.tickStyle
- One of the built-in tick styles, or a user-supplied styleJCTickStyle
public double getTickLabelExtent()
public void setTickLabelExtent(double extent)
labelExtent
- public Font getTickFont()
public void setTickFont(Font font)
font
- the font in which ticks are to be drawnpublic Color getTickFontColor()
public void setTickFontColor(Color color)
color
- the color in which tick labels will be drawnpublic Color getTickColor()
public void setTickColor(Color color)
color
- the color in which tick marks will be drawnpublic boolean getPrecisionUseDefault()
setPrecision
to label tick marks.setPrecision
.public void setPrecisionUseDefault(boolean b)
setPrecision
to label tick marks.precisionUseDefault
- public int getPrecision()
precisionUseDefault
is set to true.public void setPrecision(int precision)
precisionUseDefault
is set to true.precision
- An integerpublic int getType()
JCCircularGauge
type for this gauge.JCCircularGaugeBean
type of this gaugepublic void setType(int type)
JCCircularGaugeBean
type for this gauge.type
- The JCCircularGaugeBean
type for this gaugepublic int getDirection()
public void setDirection(int direction)
direction
- The direction enum for this gaugepublic int getInteractionTypeIndex(JCNeedle.InteractionType type)
JCNeedle.InteractionType
- the type to lookuppublic int getTickStyleIndex(JCTickStyle style)
JCTickStyle
- for which the index is soughtpublic int getNeedleStyleIndex(JCNeedleStyle style)
JCNeedleStyle
- for which the index is soughtpublic int getGaugeTypeIndex(JCCircularGauge.GaugeType type)
JCCircularGauge.GaugeType
- for which the index is soughtpublic int getDirectionIndex(JCScale.Direction direction)
JCCircularScale.Direction
- for which the index is sought
|
Copyright© 1999-2000 KL Group Inc. All rights reserved. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |