ElegantJ Gauges Java API Specification v1.1

com.elegantj.gauges.dial
Class NumericDialGauge

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Panel
              extended bycom.elegantj.gauges.dial.Dial
                  extended bycom.elegantj.gauges.dial.NumericDialGauge
All Implemented Interfaces:
javax.accessibility.Accessible, java.io.Externalizable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class NumericDialGauge
extends Dial
implements java.io.Externalizable

The numeric dial gauge allows the monitoring of the data continuosly. Properties like minimum and maximum range of angles and the minimum and maximum range of values of any trignometric functions bound the values. This bean can be used to monitor the the real time system components and to control them. This bean facilitates the monitoring of data values visually and can be connected to other components. You can use Timer with this bean to view real time indication

This bean provides powerful designing aspects by providing following user friendly properties
Name represents the name of the gauge
Clockwise represents the rotation of the gauge
NewZoneValues represents the each zone description Each zone has name, low value, high value, zone color , grad value, subgrad value, depth value
DisabledAreaColor represents the area color which has not covered by the zones
DisplayBoxVisibile represents the display box visibility
DisplayBoxColor represents the background color of the display box
DisplayTextColor represents the foreground color of the display box
DisplayText represents the text displayed on display box
DisplayTextFont represents font of the text displayed on display box
DisplayBoxBorder represents border of the display box
DisplayBoxBounds represents the display box boundaries
NeedleVisible represents the indicator visibility
NeedleColor represents the needle color
NeedleLength represents the needle length
NeedleWidth represents the needle width
NeedleTail represents the needle tail length
NeedleType represents the needle type such as linear, arrow, balls
NeedleBorder represents the border of the needle
GradColor represents the grad color
GradLength represents the grad length
GradWidth represents the grad width
GradType represents the grad type such as linear or circular
SubGradColor represents the sub grad color
SubGradLength represents the sub grad length
SubGradWidth represents the sub grad width
SubGradType represents the sub grad type such as linear or circular
Unit represents the unit text to be displayed
UnitColor represents the unit text color
UnitFont represents the unit text font
UnitLocation represents the unit text location
InnerDialColor represents the inner dial color
Maximum represents the maximum value of the dial
Minimum represents the minimum value of the dial
MinimumAngle represents the minimum angle value which is used to display the dial
MaximumAngle represents the maximum angle value which is used to display the dial
Value represents the cuurent value of the dial
GradValuesVisible represents the intermediate values visibility of the zone
FractionLength represents the fraction part length of the numbers to be displayed
BaseColor represents the base circle color
BaseRadius represents the radius of the base circle
BaseDialBorder represents the border of the base circle
InnerDialBorder represents the inner border of the dial
OuterDialBorder represents the outer border of the dial
DialRadius represents the radius of the dial to be displayed
ValueRadius represents the radius of the values to be displayed
GradRadius represents the radius of the grads to be displayed
HeaderVisible represents the header visibility
HeaderText represents the text to be displayed on header
HeaderBackground represents the header background color
HeaderForeground represents the header foreground color
HeaderFont represents the header font
HeaderSpacing represents the spacing above and below the header text
FooterVisible represents the footer visibility
FooterText represents the text to be displayed on footer
FooterBackground represents the footer background color
FooterForeground represents the footer foreground color
FooterFont represents the footer font
FooterSpacing represents the spacing above and below the footer text
ActiveNeedleOn represents the mouse activity to move the needle
KeyboardEnabled represents the keyboard enability to increase or decrease the angle

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Panel
java.awt.Panel.AccessibleAWTPanel
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 com.elegantj.editors.C1 c1
           
 
Fields inherited from class com.elegantj.gauges.dial.Dial
ARROW_NEEDLE, BALLS_NEEDLE, BLOCK_DECREMENT, BLOCK_INCREMENT, circle, CIRCULAR_GRAD, dialImage, LINEAR_ARROW_NEEDLE, LINEAR_CIRCLE_NEEDLE, LINEAR_GRAD, LINEAR_NEEDLE, LOWERED, MAXIMUM, MINIMUM, MOVE_OFF, MOVE_ON_MOUSE_DRAG, MOVE_ON_MOUSE_PRESS, NONE, POINT1, POINT2, POINT3, POINT4, POINT5, RAISED, SIMPLE, UNIT_DECREMENT, UNIT_INCREMENT
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
NumericDialGauge()
           
NumericDialGauge(java.lang.String caption, int size)
           
NumericDialGauge(java.lang.String caption, int size, boolean clockwise)
           
NumericDialGauge(java.lang.String caption, int size, double min, double max)
           
NumericDialGauge(java.lang.String caption, int size, double min, double max, boolean clockwise)
           
NumericDialGauge(java.lang.String caption, int size, double min, double max, double minAngle, double maxAngle, boolean clockwise)
          Creates a NumericDialGauge with specified name, size, minimum value, maximum value, minimum angle, maximum angle and clockwise state.
 
Method Summary
 void addChangeListener(ChangeListener l)
          Adds a ChangeListener
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add a PropertyChangeListener to the listener list.
 void adjustAngle(int type)
          Adjusts the angle with given adjustment angle constant.
protected  Circle createCircle(double cx, double cy, double radius, java.util.Vector new_Zones, double theMaximum, double theMinimum, double maxAngle)
           
protected  Circle createCircle(double cx, double cy, double radius, java.util.Vector new_Zones, double theMaximum, double theMinimum, double minAngle, double maxAngle)
           
protected  Circle createCircle(double cx, double cy, double radius, java.util.Vector new_Zones, double theMaximum, double theMinimum, double minAngle, double maxAngle, boolean clockwise)
          Creates a Circle with specified location, radious, zones, minimum value, maximum value and maximum angle.
protected  Circle createCircle(double cx, double cy, java.util.Vector new_Zones, double theMaximum, double theMinimum, double maxAngle)
           
protected  MeterZone createMeterZone(java.lang.String name_val, double lo_val, double hi_val, java.awt.Color color)
           
protected  MeterZone createMeterZone(java.lang.String name_val, double lo_val, double hi_val, java.awt.Color color, double grad_val, double subgrad_val)
           
protected  MeterZone createMeterZone(java.lang.String name_val, double lo_val, double hi_val, java.awt.Color color, double grad_val, double subgrad_val, double depth_val)
          Creates a MeterZone with specified name, minimum, maximum, color, grad, subgrad and depth values.
static java.util.Vector createVector(java.lang.String str)
          Converts the comma separated string to the vector
protected  void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
          Support for reporting bound property This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.
 void fireValueChange(double oldValue, double newValue)
          Invokes this method when the value has been changed
 double getBaseRadius()
          Gets the base circle's radius.
 java.lang.String getCaption()
          Deprecated. use GetDisplayText
 double getDialRadius()
          Gets the radius of the dial to be displayed.
 java.awt.Rectangle getDisplayBoxBounds()
          Gets the display box boundaries
 int getFractionLength()
          Gets the length of the fraction part of the value
 double getGradRadius()
          Gets the radius of the grads to be displayed.
 java.lang.String getLicenseKey()
          Gets the license key
 java.util.Locale getLocale()
          Returns the value of locale.
 double getMaximum()
          Gets the maximum value for the value range.
 double getMaximumAngle()
          Gets the maximum angle value (degrees) for the angle range.
 double getMinimum()
          Gets the minimum value for the value range.
 double getMinimumAngle()
          Gets the minimum angle value (degrees) for the angle range.
 java.lang.String getName()
          Gets the name or the handle of the object
 java.util.Vector getNewZoneValues()
          Gets the item values from list of the Combobox.
 double getValue()
          Gets the needle value.
 double getValueRadius()
          Gets the radius of the values to be displayed.
 boolean isClockwise()
          Gets the direction of the dial rotation clockwise or anticlockwise
 void readExternal(java.io.ObjectInput in)
           
 void removeChangeListener(ChangeListener l)
          Removes a ChangeListener
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a PropertyChangeListener from the listener list.
 void resetDial()
          Resets the dial by calculating the new values of center and radius.
 void setActiveNeedleOn(int value)
          Sets the mouse activity to move the needle
 void setBackground(java.awt.Color c)
          Sets the Background color.
 void setBaseColor(java.awt.Color theColor)
          Sets the base circle's color
 void setBaseDialBorder(GaugeBorder border)
          Sets the border of the base circle
 void setBaseRadius(double val)
          Sets the base circle's radius.
 void setBounds(int x, int y, int width, int height)
          Moves and resizes this bean.
 void setCaption(java.lang.String s)
          Deprecated. use SetDisplayText
 void setClockwise(boolean value)
          Sets the direction of the dial rotation clockwise or anticlockwise
 void setCursor(java.awt.Cursor c)
          Sets value of the cursor.
 void setDialRadius(double val)
          Sets the radius of the dial to be displayed.
 void setDisabledAreaColor(java.awt.Color theColor)
          Sets the needle color
 void setDisplayBoxBorder(GaugeBorder border)
          Sets the border of the display box
 void setDisplayBoxBounds(java.awt.Rectangle rect)
          Sets the display box boundaries
 void setDisplayBoxColor(java.awt.Color theColor)
          Sets the needle color
 void setDisplayBoxVisible(boolean value)
          Sets the visibility of the display box
 void setDisplayText(java.lang.String text)
          Sets the text displayed on the display box
 void setDisplayTextColor(java.awt.Color theColor)
          Sets the foreground color of the box
 void setDisplayTextFont(java.awt.Font theFont)
          Sets the font of the text displayed on the display box
 void setEnabled(boolean b)
          sets Enablity.
 void setFont(java.awt.Font f)
          Sets the font.
 void setFooterBackground(java.awt.Color theColor)
          Sets the footer background color
 void setFooterFont(java.awt.Font theFont)
          Sets the footer font
 void setFooterForeground(java.awt.Color theColor)
          Sets the footer foreground color
 void setFooterSpacing(double value)
          Sets the spacing above and below the footer text
 void setFooterText(java.lang.String value)
          Sets the text to be displayed on footer
 void setFooterVisible(boolean value)
          Sets the footer visibility
 void setForeground(java.awt.Color c)
          Sets the Foreground color.
 void setFractionLength(int len)
          Sets the length of the fraction part of the value
 void setGradColor(java.awt.Color theColor)
          Sets the grad color
 void setGradLength(double val)
          Sets the grad length.
 void setGradRadius(double val)
          Sets the radius of the grads to be displayed.
 void setGradType(int val)
          Sets the grad type such as linear or circular
 void setGradValuesVisible(boolean value)
          Sets the intermediate values visibility of the zone
 void setGradWidth(double val)
          Sets the grad width.
 void setHeaderBackground(java.awt.Color theColor)
          Sets the header background color
 void setHeaderFont(java.awt.Font theFont)
          Sets the header font
 void setHeaderForeground(java.awt.Color theColor)
          Sets the header foreground color
 void setHeaderSpacing(double value)
          Sets the spacing above and below the header text
 void setHeaderText(java.lang.String value)
          Sets the text to be displayed on header
 void setHeaderVisible(boolean value)
          Sets the header visibility
 void setInnerDialBorder(GaugeBorder border)
          Sets the border of the inner dial gauge
 void setInnerDialColor(java.awt.Color theColor)
          Sets the inner Dial color
 void setKeyboardEnabled(boolean value)
          Sets the enability to increase or decrease the angle value by keyboard navigation
 void setLicenseKey(java.lang.String key)
          Sets the license key
 void setLocale(java.util.Locale l)
          Sets value of the locale.
 void setMaximum(double m)
          Sets the maximum value of the dial
 void setMaximumAngle(double m)
          Sets the maximum angle value (degrees) for the angle range.
 void setMinimum(double m)
          Sets the minimum value of the dial
 void setMinimumAngle(double m)
          Sets the minimum angle value (degrees) for the angle range.
 void setName(java.lang.String n)
          Sets the name or the handle of the object
 void setNeedleBorder(GaugeBorder border)
          Sets the border of the needle
 void setNeedleColor(java.awt.Color theColor)
          Sets the needle color
 void setNeedleLength(double val)
          Sets the needle length.
 void setNeedleTail(double val)
          Sets the needle tail length.
 void setNeedleType(int val)
          Sets the needle type
 void setNeedleVisible(boolean value)
          Sets the needle visible status
 void setNeedleWidth(double val)
          Sets the needle width.
 void setNewZoneValues(java.lang.String str)
          Sets the item values in the list of the Combobox.
 void setNewZoneValues(java.util.Vector oVect)
          Sets the item values in the list of the Combobox.
 void setOuterDialBorder(GaugeBorder border)
          Sets the border of the outer dial gauge
 void setPointValue(int x, int y)
          Sets the value of the given point co-ordinates
 void setSubGradColor(java.awt.Color theColor)
          Sets the subgrad color
 void setSubGradLength(double val)
          Sets the subgrad length.
 void setSubGradType(int val)
          Sets the subgrad type such as linear or circular
 void setSubGradWidth(double val)
          Sets the subgrad width.
 void setUnit(java.lang.String n)
          Sets the Unit
 void setUnitColor(java.awt.Color theColor)
          Sets the Unit text color
 void setUnitFont(java.awt.Font theFont)
          Sets the Unit text font
 void setUnitLocation(java.awt.Point thePoint)
          Sets the Unit text location.
 void setValue(double val)
          Sets the needle value.
 void setValueRadius(double val)
          Sets the radius of the values to be displayed.
 void setVisible(boolean b)
          sets Visiblity.
 java.lang.String toString()
          Returns string representation of this bean
 void writeExternal(java.io.ObjectOutput out)
          Externalizable interface implementation to save and retrieve the state of this bean
 
Methods inherited from class com.elegantj.gauges.dial.Dial
allocImage, extraHeight, extraWidth, getActiveNeedleOn, getBaseColor, getBaseDialBorder, getBlockIncrement, getDisabledAreaColor, getDisplayBoxBorder, getDisplayBoxColor, getDisplayText, getDisplayTextColor, getDisplayTextFont, getFooterBackground, getFooterFont, getFooterForeground, getFooterHeight, getFooterSpacing, getFooterText, getGradColor, getGradLength, getGradType, getGradWidth, getHeaderBackground, getHeaderFont, getHeaderForeground, getHeaderHeight, getHeaderSpacing, getHeaderText, getInnerDialBorder, getInnerDialColor, getNeedleBorder, getNeedleColor, getNeedleLength, getNeedleTail, getNeedleType, getNeedleWidth, getOuterDialBorder, getPreferredSize, getSubGradColor, getSubGradLength, getSubGradType, getSubGradWidth, getUnit, getUnitColor, getUnitFont, getUnitIncrement, getUnitLocation, isDisplayBoxVisible, isFocusTraversable, isFooterVisible, isGradValuesVisible, isHeaderVisible, isKeyboardEnabled, isLightweight, isNeedleVisible, paint, processKeyEvent, processMouseEvent, processMouseMotionEvent, renderCustomFeatures, renderDial, setNewValues, setNewValues, update
 
Methods inherited from class java.awt.Panel
addNotify, getAccessibleContext
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFontSet, isForegroundSet, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

c1

public transient com.elegantj.editors.C1 c1
Constructor Detail

NumericDialGauge

public NumericDialGauge()

NumericDialGauge

public NumericDialGauge(java.lang.String caption,
                        int size)

NumericDialGauge

public NumericDialGauge(java.lang.String caption,
                        int size,
                        boolean clockwise)

NumericDialGauge

public NumericDialGauge(java.lang.String caption,
                        int size,
                        double min,
                        double max)

NumericDialGauge

public NumericDialGauge(java.lang.String caption,
                        int size,
                        double min,
                        double max,
                        boolean clockwise)

NumericDialGauge

public NumericDialGauge(java.lang.String caption,
                        int size,
                        double min,
                        double max,
                        double minAngle,
                        double maxAngle,
                        boolean clockwise)
Creates a NumericDialGauge with specified name, size, minimum value, maximum value, minimum angle, maximum angle and clockwise state. Size and the values of minimum and maximum to be represented on a dial or the direction in which it should be rotated and the minimum and maximum range of angles.

Parameters:
caption - represents dial caption, default Dial Gauge
size - dial diameter, default 320
min - dial minimum value, default 0
max - dial maximum value, default 100
minAngle - dial minimum angle, default 0
maxAngle - dial maximum angle, default 360
clockwise - it represents how values can be grown, default false
Method Detail

setLicenseKey

public void setLicenseKey(java.lang.String key)
Sets the license key

Parameters:
key - the license key

getLicenseKey

public java.lang.String getLicenseKey()
Gets the license key

Returns:
the license key

createCircle

protected Circle createCircle(double cx,
                              double cy,
                              java.util.Vector new_Zones,
                              double theMaximum,
                              double theMinimum,
                              double maxAngle)

createCircle

protected Circle createCircle(double cx,
                              double cy,
                              double radius,
                              java.util.Vector new_Zones,
                              double theMaximum,
                              double theMinimum,
                              double maxAngle)

createCircle

protected Circle createCircle(double cx,
                              double cy,
                              double radius,
                              java.util.Vector new_Zones,
                              double theMaximum,
                              double theMinimum,
                              double minAngle,
                              double maxAngle)

createCircle

protected Circle createCircle(double cx,
                              double cy,
                              double radius,
                              java.util.Vector new_Zones,
                              double theMaximum,
                              double theMinimum,
                              double minAngle,
                              double maxAngle,
                              boolean clockwise)
Creates a Circle with specified location, radious, zones, minimum value, maximum value and maximum angle.

Parameters:
cx - x-cordinate of the circle's center
radius - radius of the circle, default 100.0
new_Zones - zones description
theMaximum - maximum value
theMinimum - minimum value
minAngle - minimum angle of the circle
maxAngle - maximum angle of the circle
clockwise - rotation of the circle's value

createMeterZone

protected MeterZone createMeterZone(java.lang.String name_val,
                                    double lo_val,
                                    double hi_val,
                                    java.awt.Color color)

createMeterZone

protected MeterZone createMeterZone(java.lang.String name_val,
                                    double lo_val,
                                    double hi_val,
                                    java.awt.Color color,
                                    double grad_val,
                                    double subgrad_val)

createMeterZone

protected MeterZone createMeterZone(java.lang.String name_val,
                                    double lo_val,
                                    double hi_val,
                                    java.awt.Color color,
                                    double grad_val,
                                    double subgrad_val,
                                    double depth_val)
Creates a MeterZone with specified name, minimum, maximum, color, grad, subgrad and depth values.

Parameters:
name_val - name of the zone
lo_val - low value of the zone
hi_val - high value of the zone
color - color of the zone
grad_val - grad value of the zone , default 0.0
subgrad_val - subgrad value of the zone , default 0.0
depth_val - depth value of the zone , default 0.0

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)
Moves and resizes this bean. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height.

Parameters:
x - x-coordinate of this bean.
y - y-coordinate of this bean.
width - the new width of this bean.
height - the new height of this bean.

resetDial

public void resetDial()
Resets the dial by calculating the new values of center and radius.


setName

public void setName(java.lang.String n)
Sets the name or the handle of the object

Parameters:
n - A string specifies the name of the object

getName

public java.lang.String getName()
Gets the name or the handle of the object

Returns:
String specifies the name of the object

setBaseColor

public void setBaseColor(java.awt.Color theColor)
Sets the base circle's color

Overrides:
setBaseColor in class Dial
Parameters:
theColor - color type specifies the color from the graphics context

setBaseDialBorder

public void setBaseDialBorder(GaugeBorder border)
Sets the border of the base circle

Overrides:
setBaseDialBorder in class Dial
Parameters:
border - the border of the base circle

setNeedleVisible

public void setNeedleVisible(boolean value)
Sets the needle visible status

Overrides:
setNeedleVisible in class Dial
Parameters:
value - boolean type true specifies the needle status visible

setNeedleColor

public void setNeedleColor(java.awt.Color theColor)
Sets the needle color

Overrides:
setNeedleColor in class Dial
Parameters:
theColor - color type specifies the color from the graphics context

setNeedleLength

public void setNeedleLength(double val)
Sets the needle length. Considers default value, if it is -1

Overrides:
setNeedleLength in class Dial
Parameters:
val - the needle length

setNeedleWidth

public void setNeedleWidth(double val)
Sets the needle width. Considers default value, if it is -1

Overrides:
setNeedleWidth in class Dial
Parameters:
val - the needle width

setNeedleTail

public void setNeedleTail(double val)
Sets the needle tail length. Considers default value, if it is -1

Overrides:
setNeedleTail in class Dial
Parameters:
val - the needle tail length

setNeedleType

public void setNeedleType(int val)
Sets the needle type

Overrides:
setNeedleType in class Dial
Parameters:
val - the needle type

setNeedleBorder

public void setNeedleBorder(GaugeBorder border)
Sets the border of the needle

Overrides:
setNeedleBorder in class Dial
Parameters:
border - the border of the needle

setDisplayBoxVisible

public void setDisplayBoxVisible(boolean value)
Sets the visibility of the display box

Overrides:
setDisplayBoxVisible in class Dial
Parameters:
value - the visibility of the display box

setDisplayBoxColor

public void setDisplayBoxColor(java.awt.Color theColor)
Sets the needle color

Overrides:
setDisplayBoxColor in class Dial
Parameters:
theColor - the color from the graphics context

setDisplayTextColor

public void setDisplayTextColor(java.awt.Color theColor)
Sets the foreground color of the box

Overrides:
setDisplayTextColor in class Dial
Parameters:
theColor - the foreground color of the box

setDisplayTextFont

public void setDisplayTextFont(java.awt.Font theFont)
Sets the font of the text displayed on the display box

Overrides:
setDisplayTextFont in class Dial
Parameters:
theFont - the font of the text displayed on the display box

setDisplayText

public void setDisplayText(java.lang.String text)
Sets the text displayed on the display box

Overrides:
setDisplayText in class Dial
Parameters:
text - the text displayed on the display box

setDisplayBoxBorder

public void setDisplayBoxBorder(GaugeBorder border)
Sets the border of the display box

Overrides:
setDisplayBoxBorder in class Dial
Parameters:
border - the border of the display box

setDisabledAreaColor

public void setDisabledAreaColor(java.awt.Color theColor)
Sets the needle color

Overrides:
setDisabledAreaColor in class Dial
Parameters:
theColor - the color from the graphics context

setGradColor

public void setGradColor(java.awt.Color theColor)
Sets the grad color

Overrides:
setGradColor in class Dial
Parameters:
theColor - the color from the graphics context

setGradLength

public void setGradLength(double val)
Sets the grad length. Considers default value, if it is -1

Overrides:
setGradLength in class Dial
Parameters:
val - the grad length

setGradWidth

public void setGradWidth(double val)
Sets the grad width. Considers default value, if it is -1

Overrides:
setGradWidth in class Dial
Parameters:
val - the grad width

setGradType

public void setGradType(int val)
Sets the grad type such as linear or circular

Overrides:
setGradType in class Dial
Parameters:
val - the grad type

setSubGradColor

public void setSubGradColor(java.awt.Color theColor)
Sets the subgrad color

Overrides:
setSubGradColor in class Dial
Parameters:
theColor - the color from the graphics context

setSubGradLength

public void setSubGradLength(double val)
Sets the subgrad length. Considers default value, if it is -1

Overrides:
setSubGradLength in class Dial
Parameters:
val - the subgrad length

setSubGradWidth

public void setSubGradWidth(double val)
Sets the subgrad width. Considers default value, if it is -1

Overrides:
setSubGradWidth in class Dial
Parameters:
val - the subgrad width

setSubGradType

public void setSubGradType(int val)
Sets the subgrad type such as linear or circular

Overrides:
setSubGradType in class Dial
Parameters:
val - the subgrad type

setInnerDialColor

public void setInnerDialColor(java.awt.Color theColor)
Sets the inner Dial color

Overrides:
setInnerDialColor in class Dial
Parameters:
theColor - the color from the graphics context

setInnerDialBorder

public void setInnerDialBorder(GaugeBorder border)
Sets the border of the inner dial gauge

Overrides:
setInnerDialBorder in class Dial
Parameters:
border - the border of the inner dial gauge

setUnit

public void setUnit(java.lang.String n)
Sets the Unit

Overrides:
setUnit in class Dial

setUnitColor

public void setUnitColor(java.awt.Color theColor)
Sets the Unit text color

Overrides:
setUnitColor in class Dial
Parameters:
theColor - a Color specifies the unit text color

setUnitFont

public void setUnitFont(java.awt.Font theFont)
Sets the Unit text font

Overrides:
setUnitFont in class Dial
Parameters:
theFont - a Font specifies the unit text font

setUnitLocation

public void setUnitLocation(java.awt.Point thePoint)
Sets the Unit text location. Considers default value, if it is -1, -1

Overrides:
setUnitLocation in class Dial
Parameters:
thePoint - a Point specifies the unit text location

setCaption

public void setCaption(java.lang.String s)
Deprecated. use SetDisplayText

Sets the caption string for the dial

Parameters:
s - the caption string

getCaption

public java.lang.String getCaption()
Deprecated. use GetDisplayText

Gets the caption string for the dial


setGradValuesVisible

public void setGradValuesVisible(boolean value)
Sets the intermediate values visibility of the zone

Overrides:
setGradValuesVisible in class Dial
Parameters:
value - the intermediate values visibility of the zone . If it is true, intermediate values will be visible

setMinimumAngle

public void setMinimumAngle(double m)
Sets the minimum angle value (degrees) for the angle range.

Parameters:
m - double type true specifies double angle value

getMinimumAngle

public double getMinimumAngle()
Gets the minimum angle value (degrees) for the angle range.

Returns:
double type true specifies double angle value

setMaximumAngle

public void setMaximumAngle(double m)
Sets the maximum angle value (degrees) for the angle range.

Parameters:
m - double type true specifies double angle value

getMaximumAngle

public double getMaximumAngle()
Gets the maximum angle value (degrees) for the angle range.

Returns:
double type true specifies double angle value

setMinimum

public void setMinimum(double m)
Sets the minimum value of the dial

Parameters:
m - double type true specifies double value

getMinimum

public double getMinimum()
Gets the minimum value for the value range.

Returns:
double type true specifies double value to be represented

setMaximum

public void setMaximum(double m)
Sets the maximum value of the dial

Parameters:
m - double type true specifies double value

getMaximum

public double getMaximum()
Gets the maximum value for the value range.

Returns:
double type true specifies double value to be represented

setFractionLength

public void setFractionLength(int len)
Sets the length of the fraction part of the value

Parameters:
len - the length of the fraction part of the value

getFractionLength

public int getFractionLength()
Gets the length of the fraction part of the value

Returns:
the length of the fraction part of the value

setBaseRadius

public void setBaseRadius(double val)
Sets the base circle's radius. Considers default value, if it is -1

Parameters:
val - the base circle's radius

getBaseRadius

public double getBaseRadius()
Gets the base circle's radius.

Returns:
the base circle's radius

setValueRadius

public void setValueRadius(double val)
Sets the radius of the values to be displayed. Considers default value, if it is -1

Parameters:
val - the value radius

getValueRadius

public double getValueRadius()
Gets the radius of the values to be displayed.

Returns:
the value radius

setGradRadius

public void setGradRadius(double val)
Sets the radius of the grads to be displayed. Considers default value, if it is -1

Parameters:
val - the grad radius

getGradRadius

public double getGradRadius()
Gets the radius of the grads to be displayed.

Returns:
the grad radius

setDialRadius

public void setDialRadius(double val)
Sets the radius of the dial to be displayed. Considers default value, if it is -1

Parameters:
val - the dial radius

getDialRadius

public double getDialRadius()
Gets the radius of the dial to be displayed.

Returns:
the dial radius

setOuterDialBorder

public void setOuterDialBorder(GaugeBorder border)
Sets the border of the outer dial gauge

Overrides:
setOuterDialBorder in class Dial
Parameters:
border - the border of the outer dial gauge

setDisplayBoxBounds

public void setDisplayBoxBounds(java.awt.Rectangle rect)
Sets the display box boundaries

Parameters:
rect - the rectangle contains the display box boundaries, considers default values, if the rectangle is -1,-1,-1,-1

getDisplayBoxBounds

public java.awt.Rectangle getDisplayBoxBounds()
Gets the display box boundaries

Returns:
the rectangle contains the display box boundaries

setHeaderVisible

public void setHeaderVisible(boolean value)
Sets the header visibility

Overrides:
setHeaderVisible in class Dial
Parameters:
value - true to visible the header

setHeaderText

public void setHeaderText(java.lang.String value)
Sets the text to be displayed on header

Overrides:
setHeaderText in class Dial
Parameters:
value - the header text

setHeaderBackground

public void setHeaderBackground(java.awt.Color theColor)
Sets the header background color

Overrides:
setHeaderBackground in class Dial
Parameters:
theColor - the header background color

setHeaderForeground

public void setHeaderForeground(java.awt.Color theColor)
Sets the header foreground color

Overrides:
setHeaderForeground in class Dial
Parameters:
theColor - the header foreground color

setHeaderFont

public void setHeaderFont(java.awt.Font theFont)
Sets the header font

Overrides:
setHeaderFont in class Dial
Parameters:
theFont - the header font

setHeaderSpacing

public void setHeaderSpacing(double value)
Sets the spacing above and below the header text

Overrides:
setHeaderSpacing in class Dial
Parameters:
value - the spacing above and below the header text

setFooterVisible

public void setFooterVisible(boolean value)
Sets the footer visibility

Overrides:
setFooterVisible in class Dial
Parameters:
value - true to visible the footer

setFooterText

public void setFooterText(java.lang.String value)
Sets the text to be displayed on footer

Overrides:
setFooterText in class Dial
Parameters:
value - the footer text

setFooterBackground

public void setFooterBackground(java.awt.Color theColor)
Sets the footer background color

Overrides:
setFooterBackground in class Dial
Parameters:
theColor - the footer background color

setFooterForeground

public void setFooterForeground(java.awt.Color theColor)
Sets the footer foreground color

Overrides:
setFooterForeground in class Dial
Parameters:
theColor - the footer foreground color

setFooterFont

public void setFooterFont(java.awt.Font theFont)
Sets the footer font

Overrides:
setFooterFont in class Dial
Parameters:
theFont - the footer font

setFooterSpacing

public void setFooterSpacing(double value)
Sets the spacing above and below the footer text

Overrides:
setFooterSpacing in class Dial
Parameters:
value - the spacing above and below the footer text

setActiveNeedleOn

public void setActiveNeedleOn(int value)
Sets the mouse activity to move the needle

Overrides:
setActiveNeedleOn in class Dial
Parameters:
value - the mouse activity to move the needle

setKeyboardEnabled

public void setKeyboardEnabled(boolean value)
Sets the enability to increase or decrease the angle value by keyboard navigation

Overrides:
setKeyboardEnabled in class Dial
Parameters:
value - true to enable the keyboard navigation

setPointValue

public void setPointValue(int x,
                          int y)
Sets the value of the given point co-ordinates

Overrides:
setPointValue in class Dial

adjustAngle

public void adjustAngle(int type)
Adjusts the angle with given adjustment angle constant.

Overrides:
adjustAngle in class Dial
Parameters:
type - the one of the constants : UNIT_INCREMENT, UNIT_DECREMENT, BLOCK_INCREMENT, BLOCK_DECREMENT, MAXIMUM, MINIMUM

setValue

public void setValue(double val)
Sets the needle value.

Parameters:
val - the current needle value

getValue

public double getValue()
Gets the needle value.

Returns:
the current needle value

setClockwise

public void setClockwise(boolean value)
Sets the direction of the dial rotation clockwise or anticlockwise

Parameters:
value - boolean type true specifies double clockwise direction

isClockwise

public boolean isClockwise()
Gets the direction of the dial rotation clockwise or anticlockwise

Returns:
boolean type true specifies double clockwise direction

setNewZoneValues

public void setNewZoneValues(java.util.Vector oVect)
Sets the item values in the list of the Combobox.

Parameters:
oVect - Vector type object containing the list of items

getNewZoneValues

public java.util.Vector getNewZoneValues()
Gets the item values from list of the Combobox.

Returns:
Vector type object containing the list of items

setNewZoneValues

public void setNewZoneValues(java.lang.String str)
Sets the item values in the list of the Combobox.

Parameters:
str - String type object containing the list of items

setForeground

public void setForeground(java.awt.Color c)
Sets the Foreground color.


setBackground

public void setBackground(java.awt.Color c)
Sets the Background color.


setFont

public void setFont(java.awt.Font f)
Sets the font.


setVisible

public void setVisible(boolean b)
sets Visiblity.

Parameters:
b - flag representing visibility of bean.

setEnabled

public void setEnabled(boolean b)
sets Enablity.

Parameters:
b - flag representing enability of bean.

setLocale

public void setLocale(java.util.Locale l)
Sets value of the locale.

Parameters:
l - current value of the locale.

getLocale

public java.util.Locale getLocale()
Returns the value of locale.

Returns:
the current value of locale

setCursor

public void setCursor(java.awt.Cursor c)
Sets value of the cursor.

Parameters:
c - current value of the cursor.

addChangeListener

public void addChangeListener(ChangeListener l)
Adds a ChangeListener


removeChangeListener

public void removeChangeListener(ChangeListener l)
Removes a ChangeListener


fireValueChange

public void fireValueChange(double oldValue,
                            double newValue)
Invokes this method when the value has been changed

Parameters:
oldValue - the old value
newValue - the new (changed) value

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired in response to an explicit setFont, setBackground, or SetForeground on the current component. Note that if the current component is inheriting its foreground, background, or font from its container, then no event will be fired in response to a change in the inherited property. If listener is null, no exception is thrown and no action is performed.

Parameters:
listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener is null, no exception is thrown and no action is performed.

Parameters:
listener - The PropertyChangeListener to be removed

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)
Support for reporting bound property This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.


writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Externalizable interface implementation to save and retrieve the state of this bean

Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.lang.ClassNotFoundException,
                         java.io.IOException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.lang.ClassNotFoundException
java.io.IOException

toString

public java.lang.String toString()
Returns string representation of this bean

Returns:
string representaion of this bean

createVector

public static java.util.Vector createVector(java.lang.String str)
Converts the comma separated string to the vector

Parameters:
str - the comma separated string
Returns:
the vector containing elements are the strings which are comma separated in str

ElegantJ Gauges Java API Specification v1.1

Submit a bug or feature

Copyright(c)
Elegant Microweb Technologies Pvt. Ltd.
www.elegantmicroweb.com
www.elegantjcharts.com
All Rights Reserved.