LiveGraph
data visualisation and analysis framework

org.LiveGraph.settings
Enum SettingsEvent

java.lang.Object
  extended by java.lang.Enum<SettingsEvent>
      extended by org.LiveGraph.settings.SettingsEvent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SettingsEvent>, EventType

public enum SettingsEvent
extends java.lang.Enum<SettingsEvent>
implements EventType

This class defines the event types for events that may be raised by any of the LiveGraph settings objects to notify various application components of a changed setting.

Currently, there are 3 settings classes (DataFileSettings, GraphSettings and DataSeriesSettings) and the LiveGraph application holds a unique instance of each of these classes. If either a GUI or a third-party application wishes to change any of the current LiveGraph settings at run-time, it must obtain the appropriate settings object from the LiveGraph application and use one of the provided setter methods. The settings object will change its internal setting value then raise an event to notify all LiveGraph components interested in that particular setting of the changed value.

LiveGraph (http://www.live-graph.org).

Copyright (c) 2007-2008 by G. Paperin.

File: SettingsEvent.java

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following terms and conditions are met:

1. Redistributions of source code must retain the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software or any derived software must display the following acknowledgement:
This product includes software developed by the LiveGraph project and its contributors.
(http://www.live-graph.org)

4. All advertising materials distributed in form of HTML pages or any other technology permitting active hyper-links that mention features or use of this software or any derived software must display the acknowledgment specified in condition 3 of this agreement, and in addition, include a visible and working hyper-link to the LiveGraph homepage (http://www.live-graph.org).

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version:
"2.0.beta01"
Author:
Greg Paperin (http://www.paperin.org)

Enum Constant Summary
DFS_DataFile
          Events of this type are raised by DataFileSettings after changing the data source file; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
DFS_DoNotCacheData
          Events of this type are raised by DataFileSettings after changing data caching setting; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
DFS_Load
          Events of this type are raised by DataFileSettings after loading settings from a file; events of this type are validated before loading the settings, and loading proceeds only if the event is validated by all listeners.
DFS_Save
          Events of this type are raised by DataFileSettings after saving settings to a file; events of this type are validated before saving the settings, and saving proceeds only if the event is validated by all listeners.
DFS_ShowOnlyTailData
          Events of this type are raised by DataFileSettings after changing the setting determining whether to show all or only the tail data; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
DFS_UpdateFrequency
          Events of this type are raised by DataFileSettings after changing the update frequency; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
DSS_Load
          Events of this type are raised by DataSeriesSettings after loading the settings from a file; events of this type are validated before loading, and loading proceeds only if the event is validated by all listeners.
DSS_Save
          Events of this type are raised by DataSeriesSettings after saving the settings to a file; events of this type are validated before saving, and saving proceeds only if the event is validated by all listeners.
DSS_Series_Colour
          Events of this type are raised by DataSeriesSettings after changing the plot colour for a data series; events of this type are validated before changing the colour, and changing proceeds only if the event is validated by all listeners.
DSS_Series_TransformMode
          Events of this type are raised by DataSeriesSettings after changing the values transformation mode for a data series; events of this type are validated before changing the transformation mode, and changing proceeds only if the event is validated by all listeners.
DSS_Series_TransformParam
          Events of this type are raised by DataSeriesSettings after changing the values transformation parameter for a data series; events of this type are validated before changing the values transformation parameter, and changing proceeds only if the event is validated by all listeners.
DSS_Series_Visibility
          Events of this type are raised by DataSeriesSettings after changing the visibility of a data series; events of this type are validated before changing the visibility, and changing proceeds only if the event is validated by all listeners.
DSS_SeriesRange_Visibility
          Events of this type are raised by DataSeriesSettings after changing the visibility of several data series in one go; events of this type are validated before changing the visibility, and changing proceeds only if the event is validated by all listeners.
GS_HGridColour
          Events of this type are raised by GraphSettings after changing the colour of the horisontal grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_HGridSize
          Events of this type are raised by GraphSettings after changing horisontal grid spacing; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_HGridType
          Events of this type are raised by GraphSettings after changing type of the horisontal grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_HighlightDataPoints
          Events of this type are raised by GraphSettings after changing whther of not data points should be highlighted as the mouse is hovered over them; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_Load
          Events of this type are raised by GraphSettings after loading settings from a file; events of this type are validated before loading the settings, and loading proceeds only if the event is validated by all listeners.
GS_MaxX
          Events of this type are raised by GraphSettings after changing right edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_MaxY
          Events of this type are raised by GraphSettings after changing top edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_MinX
          Events of this type are raised by GraphSettings after changing left edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_MinY
          Events of this type are raised by GraphSettings after changing bottom edge of the visible data area events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_Save
          Events of this type are raised by GraphSettings after saving settings to a file; events of this type are validated before saving the settings, and saving proceeds only if the event is validated by all listeners.
GS_VGridColour
          Events of this type are raised by GraphSettings after changing colour of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_VGridSize
          Events of this type are raised by GraphSettings after changing spacing of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_VGridType
          Events of this type are raised by GraphSettings after changing type of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_XAxisParamValue
          Events of this type are raised by GraphSettings after changing transformation parameter for x-axis values; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_XAxisSeriesIndex
          Events of this type are raised by GraphSettings after changing the index of the data series to use as the a-axis; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
GS_XAxisType
          Events of this type are raised by GraphSettings after changing the transformation mode for x-axis values; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.
 
Method Summary
static SettingsEvent valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SettingsEvent[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DFS_Load

public static final SettingsEvent DFS_Load

Events of this type are raised by DataFileSettings after loading settings from a file; events of this type are validated before loading the settings, and loading proceeds only if the event is validated by all listeners.

When issuing events of type DFS_Load, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name


DFS_Save

public static final SettingsEvent DFS_Save

Events of this type are raised by DataFileSettings after saving settings to a file; events of this type are validated before saving the settings, and saving proceeds only if the event is validated by all listeners.

When issuing events of type GS_Save, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name


DFS_DataFile

public static final SettingsEvent DFS_DataFile

Events of this type are raised by DataFileSettings after changing the data source file; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type DFS_DataFile, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name


DFS_ShowOnlyTailData

public static final SettingsEvent DFS_ShowOnlyTailData

Events of this type are raised by DataFileSettings after changing the setting determining whether to show all or only the tail data; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type DFS_ShowOnlyTailData, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() true (tail data) or false (all data)
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


DFS_DoNotCacheData

public static final SettingsEvent DFS_DoNotCacheData

Events of this type are raised by DataFileSettings after changing data caching setting; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type DFS_DoNotCacheData, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() true (don't cache) or false (do cache)
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


DFS_UpdateFrequency

public static final SettingsEvent DFS_UpdateFrequency

Events of this type are raised by DataFileSettings after changing the update frequency; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type DFS_UpdateFrequency, DataFileSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() undate frequency in milliseconds
getInfoDouble() unspecified
getInfoObject() unspecified


GS_Load

public static final SettingsEvent GS_Load

Events of this type are raised by GraphSettings after loading settings from a file; events of this type are validated before loading the settings, and loading proceeds only if the event is validated by all listeners.

When issuing events of type GS_Load, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name


GS_Save

public static final SettingsEvent GS_Save

Events of this type are raised by GraphSettings after saving settings to a file; events of this type are validated before saving the settings, and saving proceeds only if the event is validated by all listeners.

When issuing events of type GS_Save, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name


GS_MinY

public static final SettingsEvent GS_MinY

Events of this type are raised by GraphSettings after changing bottom edge of the visible data area events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_MinY, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() minY (Double.NaN indicates auto)
getInfoObject() unspecified


GS_MaxY

public static final SettingsEvent GS_MaxY

Events of this type are raised by GraphSettings after changing top edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_MaxY, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() maxY (Double.NaN indicates auto)
getInfoObject() unspecified


GS_MinX

public static final SettingsEvent GS_MinX

Events of this type are raised by GraphSettings after changing left edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_MinX, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() minX (Double.NaN indicates auto)
getInfoObject() unspecified


GS_MaxX

public static final SettingsEvent GS_MaxX

Events of this type are raised by GraphSettings after changing right edge of the visible data area; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_MaxX, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() maxX (Double.NaN indicates auto)
getInfoObject() unspecified


GS_VGridType

public static final SettingsEvent GS_VGridType

Events of this type are raised by GraphSettings after changing type of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_VGridType, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a VGridType object


GS_VGridSize

public static final SettingsEvent GS_VGridSize

Events of this type are raised by GraphSettings after changing spacing of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_VGridSize, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() vertical grid spacing
getInfoObject() unspecified


GS_VGridColour

public static final SettingsEvent GS_VGridColour

Events of this type are raised by GraphSettings after changing colour of the vertical grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_VGridColour, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a Color object


GS_HGridType

public static final SettingsEvent GS_HGridType

Events of this type are raised by GraphSettings after changing type of the horisontal grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_HGridType, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a HGridType object


GS_HGridSize

public static final SettingsEvent GS_HGridSize

Events of this type are raised by GraphSettings after changing horisontal grid spacing; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_HGridSize, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() horisontal grid spacing
getInfoObject() unspecified


GS_HGridColour

public static final SettingsEvent GS_HGridColour

Events of this type are raised by GraphSettings after changing the colour of the horisontal grid; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_HGridColour, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a Color object


GS_XAxisType

public static final SettingsEvent GS_XAxisType

Events of this type are raised by GraphSettings after changing the transformation mode for x-axis values; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_XAxisType, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() index of the data series to use as the a-axis
getInfoDouble() the x-axis transformation parameter
getInfoObject() a XAxisType object


GS_XAxisSeriesIndex

public static final SettingsEvent GS_XAxisSeriesIndex

Events of this type are raised by GraphSettings after changing the index of the data series to use as the a-axis; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_XAxisSeriesIndex, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() index of the data series to use as the a-axis
getInfoDouble() the x-axis transformation parameter
getInfoObject() a XAxisType object


GS_XAxisParamValue

public static final SettingsEvent GS_XAxisParamValue

Events of this type are raised by GraphSettings after changing transformation parameter for x-axis values; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_XAxisParamValue, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() index of the data series to use as the a-axis
getInfoDouble() the x-axis transformation parameter
getInfoObject() a XAxisType object


GS_HighlightDataPoints

public static final SettingsEvent GS_HighlightDataPoints

Events of this type are raised by GraphSettings after changing whther of not data points should be highlighted as the mouse is hovered over them; events of this type are validated before changing this settings value, and the change proceeds only if the event is validated by all listeners.

When issuing events of type GS_HighlightDataPoints, GraphSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() true (highlight) or false (don't)
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


DSS_Load

public static final SettingsEvent DSS_Load

Events of this type are raised by DataSeriesSettings after loading the settings from a file; events of this type are validated before loading, and loading proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Load, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the file name

This event type indicates that the data series setttings have been loaded or are about to be loaded from a file.


DSS_Save

public static final SettingsEvent DSS_Save

Events of this type are raised by DataSeriesSettings after saving the settings to a file; events of this type are validated before saving, and saving proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Save, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


DSS_SeriesRange_Visibility

public static final SettingsEvent DSS_SeriesRange_Visibility

Events of this type are raised by DataSeriesSettings after changing the visibility of several data series in one go; events of this type are validated before changing the visibility, and changing proceeds only if the event is validated by all listeners.

When issuing events of type DSS_SeriesRange_Visibility, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() Pair<Integer, Integer>(fromSeries, fromSeries)


DSS_Series_Visibility

public static final SettingsEvent DSS_Series_Visibility

Events of this type are raised by DataSeriesSettings after changing the visibility of a data series; events of this type are validated before changing the visibility, and changing proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Series_Visibility, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() true (show) or false (don't show)
getInfoLong() seriesIndex
getInfoDouble() unspecified
getInfoObject() unspecified


DSS_Series_Colour

public static final SettingsEvent DSS_Series_Colour

Events of this type are raised by DataSeriesSettings after changing the plot colour for a data series; events of this type are validated before changing the colour, and changing proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Series_Colour, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() seriesIndex
getInfoDouble() unspecified
getInfoObject() a Color object for the new color


DSS_Series_TransformMode

public static final SettingsEvent DSS_Series_TransformMode

Events of this type are raised by DataSeriesSettings after changing the values transformation mode for a data series; events of this type are validated before changing the transformation mode, and changing proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Series_TransformMode, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() seriesIndex
getInfoDouble() transformation parameter
getInfoObject() a DataSeriesSettings.TransformMode object


DSS_Series_TransformParam

public static final SettingsEvent DSS_Series_TransformParam

Events of this type are raised by DataSeriesSettings after changing the values transformation parameter for a data series; events of this type are validated before changing the values transformation parameter, and changing proceeds only if the event is validated by all listeners.

When issuing events of type DSS_Series_TransformParam, DataSeriesSettings initialises the event info parameters as follows:

Info parameter Value
getInfoBoolean() unspecified
getInfoLong() seriesIndex
getInfoDouble() transformation parameter
getInfoObject() a DataSeriesSettings.TransformMode object

Method Detail

values

public static SettingsEvent[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SettingsEvent c : SettingsEvent.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SettingsEvent valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

LiveGraph
data visualisation and analysis framework