sonification.dataimport.visbards_resourcetoolkit.model
Interface RangeControllerModel

All Superinterfaces:
SettingsHolder
All Known Implementing Classes:
DefaultRangeControllerModel

public interface RangeControllerModel
extends SettingsHolder


Method Summary
 void addRangeControllerListener(RangeControllerListener listener)
          Registers a listener.
 boolean canUnzoom()
          returns true if the selected range can be unzoomed, false otherwise
 boolean canZoom()
          returns true if the the selected range can be zoomed, false otherwise
 Range getDisplayedRange()
          returns the current displayed time range, i.e.
 double getExtent()
          Returns the model's extent, the length of the inner range that begins at the model's start.
 double getMaximum()
          returns the maximum acceptable value
 double getMinimum()
          returns the minimum acceptable value
 double getMinimumExtent()
          returns the minimum size of the extent
 Range getOverallRange()
          Returns the overall time range, i.e.
 RangeModel getRangeModel()
          returns the associated range model
 Range getSelectedRange()
          Returns the selected time range.
 double getStart()
          returns the start value.
 int getZoomLevel()
          returns the current zoom level.
 boolean isStateAdjusting()
          returns true if the change in state is part of a series of changes.
 boolean isUpdatesContinuous()
          returns true if continuous updates or made, false otherwise
 void removeRangeControllerListener(RangeControllerListener listener)
          Unregisters a listener.
 void setDisplayedRange(Range range)
          set the displayed time range, i.e.
 void setExtent(double extent)
          sets the model's extent
 void setExtent(double extent, boolean startFixed)
          sets the model's extent.
 void setMaximum(double max)
          sets the model's maximum value
 void setMinimum(double min)
          sets the model's minimum value.
 void setMinimumExtent(double min)
          sets the minimum size of the extent
 void setRange(double min, double max, double start, double extent)
          this method sets all of the model's state in a single method call.
 void setRangeModel(RangeModel model)
          set the associated range model
 void setStart(double start)
          sets the model's start
 void setStart(double start, boolean extentFixed)
          sets the model's start.
 void setStateAdjusting(boolean adjusting)
          if set to true, this method indicates that any upcoming changes to the state of the RangeModel are meant to be a series of changes.
 void setUpdatesContinuous(boolean continuous)
          indicates whether continuous updates should be made or not, i.e.
 void unzoom()
          unzoom to the previous level, i.e.
 void zoom()
          zoom in to the next level, i.e.
 
Methods inherited from interface sonification.dataimport.visbards_resourcetoolkit.model.SettingsHolder
getHolderID, getSettings, setSettings
 

Method Detail

getOverallRange

Range getOverallRange()
Returns the overall time range, i.e. the maximum possible selected range


getSelectedRange

Range getSelectedRange()
Returns the selected time range.


setDisplayedRange

void setDisplayedRange(Range range)
set the displayed time range, i.e. the maximum possible selected range within the current display


getDisplayedRange

Range getDisplayedRange()
returns the current displayed time range, i.e. the maximum possible selected range within the current display


getMinimum

double getMinimum()
returns the minimum acceptable value


getMaximum

double getMaximum()
returns the maximum acceptable value


getExtent

double getExtent()
Returns the model's extent, the length of the inner range that begins at the model's start.


getMinimumExtent

double getMinimumExtent()
returns the minimum size of the extent


getStart

double getStart()
returns the start value.


setMinimum

void setMinimum(double min)
sets the model's minimum value.


setMaximum

void setMaximum(double max)
sets the model's maximum value


setExtent

void setExtent(double extent)
sets the model's extent


setExtent

void setExtent(double extent,
               boolean startFixed)
sets the model's extent.

Parameters:
extent - the new extent
startFixed - if true the start stays fixed. Otherwise, the start is changed relative to the new extent

setMinimumExtent

void setMinimumExtent(double min)
sets the minimum size of the extent


setStart

void setStart(double start)
sets the model's start


setStateAdjusting

void setStateAdjusting(boolean adjusting)
if set to true, this method indicates that any upcoming changes to the state of the RangeModel are meant to be a series of changes.


isStateAdjusting

boolean isStateAdjusting()
returns true if the change in state is part of a series of changes. Listeners can check this flag when they receive events if, for performance reasons, they want to wait until the entire update is done before they reflect the changes.


setUpdatesContinuous

void setUpdatesContinuous(boolean continuous)
indicates whether continuous updates should be made or not, i.e. if events should be fired while the user is manipulating the controller


isUpdatesContinuous

boolean isUpdatesContinuous()
returns true if continuous updates or made, false otherwise


setStart

void setStart(double start,
              boolean extentFixed)
sets the model's start.

Parameters:
start - the new start position
extentFixed - if true the extent stays fixed. Otherwise, the extent is changed relative to the new start

setRange

void setRange(double min,
              double max,
              double start,
              double extent)
this method sets all of the model's state in a single method call.


zoom

void zoom()
zoom in to the next level, i.e. make the current scope and selected range equivalent to the current selected range


unzoom

void unzoom()
unzoom to the previous level, i.e. set the properties to the previous selected range contained within the zoom stack


canZoom

boolean canZoom()
returns true if the the selected range can be zoomed, false otherwise


canUnzoom

boolean canUnzoom()
returns true if the selected range can be unzoomed, false otherwise


getZoomLevel

int getZoomLevel()
returns the current zoom level. Note: 0 means the user is not zoomed in


setRangeModel

void setRangeModel(RangeModel model)
set the associated range model


getRangeModel

RangeModel getRangeModel()
returns the associated range model


addRangeControllerListener

void addRangeControllerListener(RangeControllerListener listener)
Registers a listener.


removeRangeControllerListener

void removeRangeControllerListener(RangeControllerListener listener)
Unregisters a listener.