Module org.refcodes.checkerboard

Package org.refcodes.checkerboard

Interface ConsoleCheckerboardViewer<P extends Player<P,S>,S>

Type Parameters:

P - The type representing a Player

S - The type which's instances represent a Player state.

All Superinterfaces:

CheckerboardObserver<P,S>, CheckerboardViewer<P,S,ConsoleCheckerboardViewer<P,S>>, org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, org.refcodes.component.Component, org.refcodes.component.Destroyable, org.refcodes.graphical.GridDimension, org.refcodes.graphical.GridHeightAccessor, org.refcodes.graphical.GridModeAccessor, org.refcodes.graphical.GridWidthAccessor, org.refcodes.component.Initializable, org.refcodes.component.Initializable.InitializeBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.component.InitializableComponent, org.refcodes.graphical.MinViewportDimension, org.refcodes.graphical.MinViewportDimension.MinViewportDimensionBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.MinViewportDimension.MinViewportDimensionMutator, org.refcodes.graphical.MinViewportDimension.MinViewportDimensionProperty, org.refcodes.observer.ObservableObserver<Checkerboard<P,S>>, org.refcodes.graphical.ViewportDimension, org.refcodes.graphical.ViewportDimension.ViewportDimensionBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportDimension.ViewportDimensionMutator, org.refcodes.graphical.ViewportDimension.ViewportDimensionProperty, org.refcodes.graphical.ViewportHeightAccessor, org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightMutator, org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightProperty, org.refcodes.graphical.ViewportOffset, org.refcodes.graphical.ViewportOffset.ViewportOffsetBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportOffset.ViewportOffsetMutator, org.refcodes.graphical.ViewportOffset.ViewportOffsetProperty, org.refcodes.graphical.ViewportOffsetXAccessor, org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXMutator, org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXProperty, org.refcodes.graphical.ViewportOffsetYAccessor, org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYMutator, org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYProperty, org.refcodes.graphical.ViewportWidthAccessor, org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthBuilder<ConsoleCheckerboardViewer<P,S>>, org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthMutator, org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthProperty

All Known Implementing Classes:

ConsoleCheckerboardViewerImpl

public interface ConsoleCheckerboardViewer<P extends Player<P,S>,S>
extends CheckerboardViewer<P,S,ConsoleCheckerboardViewer<P,S>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ConsoleCheckerboardViewer<P,S>>

Extends the interface CheckerboardViewer with functionality required for console output.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.ColumnWidthAccessor

org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

org.refcodes.component.Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.graphical.GridDimension

org.refcodes.graphical.GridDimension.GridDimensionBuilder<B extends org.refcodes.graphical.GridDimension.GridDimensionBuilder<B>>, org.refcodes.graphical.GridDimension.GridDimensionMutator, org.refcodes.graphical.GridDimension.GridDimensionProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.GridHeightAccessor

org.refcodes.graphical.GridHeightAccessor.GridHeightBuilder<B extends org.refcodes.graphical.GridHeightAccessor.GridHeightBuilder<B>>, org.refcodes.graphical.GridHeightAccessor.GridHeightMutator, org.refcodes.graphical.GridHeightAccessor.GridHeightProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.GridModeAccessor

org.refcodes.graphical.GridModeAccessor.GridModeBuilder<B extends org.refcodes.graphical.GridModeAccessor.GridModeBuilder<B>>, org.refcodes.graphical.GridModeAccessor.GridModeMutator, org.refcodes.graphical.GridModeAccessor.GridModeProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.GridWidthAccessor

org.refcodes.graphical.GridWidthAccessor.GridWidthBuilder<B extends org.refcodes.graphical.GridWidthAccessor.GridWidthBuilder<B>>, org.refcodes.graphical.GridWidthAccessor.GridWidthMutator, org.refcodes.graphical.GridWidthAccessor.GridWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Initializable

org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.Initializable.InitializeBuilder<B extends org.refcodes.component.Initializable.InitializeBuilder<B>>, org.refcodes.component.Initializable.UncheckedInitializable

Nested classes/interfaces inherited from interface org.refcodes.graphical.MinViewportDimension

org.refcodes.graphical.MinViewportDimension.MinViewportDimensionBuilder<B extends org.refcodes.graphical.MinViewportDimension.MinViewportDimensionBuilder<B>>, org.refcodes.graphical.MinViewportDimension.MinViewportDimensionMutator, org.refcodes.graphical.MinViewportDimension.MinViewportDimensionProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportDimension

org.refcodes.graphical.ViewportDimension.ViewportDimensionBuilder<B extends org.refcodes.graphical.ViewportDimension.ViewportDimensionBuilder<B>>, org.refcodes.graphical.ViewportDimension.ViewportDimensionMutator, org.refcodes.graphical.ViewportDimension.ViewportDimensionProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportHeightAccessor

org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightBuilder<B extends org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightBuilder<B>>, org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightMutator, org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportOffset

org.refcodes.graphical.ViewportOffset.ViewportOffsetBuilder<B extends org.refcodes.graphical.ViewportOffset.ViewportOffsetBuilder<B>>, org.refcodes.graphical.ViewportOffset.ViewportOffsetMutator, org.refcodes.graphical.ViewportOffset.ViewportOffsetProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportOffsetXAccessor

org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXBuilder<B extends org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXBuilder<B>>, org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXMutator, org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportOffsetYAccessor

org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYBuilder<B extends org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYBuilder<B>>, org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYMutator, org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.ViewportWidthAccessor

org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthBuilder<B extends org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthBuilder<B>>, org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthMutator, org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthProperty

Method Summary

Modifier and Type	Method	Description
int	getRedrawLoopTimeInMillis()	Retrieves the refresh loop time between two redraw cycles of the Checkerboard.
boolean	isRedrawOnEvent()	Determines whether the Checkerboard is printed out upon any according events from the underlying Checkerboard or as of the refresh loop time (see getRedrawLoopTimeInMillis()).
default ConsoleCheckerboardViewer<P,S>	withColumnWidth(int aColumnWidth)

Methods inherited from interface org.refcodes.checkerboard.CheckerboardObserver

onChangePositionEvent, onCheckerboardEvent, onDraggabilityChangedEvent, onGridDimensionChangedEvent, onGridModeChangedEvent, onPlayerAddedEvent, onPlayerEvent, onPlayerRemovedEvent, onPositionChangedEvent, onStateChangedEvent, onViewportDimensionChangedEvent, onViewportOffsetChangedEvent, onVisibilityChangedEvent

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

getColumnWidth

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator

setColumnWidth

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty

letColumnWidth

Methods inherited from interface org.refcodes.component.Destroyable

destroy

Methods inherited from interface org.refcodes.graphical.GridDimension

isInBounds, isInBounds, isInHeight, isInWidth

Methods inherited from interface org.refcodes.graphical.GridHeightAccessor

getGridHeight

Methods inherited from interface org.refcodes.graphical.GridModeAccessor

getGridMode

Methods inherited from interface org.refcodes.graphical.GridWidthAccessor

getGridWidth

Methods inherited from interface org.refcodes.component.Initializable

initialize, initializeUnchecked

Methods inherited from interface org.refcodes.component.Initializable.InitializeBuilder

withInitialize, withInitializeUnchecked

Methods inherited from interface org.refcodes.graphical.MinViewportDimension

getMinViewportDimension

Methods inherited from interface org.refcodes.graphical.MinViewportDimension.MinViewportDimensionBuilder

withMinViewportDimension, withMinViewportDimension, withMinViewportDimension

Methods inherited from interface org.refcodes.graphical.MinViewportDimension.MinViewportDimensionMutator

setMinViewportDimension, setMinViewportDimension, setMinViewportDimension

Methods inherited from interface org.refcodes.graphical.MinViewportDimension.MinViewportDimensionProperty

letMinViewportDimension, letMinViewportDimension, letMinViewportDimension

Methods inherited from interface org.refcodes.observer.ObservableObserver

onSubscribe, onUnsubscribe

Methods inherited from interface org.refcodes.graphical.ViewportDimension.ViewportDimensionBuilder

withViewportDimension, withViewportDimension, withViewportDimension

Methods inherited from interface org.refcodes.graphical.ViewportDimension.ViewportDimensionMutator

setViewportDimension, setViewportDimension, setViewportDimension

Methods inherited from interface org.refcodes.graphical.ViewportHeightAccessor

getViewportHeight

Methods inherited from interface org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightBuilder

withViewportHeight

Methods inherited from interface org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightMutator

setViewportHeight

Methods inherited from interface org.refcodes.graphical.ViewportHeightAccessor.ViewportHeightProperty

letViewportHeight

Methods inherited from interface org.refcodes.graphical.ViewportOffset.ViewportOffsetBuilder

withViewportOffset, withViewportOffset, withViewportOffset, withViewportOffset

Methods inherited from interface org.refcodes.graphical.ViewportOffset.ViewportOffsetMutator

setViewportOffset, setViewportOffset, setViewportOffset, setViewportOffset

Methods inherited from interface org.refcodes.graphical.ViewportOffsetXAccessor

getViewportOffsetX

Methods inherited from interface org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXBuilder

withViewportOffsetX

Methods inherited from interface org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXMutator

setViewportOffsetX

Methods inherited from interface org.refcodes.graphical.ViewportOffsetXAccessor.ViewportOffsetXProperty

letViewportOffsetX

Methods inherited from interface org.refcodes.graphical.ViewportOffsetYAccessor

getViewportOffsetY

Methods inherited from interface org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYBuilder

withViewportOffsetY

Methods inherited from interface org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYMutator

setViewportOffsetY

Methods inherited from interface org.refcodes.graphical.ViewportOffsetYAccessor.ViewportOffsetYProperty

letViewportOffsetY

Methods inherited from interface org.refcodes.graphical.ViewportWidthAccessor

getViewportWidth

Methods inherited from interface org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthBuilder

withViewportWidth

Methods inherited from interface org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthMutator

setViewportWidth

Methods inherited from interface org.refcodes.graphical.ViewportWidthAccessor.ViewportWidthProperty

letViewportWidth

Method Details

getRedrawLoopTimeInMillis

int getRedrawLoopTimeInMillis()

Retrieves the refresh loop time between two redraw cycles of the Checkerboard. This is the delay time between succeeding print outs of the Checkerboard states to the console. If the refresh loop time is > 0, then the Checkerboard is redrawn at most with intervals of the given refresh loop time. Attention: The Checkerboard is only redrawn in case the Checkerboard changed compared to the last redraw process.

Returns:

The according time in milliseconds.

isRedrawOnEvent

boolean isRedrawOnEvent()

Determines whether the Checkerboard is printed out upon any according events from the underlying Checkerboard or as of the refresh loop time (see getRedrawLoopTimeInMillis()). Attention: The Checkerboard is only redrawn in case the Checkerboard changed compared to the last redraw process.

Returns:

True in case the Checkerboard is redrawn upon an event from the Checkerboard or upon the refresh loop time.

withColumnWidth

default ConsoleCheckerboardViewer<P,S> withColumnWidth(int aColumnWidth)

Specified by:

withColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<P extends Player<P,S>>