Worksheet (binjr 1.6.0 API)

java.lang.Object
- eu.fthevenet.binjr.data.workspace.Worksheet<T>

All Implemented Interfaces:

Dirtyable, java.lang.AutoCloseable
```
public class Worksheet<T>
extends java.lang.Object
implements Dirtyable, java.lang.AutoCloseable
```
A class that represents and holds the current state of a single worksheet

Author:

Frederic Thevenet

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.Property<ChartLayout>`	`chartLayout`
`javafx.beans.property.BooleanProperty`	`dirty` A `BooleanProperty` that observes the changes made to the `Dirtyable` instance
`javafx.beans.property.Property<java.time.ZonedDateTime>`	`fromDateTime` The lower bound of the time interval of the `Worksheet`'s times series
`javafx.beans.property.Property<java.lang.String>`	`name` The name of the `Worksheet`
`javafx.beans.property.Property<java.lang.Integer>`	`selectedChart`
`javafx.beans.property.Property<java.time.ZoneId>`	`timeZone` The `ZoneId` used by the `Worksheet` time series
`javafx.beans.property.Property<java.time.ZonedDateTime>`	`toDateTime` The upper bound of the time interval of the `Worksheet`'s times series

Constructor Summary

Constructors
Constructor and Description
`Worksheet()` Initializes a new instance of the `Worksheet` class
`Worksheet(java.lang.String name, java.util.List<Chart<T>> charts, java.time.ZoneId timezone, java.time.ZonedDateTime fromDateTime, java.time.ZonedDateTime toDateTime)`
`Worksheet(java.lang.String name, java.time.ZonedDateTime fromDateTime, java.time.ZonedDateTime toDateTime, java.time.ZoneId timezone)` Initializes a new instance of the `Worksheet` class with the provided name, chart type and zoneid
`Worksheet(Worksheet<T> initWorksheet)` Copy constructor to deep clone a `Worksheet` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.beans.property.Property<ChartLayout>`	`chartLayoutProperty()`
`void`	`cleanUp()` Clear the dirty status of the `Dirtyable` instance
`void`	`close()`
`javafx.beans.property.BooleanProperty`	`dirtyProperty()` A `BooleanProperty` that observes the changes made to the `Dirtyable` instance
`javafx.beans.property.Property<java.time.ZonedDateTime>`	`fromDateTimeProperty()` The lower bound of the time interval of the `Worksheet`'s times series
`WorksheetNavigationHistory`	`getBackwardHistory()`
`ChartLayout`	`getChartLayout()` Gets the value of the property chartLayout.
`javafx.collections.ObservableList<Chart<T>>`	`getCharts()`
`Chart<T>`	`getDefaultChart()`
`WorksheetNavigationHistory`	`getForwardHistory()`
`java.time.ZonedDateTime`	`getFromDateTime()` The lower bound of the time interval of the `Worksheet`'s times series
`java.lang.String`	`getName()` The name of the `Worksheet`
`java.util.Map<Chart<java.lang.Double>,XYChartSelection<java.time.ZonedDateTime,java.lang.Double>>`	`getPreviousState()`
`java.lang.Integer`	`getSelectedChart()` Gets the value of the property selectedChart.
`java.time.ZoneId`	`getTimeZone()` The `ZoneId` used by the `Worksheet` time series
`java.time.ZonedDateTime`	`getToDateTime()` The upper bound of the time interval of the `Worksheet`'s times series
`java.lang.Boolean`	`isDirty()` Gets the value of the property dirty.
`javafx.beans.property.Property<java.lang.String>`	`nameProperty()` The name of the `Worksheet`
`javafx.beans.property.Property<java.lang.Integer>`	`selectedChartProperty()`
`void`	`setChartLayout(ChartLayout chartLayout)` Sets the value of the property chartLayout.
`void`	`setCharts(javafx.collections.ObservableList<Chart<T>> charts)`
`void`	`setFromDateTime(java.time.ZonedDateTime fromDateTime)` The lower bound of the time interval of the `Worksheet`'s times series
`void`	`setName(java.lang.String name)` The name of the `Worksheet`
`void`	`setPreviousState(java.util.Map<Chart<java.lang.Double>,XYChartSelection<java.time.ZonedDateTime,java.lang.Double>> previousState)`
`void`	`setSelectedChart(java.lang.Integer selectedChart)` Sets the value of the property selectedChart.
`void`	`setTimeZone(java.time.ZoneId timeZone)` The `ZoneId` used by the `Worksheet` time series
`void`	`setToDateTime(java.time.ZonedDateTime toDateTime)` The upper bound of the time interval of the `Worksheet`'s times series
`javafx.beans.property.Property<java.time.ZoneId>`	`timeZoneProperty()` The `ZoneId` used by the `Worksheet` time series
`javafx.beans.property.Property<java.time.ZonedDateTime>`	`toDateTimeProperty()` The upper bound of the time interval of the `Worksheet`'s times series
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - name
```
public javafx.beans.property.Property<java.lang.String> nameProperty
```
    The name of the Worksheet
    
    See Also:
    
    getName(), setName(String)
  - timeZone
```
public javafx.beans.property.Property<java.time.ZoneId> timeZoneProperty
```
    The ZoneId used by the Worksheet time series
    
    See Also:
    
    getTimeZone(), setTimeZone(ZoneId)
  - fromDateTime
```
public javafx.beans.property.Property<java.time.ZonedDateTime> fromDateTimeProperty
```
    The lower bound of the time interval of the Worksheet's times series
    
    See Also:
    
    getFromDateTime(), setFromDateTime(ZonedDateTime)
  - toDateTime
```
public javafx.beans.property.Property<java.time.ZonedDateTime> toDateTimeProperty
```
    The upper bound of the time interval of the Worksheet's times series
    
    See Also:
    
    getToDateTime(), setToDateTime(ZonedDateTime)
  - selectedChart
```
public javafx.beans.property.Property<java.lang.Integer> selectedChartProperty
```
    See Also:
    
    getSelectedChart(), setSelectedChart(Integer)
  - dirty
```
public javafx.beans.property.BooleanProperty dirtyProperty
```
    Specified by:
    
    dirtyProperty in interface Dirtyable
    
    See Also:
    
    isDirty()
  - chartLayout
```
public javafx.beans.property.Property<ChartLayout> chartLayoutProperty
```
    See Also:
    
    getChartLayout(), setChartLayout(ChartLayout)
- Constructor Detail
  - Worksheet
```
public Worksheet()
```
    Initializes a new instance of the Worksheet class
  - Worksheet
```
public Worksheet(java.lang.String name,
                 java.time.ZonedDateTime fromDateTime,
                 java.time.ZonedDateTime toDateTime,
                 java.time.ZoneId timezone)
```
    Initializes a new instance of the Worksheet class with the provided name, chart type and zoneid
    
    Parameters:
    
    name - the name for the new Worksheet instance
    
    timezone - the ZoneId for the new Worksheet instance
  - Worksheet
```
public Worksheet(Worksheet<T> initWorksheet)
```
    Copy constructor to deep clone a Worksheet instance.
    
    Parameters:
    
    initWorksheet - the Worksheet instance to clone.
  - Worksheet
```
public Worksheet(java.lang.String name,
                 java.util.List<Chart<T>> charts,
                 java.time.ZoneId timezone,
                 java.time.ZonedDateTime fromDateTime,
                 java.time.ZonedDateTime toDateTime)
```
- Method Detail
  - getDefaultChart
```
public Chart<T> getDefaultChart()
```
  - getName
```
public java.lang.String getName()
```
    The name of the Worksheet
    
    Returns:
    
    the name of the Worksheet
  - nameProperty
```
public javafx.beans.property.Property<java.lang.String> nameProperty()
```
    The name of the Worksheet
    
    See Also:
    
    getName(), setName(String)
  - setName
```
public void setName(java.lang.String name)
```
    The name of the Worksheet
    
    Parameters:
    
    name - the name of the Worksheet
  - getTimeZone
```
public java.time.ZoneId getTimeZone()
```
    The ZoneId used by the Worksheet time series
    
    Returns:
    
    the ZoneId used by the Worksheet time series
  - timeZoneProperty
```
public javafx.beans.property.Property<java.time.ZoneId> timeZoneProperty()
```
    The ZoneId used by the Worksheet time series
    
    See Also:
    
    getTimeZone(), setTimeZone(ZoneId)
  - setTimeZone
```
public void setTimeZone(java.time.ZoneId timeZone)
```
    The ZoneId used by the Worksheet time series
    
    Parameters:
    
    timeZone - the ZoneId used by the Worksheet time series
  - getFromDateTime
```
public java.time.ZonedDateTime getFromDateTime()
```
    The lower bound of the time interval of the Worksheet's times series
    
    Returns:
    
    the lower bound of the time interval of the Worksheet's times series
  - fromDateTimeProperty
```
public javafx.beans.property.Property<java.time.ZonedDateTime> fromDateTimeProperty()
```
    The lower bound of the time interval of the Worksheet's times series
    
    See Also:
    
    getFromDateTime(), setFromDateTime(ZonedDateTime)
  - setFromDateTime
```
public void setFromDateTime(java.time.ZonedDateTime fromDateTime)
```
    The lower bound of the time interval of the Worksheet's times series
    
    Parameters:
    
    fromDateTime - the lower bound of the time interval of the Worksheet's times series
  - getToDateTime
```
public java.time.ZonedDateTime getToDateTime()
```
    The upper bound of the time interval of the Worksheet's times series
    
    Returns:
    
    the upper bound of the time interval of the Worksheet's times series
  - toDateTimeProperty
```
public javafx.beans.property.Property<java.time.ZonedDateTime> toDateTimeProperty()
```
    The upper bound of the time interval of the Worksheet's times series
    
    See Also:
    
    getToDateTime(), setToDateTime(ZonedDateTime)
  - setToDateTime
```
public void setToDateTime(java.time.ZonedDateTime toDateTime)
```
    The upper bound of the time interval of the Worksheet's times series
    
    Parameters:
    
    toDateTime - the upper bound of the time interval of the Worksheet's times series
  - getSelectedChart
```
public java.lang.Integer getSelectedChart()
```
    Gets the value of the property selectedChart.
  - selectedChartProperty
```
public javafx.beans.property.Property<java.lang.Integer> selectedChartProperty()
```
    See Also:
    
    getSelectedChart(), setSelectedChart(Integer)
  - setSelectedChart
```
public void setSelectedChart(java.lang.Integer selectedChart)
```
    Sets the value of the property selectedChart.
  - getCharts
```
public javafx.collections.ObservableList<Chart<T>> getCharts()
```
  - setCharts
```
public void setCharts(javafx.collections.ObservableList<Chart<T>> charts)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isDirty
```
public java.lang.Boolean isDirty()
```
    Gets the value of the property dirty.
    
    Specified by:
    
    isDirty in interface Dirtyable
    
    Returns:
    
    true if the Dirtyable instance needs to be persisted, false otherwise
  - dirtyProperty
```
public javafx.beans.property.BooleanProperty dirtyProperty()
```
    Description copied from interface: Dirtyable
    
    A BooleanProperty that observes the changes made to the Dirtyable instance
    
    Specified by:
    
    dirtyProperty in interface Dirtyable
    
    See Also:
    
    isDirty()
  - cleanUp
```
public void cleanUp()
```
    Description copied from interface: Dirtyable
    
    Clear the dirty status of the Dirtyable instance
    
    Specified by:
    
    cleanUp in interface Dirtyable
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - getPreviousState
```
public java.util.Map<Chart<java.lang.Double>,XYChartSelection<java.time.ZonedDateTime,java.lang.Double>> getPreviousState()
```
  - setPreviousState
```
public void setPreviousState(java.util.Map<Chart<java.lang.Double>,XYChartSelection<java.time.ZonedDateTime,java.lang.Double>> previousState)
```
  - getBackwardHistory
```
public WorksheetNavigationHistory getBackwardHistory()
```
  - getForwardHistory
```
public WorksheetNavigationHistory getForwardHistory()
```
  - getChartLayout
```
public ChartLayout getChartLayout()
```
    Gets the value of the property chartLayout.
  - chartLayoutProperty
```
public javafx.beans.property.Property<ChartLayout> chartLayoutProperty()
```
    See Also:
    
    getChartLayout(), setChartLayout(ChartLayout)
  - setChartLayout
```
public void setChartLayout(ChartLayout chartLayout)
```
    Sets the value of the property chartLayout.

Class Worksheet<T>

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

name

timeZone

fromDateTime

toDateTime

selectedChart

dirty

chartLayout

Constructor Detail

Worksheet

Worksheet

Worksheet

Worksheet

Method Detail

getDefaultChart

getName

nameProperty

setName

getTimeZone

timeZoneProperty

setTimeZone

getFromDateTime

fromDateTimeProperty

setFromDateTime

getToDateTime

toDateTimeProperty

setToDateTime

getSelectedChart

selectedChartProperty

setSelectedChart

getCharts

setCharts

toString

isDirty

dirtyProperty

cleanUp

close

getPreviousState

setPreviousState

getBackwardHistory

getForwardHistory

getChartLayout

chartLayoutProperty

setChartLayout