Class SS_EditorClientProperties

java.lang.Object

org.jjazz.ss_editor.api.SS_EditorClientProperties

public class SS_EditorClientProperties
extends Object

The Song client properties used by a SS_Editor and its components.

It is the responsibility of the object which updates one of these client properties to call Song.setSaveNeeded(boolean) if needed.

See Also:

• StringProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SS_EditorClientProperties.ViewMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_COMPACT_VIEW_MODE_VISIBLE_RPS	Song client (String) property: the visible rhythm parameters in compact view mode for a given rhythm.
static final String	PROP_VIEW_MODE	Song client (String) property: current view mode.
static final String	PROP_ZOOM_FACTOR_X	Song client (String) property: zoom X factor
static final String	PROP_ZOOM_FACTOR_Y	Song client (String) property: zoom Y factor

Constructor Summary

Constructors

Constructor	Description
SS_EditorClientProperties()

Method Summary

Modifier and Type	Method	Description
static List<RhythmParameter<?>>	getCompactViewModeVisibleRPs(Song song, Rhythm r)	Get the list of visible RPs in compact view mode for the specified rhythm.
static String	getRhythmIdFromCompactViewRhythmPropertyName(String propName)	Return the rhythmId if propName is a PROP_COMPACT_VIEW_MODE_VISIBLE_RPS-based name.
static SS_EditorClientProperties.ViewMode	getViewMode(Song song)
static int	getZoomXFactor(Song song)
static int	getZoomYFactor(Song song)
static void	setCompactViewModeVisibleRPs(Song song, Rhythm r, List<RhythmParameter<?>> rps)	Set the list of visible RPs in compact view mode for the specified rhythm.
static void	setViewMode(Song song, SS_EditorClientProperties.ViewMode mode)
static void	setZoomXFactor(Song song, int factor)
static void	setZoomYFactor(Song song, int factor)

Methods inherited from class java.lang.Object

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

Field Details

PROP_VIEW_MODE

public static final String PROP_VIEW_MODE

Song client (String) property: current view mode.

(as String) oldValue=old mode, newValue=new mode.

See Also:

• Constant Field Values

PROP_COMPACT_VIEW_MODE_VISIBLE_RPS

public static final String PROP_COMPACT_VIEW_MODE_VISIBLE_RPS

Song client (String) property: the visible rhythm parameters in compact view mode for a given rhythm.

This is the base name used to build the rhythm-specific property name.

(as String) oldValue=list of visible RPs, newValue=new list of visible RPs

See Also:

• getRhythmIdFromCompactViewRhythmPropertyName(java.lang.String)
• Constant Field Values

PROP_ZOOM_FACTOR_X

public static final String PROP_ZOOM_FACTOR_X

Song client (String) property: zoom X factor

(as String) oldValue=old int, newValue=new int

See Also:

• Constant Field Values

PROP_ZOOM_FACTOR_Y

public static final String PROP_ZOOM_FACTOR_Y

Song client (String) property: zoom Y factor

(as String) oldValue=old int, newValue=new int

See Also:

• Constant Field Values

Constructor Details

SS_EditorClientProperties

public SS_EditorClientProperties()

Method Details

getViewMode

public static SS_EditorClientProperties.ViewMode getViewMode(Song song)

Parameters:

song -

Returns:

COMPACT by default

See Also:

• PROP_VIEW_MODE

setViewMode

public static void setViewMode(Song song,
 SS_EditorClientProperties.ViewMode mode)

Parameters:

song -

mode -

See Also:

• PROP_VIEW_MODE

getCompactViewModeVisibleRPs

public static List<RhythmParameter<?>> getCompactViewModeVisibleRPs(Song song,
 Rhythm r)

Get the list of visible RPs in compact view mode for the specified rhythm.

Parameters:

song -

r -

Returns:

Can be empty

See Also:

• PROP_COMPACT_VIEW_MODE_VISIBLE_RPS

setCompactViewModeVisibleRPs

public static void setCompactViewModeVisibleRPs(Song song,
 Rhythm r,
 List<RhythmParameter<?>> rps)

Set the list of visible RPs in compact view mode for the specified rhythm.

Parameters:

song -

r -

rps - Can not be null

See Also:

• PROP_COMPACT_VIEW_MODE_VISIBLE_RPS

getRhythmIdFromCompactViewRhythmPropertyName

public static String getRhythmIdFromCompactViewRhythmPropertyName(String propName)

Return the rhythmId if propName is a PROP_COMPACT_VIEW_MODE_VISIBLE_RPS-based name.

Parameters:

propName -

Returns:

Null if propName is not a PROP_COMPACT_VIEW_MODE_VISIBLE_RPS-based name

See Also:

• PROP_COMPACT_VIEW_MODE_VISIBLE_RPS

getZoomXFactor

public static int getZoomXFactor(Song song)

Parameters:

song -

Returns:

50 by default

See Also:

• PROP_ZOOM_FACTOR_X

setZoomXFactor

public static void setZoomXFactor(Song song,
 int factor)

Parameters:

song -

factor - [0;100]

See Also:

• PROP_ZOOM_FACTOR_X

getZoomYFactor

public static int getZoomYFactor(Song song)

Parameters:

song -

Returns:

50 by default

See Also:

• PROP_ZOOM_FACTOR_Y

setZoomYFactor

public static void setZoomYFactor(Song song,
 int factor)

Parameters:

song -

factor - [0;100]

See Also:

• PROP_ZOOM_FACTOR_Y