fi.helsinki.dacopan.ui
Class SettingsMSC

java.lang.Object
  fi.helsinki.dacopan.ui.SettingsMSC

All Implemented Interfaces:

java.lang.Cloneable

public class SettingsMSC
extends java.lang.Object
implements java.lang.Cloneable

Layer-specific settings for MSC.

Field Summary

static int	DEFAULT_FONT_SIZE
static int	DEFAULT_MAX_STEPPING
static int	DEFAULT_MIN_STEPPING
static int	DEFAULT_PROGRESS_SPEED
static int	DEFAULT_SCALE_MODE
static float	DEFAULT_TIME_SCALE
static int	DEFAULT_VISUAL_SCALE
protected boolean	linearMode
static int	MAX_FONT_SIZE
static int	MAX_MAX_STEPPING
static int	MAX_MIN_STEPPING
static int	MAX_PROGRESS_SPEED
static int	MAX_SHOW_HEADER_FIELDS
static int	MAX_SHOW_VARIABLES
static float	MAX_TIME_SCALE
static int	MAX_VISUAL_SCALE
static int	MIN_FONT_SIZE
static int	MIN_PROGRESS_SPEED
static float	MIN_TIME_SCALE
static int	MIN_VISUAL_SCALE
static int	SCALE_MODE_CSECONDS
static java.lang.String	SCALE_MODE_CSECONDS_UNIT
static int	SCALE_MODE_DSECONDS
static java.lang.String	SCALE_MODE_DSECONDS_UNIT
static int	SCALE_MODE_MILLISECONDS
static java.lang.String	SCALE_MODE_MILLISECONDS_UNIT
static int	SCALE_MODE_SECONDS
static java.lang.String	SCALE_MODE_SECONDS_UNIT
protected float	timeScale ratio between the timeline stored in Protocol Events File and the physical clock time of the animation.
static int	VISUAL_SCALE_SLIDER_STEP

Constructor Summary

SettingsMSC(Host leftHost, Host rightHost, Layer layer, VariableDefinition[] variablesCenter, VariableDefinition[] variablesColumns)
Creates a new instance of SettingsMSC

SettingsMSC(SettingsMSC settingsMSC)
Creates a copy instance of SettingsMSC

Method Summary

java.lang.Object	clone() Returns a true clone of this SettingsMSC object.
float	getEndTime() Getter for property endTime.
int	getFontSize() Get Font Size.
Layer	getLayer() Getter for property layer.
Host	getLeftHost() Getter for property leftHost.
int	getMaxStepping() Getter for maxStepping.
int	getMinStepping() Setter for property minStepping
int	getProgressSpeed()
Host	getRightHost() Getter for property rightHost.
int	getScaleMode() Returns the scale mode
int	getScaleMultiplier()
static int	getScaleMultiplier(int mode)
java.lang.String	getScaleMultiplierUnit()
static java.lang.String	getScaleMultiplierUnit(int mode)
boolean	getScenarioAutoPlay()
float	getStartTime() Getter for property startTime.
float	getTimeScale() returns the time scale for the animation
VariableDefinition[]	getVariablesCenter() Getter for property variablesCenter.
VariableDefinition[]	getVariablesColumns() Getter for property variablesColumns.
int	getVisualScale() Getter for property visualScale.
boolean	isLinearMode()
void	setAllFields(SettingsMSC newSettings) Copies all the values of the parameter object to the current object.
void	setEndTime(float newEndTime) Setter for property endTime.
void	setFontSize(int newFontSize) Setter for property fontSize
void	setLayer(Layer layer) Set the layer for current settingMSC (used when applying global settings).
void	setLinearMode(boolean linearMode)
void	setMaxStepping(int newMaxStepping) Setter for property minStepping
void	setMinStepping(int newMinStepping) Setter for property minStepping
void	setProgressSpeed(int newProgressSpeed) Set the animation progress speed.
void	setScaleMode(int value) Sets the scale mode
void	setScenarioAutoPlay(boolean value)
void	setStartTime(float newStartTime) Setter for property startTime.
void	setTimeScale(float timeScale) Sets the time scale for the animation.
void	setVariablesCenter(VariableDefinition[] variablesCenter) Setter for property variablesCenter.
void	setVariablesColumns(VariableDefinition[] variablesColumns) Setter for property variablesColumns.
void	setVisualScale(int visualScale) Setter for property visualScale.
boolean	showTimeStamps()
boolean	switchShowTimeStamps() switches showing of timestamps

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VISUAL_SCALE

public static final int DEFAULT_VISUAL_SCALE

See Also:

Constant Field Values

MAX_VISUAL_SCALE

public static final int MAX_VISUAL_SCALE

See Also:

Constant Field Values

MIN_VISUAL_SCALE

public static final int MIN_VISUAL_SCALE

See Also:

Constant Field Values

VISUAL_SCALE_SLIDER_STEP

public static final int VISUAL_SCALE_SLIDER_STEP

See Also:

Constant Field Values

MAX_SHOW_VARIABLES

public static final int MAX_SHOW_VARIABLES

See Also:

Constant Field Values

MAX_SHOW_HEADER_FIELDS

public static final int MAX_SHOW_HEADER_FIELDS

See Also:

Constant Field Values

DEFAULT_SCALE_MODE

public static final int DEFAULT_SCALE_MODE

See Also:

Constant Field Values

SCALE_MODE_SECONDS

public static final int SCALE_MODE_SECONDS

See Also:

Constant Field Values

SCALE_MODE_DSECONDS

public static final int SCALE_MODE_DSECONDS

See Also:

Constant Field Values

SCALE_MODE_CSECONDS

public static final int SCALE_MODE_CSECONDS

See Also:

Constant Field Values

SCALE_MODE_MILLISECONDS

public static final int SCALE_MODE_MILLISECONDS

See Also:

Constant Field Values

SCALE_MODE_MILLISECONDS_UNIT

public static final java.lang.String SCALE_MODE_MILLISECONDS_UNIT

See Also:

Constant Field Values

SCALE_MODE_SECONDS_UNIT

public static final java.lang.String SCALE_MODE_SECONDS_UNIT

See Also:

Constant Field Values

SCALE_MODE_DSECONDS_UNIT

public static final java.lang.String SCALE_MODE_DSECONDS_UNIT

See Also:

Constant Field Values

SCALE_MODE_CSECONDS_UNIT

public static final java.lang.String SCALE_MODE_CSECONDS_UNIT

See Also:

Constant Field Values

DEFAULT_TIME_SCALE

public static final float DEFAULT_TIME_SCALE

See Also:

Constant Field Values

MAX_TIME_SCALE

public static final float MAX_TIME_SCALE

See Also:

Constant Field Values

MIN_TIME_SCALE

public static final float MIN_TIME_SCALE

See Also:

Constant Field Values

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

See Also:

Constant Field Values

MIN_FONT_SIZE

public static final int MIN_FONT_SIZE

See Also:

Constant Field Values

MAX_FONT_SIZE

public static final int MAX_FONT_SIZE

See Also:

Constant Field Values

DEFAULT_MIN_STEPPING

public static final int DEFAULT_MIN_STEPPING

See Also:

Constant Field Values

MAX_MIN_STEPPING

public static final int MAX_MIN_STEPPING

See Also:

Constant Field Values

DEFAULT_MAX_STEPPING

public static final int DEFAULT_MAX_STEPPING

See Also:

Constant Field Values

MAX_MAX_STEPPING

public static final int MAX_MAX_STEPPING

See Also:

Constant Field Values

DEFAULT_PROGRESS_SPEED

public static final int DEFAULT_PROGRESS_SPEED

See Also:

Constant Field Values

MIN_PROGRESS_SPEED

public static final int MIN_PROGRESS_SPEED

See Also:

Constant Field Values

MAX_PROGRESS_SPEED

public static final int MAX_PROGRESS_SPEED

See Also:

Constant Field Values

timeScale

protected float timeScale

ratio between the timeline stored in Protocol Events File and the physical clock time of the animation. Number of seconds that takes to the animation to show one second of network time (Animation Time)

linearMode

protected boolean linearMode

Constructor Detail

SettingsMSC

public SettingsMSC(Host leftHost,
                   Host rightHost,
                   Layer layer,
                   VariableDefinition[] variablesCenter,
                   VariableDefinition[] variablesColumns)

Creates a new instance of SettingsMSC

SettingsMSC

public SettingsMSC(SettingsMSC settingsMSC)

Creates a copy instance of SettingsMSC

Method Detail

getLeftHost

public Host getLeftHost()

Getter for property leftHost.

Returns:

Value of property leftHost.

getRightHost

public Host getRightHost()

Getter for property rightHost.

Returns:

Value of property rightHost.

getLayer

public Layer getLayer()

Getter for property layer.

Returns:

Value of property layer.

getScaleMode

public int getScaleMode()

Returns the scale mode

setScaleMode

public void setScaleMode(int value)

Sets the scale mode

getTimeScale

public float getTimeScale()

returns the time scale for the animation

setTimeScale

public void setTimeScale(float timeScale)

Sets the time scale for the animation. Cannot be negative or zero.

getVisualScale

public int getVisualScale()

Getter for property visualScale.

Returns:

Value of property visualScale.

setVisualScale

public void setVisualScale(int visualScale)

Setter for property visualScale.

Parameters:

visualScale - New value of property visualScale.

getVariablesCenter

public VariableDefinition[] getVariablesCenter()

Getter for property variablesCenter.

Returns:

Value of property variablesCenter.

setVariablesCenter

public void setVariablesCenter(VariableDefinition[] variablesCenter)

Setter for property variablesCenter.

Parameters:

variablesCenter - New value of property variablesCenter.

getVariablesColumns

public VariableDefinition[] getVariablesColumns()

Getter for property variablesColumns.

Returns:

Value of property variablesColumns.

setVariablesColumns

public void setVariablesColumns(VariableDefinition[] variablesColumns)

Setter for property variablesColumns.

Parameters:

variablesColumns - New value of property variablesColumns.

getStartTime

public float getStartTime()

Getter for property startTime.

Returns:

Value of property startTime.

setStartTime

public void setStartTime(float newStartTime)

Setter for property startTime.

Parameters:

startTime - New value of property startTime.

getEndTime

public float getEndTime()

Getter for property endTime.

Returns:

Value of property endTime.

setScenarioAutoPlay

public void setScenarioAutoPlay(boolean value)

Parameters:

value -

getScenarioAutoPlay

public boolean getScenarioAutoPlay()

Returns:

getScaleMultiplier

public int getScaleMultiplier()

Returns:

getScaleMultiplier

public static int getScaleMultiplier(int mode)

Parameters:

mode -

Returns:

getScaleMultiplierUnit

public java.lang.String getScaleMultiplierUnit()

Returns:

getScaleMultiplierUnit

public static java.lang.String getScaleMultiplierUnit(int mode)

Parameters:

mode -

Returns:

setEndTime

public void setEndTime(float newEndTime)

Setter for property endTime.

Parameters:

endTime - New value of property endTime.

setMinStepping

public void setMinStepping(int newMinStepping)

Setter for property minStepping. * @param newMinStepping new value

getMinStepping

public int getMinStepping()

Setter for property minStepping. * @param newMinStepping new value

setMaxStepping

public void setMaxStepping(int newMaxStepping)

Setter for property minStepping. * @param newMinStepping new value

getMaxStepping

public int getMaxStepping()

Getter for maxStepping.

Returns:

maxStepping

setFontSize

public void setFontSize(int newFontSize)

Setter for property fontSize. * @param newFontSize new value

getFontSize

public int getFontSize()

Get Font Size.

Returns:

fontSize

setLayer

public void setLayer(Layer layer)

Set the layer for current settingMSC (used when applying global settings).

Parameters:

layer - New layer.

setProgressSpeed

public void setProgressSpeed(int newProgressSpeed)

Set the animation progress speed.

Parameters:

newProgressSpeed - The new progress speed.

getProgressSpeed

public int getProgressSpeed()

Returns:

Returns the progressSpeed.

clone

public java.lang.Object clone()

Returns a true clone of this SettingsMSC object.

Overrides:

clone in class java.lang.Object

setAllFields

public void setAllFields(SettingsMSC newSettings)

Copies all the values of the parameter object to the current object.

Parameters:

newSettings - The source of the new fields.

showTimeStamps

public boolean showTimeStamps()

Returns:

Returns the showTimeStamps.

switchShowTimeStamps

public boolean switchShowTimeStamps()

switches showing of timestamps

isLinearMode

public boolean isLinearMode()

Returns:

Returns the linearMode.

setLinearMode

public void setLinearMode(boolean linearMode)

Parameters:

linearMode - The linearMode to set.