Class CL_EditorClientProperties
java.lang.Object
org.jjazz.cl_editor.api.CL_EditorClientProperties
The Song and ChordLeadSheetItem client properties used by a CL_Editor and its components (e.g. BarRenderers, ItemRenderers, ...).
It is the responsibility of the object which updates client property to call Song.setSaveNeeded(boolean) if needed.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final StringSong client (String) property: nb of lines of bar annotationsstatic final StringSong client (String) property: bar annotations visibility.static final StringCLI_ChordSymbol client (String) property: chord font color.static final StringCLI_Section client (String) property: section color.static final StringCLI_Section client (String) property: section starts on new linestatic final StringCLI_Section client (String) property: user quantization for moving chord symbols.static final StringSong client (String) property: zoom X factor (impacting nb of columns)static final StringSong client (String) property: zoom Y factor (impacting BarBox height) -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic intgetBarAnnotationNbLines(Song song) static Colorstatic ColorgetSectionColor(CLI_Section cliSection) static QuantizationgetSectionUserQuantization(CLI_Section cliSection) static intgetZoomXFactor(Song song) static intgetZoomYFactor(Song song) static booleanisBarAnnotationVisible(Song song) static booleanisSectionIsOnNewLine(CLI_Section cliSection) static voidsetBarAnnotationNbLines(Song song, int n) static voidsetBarAnnotationVisible(Song song, boolean b) static voidsetChordSymbolUserColor(CLI_ChordSymbol cliCs, Color c) static voidsetSectionColor(CLI_Section cliSection, Color c) static voidsetSectionIsOnNewLine(CLI_Section cliSection, boolean b) static voidsetSectionUserQuantization(CLI_Section cliSection, Quantization q) static voidsetZoomXFactor(Song song, int factor) Note: it might be easier to useCL_Editor.setNbColumns(int).static voidsetZoomYFactor(Song song, int factor)
-
Field Details
-
BAR_ANNOTATION_MAX_NB_LINES
public static final int BAR_ANNOTATION_MAX_NB_LINES- See Also:
-
PROP_ZOOM_FACTOR_X
Song client (String) property: zoom X factor (impacting nb of columns)(as String) oldValue=old int, newValue=new int
- See Also:
-
PROP_ZOOM_FACTOR_Y
Song client (String) property: zoom Y factor (impacting BarBox height)(as String) oldValue=old int, newValue=new int
- See Also:
-
PROP_BAR_ANNOTATION_VISIBLE
Song client (String) property: bar annotations visibility.(as String) oldValue=old boolean, newValue=new boolean
- See Also:
-
PROP_BAR_ANNOTATION_NB_LINES
Song client (String) property: nb of lines of bar annotations(as String) oldValue=old int, newValue=new int
- See Also:
-
PROP_SECTION_USER_QUANTIZATION
CLI_Section client (String) property: user quantization for moving chord symbols.(as String) oldvalue=old quantization value, newValue=new quantization value
- See Also:
-
PROP_SECTION_COLOR
CLI_Section client (String) property: section color.(as String) oldvalue=old color, newValue=new color.
- See Also:
-
PROP_SECTION_START_ON_NEW_LINE
CLI_Section client (String) property: section starts on new line(as String) oldvalue=old boolean, newValue=new boolean.
- See Also:
-
PROP_CHORD_USER_FONT_COLOR
CLI_ChordSymbol client (String) property: chord font color.(as String) oldvalue=old color, newValue=new color.
- See Also:
-
-
Constructor Details
-
CL_EditorClientProperties
public CL_EditorClientProperties()
-
-
Method Details
-
isBarAnnotationVisible
- Parameters:
song-- Returns:
- false by default
- See Also:
-
setBarAnnotationVisible
- Parameters:
song-b-- See Also:
-
getBarAnnotationNbLines
- Parameters:
song-- Returns:
- 1 by default
- See Also:
-
setBarAnnotationNbLines
- Parameters:
song-n-- See Also:
-
getZoomXFactor
- Parameters:
song-- Returns:
- 80 by default (corresponds to 4 bars)
- See Also:
-
setZoomXFactor
Note: it might be easier to useCL_Editor.setNbColumns(int).- Parameters:
song-factor- [0;100]- See Also:
-
getZoomYFactor
- Parameters:
song-- Returns:
- 50 by default
- See Also:
-
setZoomYFactor
- Parameters:
song-factor- [0;100]- See Also:
-
setSectionUserQuantization
- Parameters:
cliSection-q- Can be null- See Also:
-
getSectionUserQuantization
- Parameters:
cliSection-- Returns:
- Can be null
- See Also:
-
isSectionIsOnNewLine
- Parameters:
cliSection-- Returns:
- false by default
- See Also:
-
setSectionIsOnNewLine
- Parameters:
cliSection-b-- See Also:
-
getSectionColor
- Parameters:
cliSection-- Returns:
- null by default
- See Also:
-
setSectionColor
- Parameters:
cliSection-c- Can be null- See Also:
-
getChordSymbolUserColor
- Parameters:
cliCs-- Returns:
- null by default
- See Also:
-
setChordSymbolUserColor
- Parameters:
cliCs-c- Can be null- See Also:
-