Package com.tagtraum.beatunes
Interface KeyTextRenderer
-
- All Known Implementing Classes:
DefaultKeyTextRenderer
,Id3KeyTextRenderer
,MusicalKeyTextRenderer
,OpenKeyNotationTextRenderer
,WallClockKeyNotationTextRenderer
public interface KeyTextRenderer
Renderer that transforms aKey
object into a textual representation like the Open Key Notation or other representations.
Since this renderer is instantiated via the plugin mechanism, implementations must provide an empty constructor or one withBeaTunes
as only argument type. Having access toBeaTunes.localize(String, Object...)
makes localization easier.- Author:
- Hendrik Schreiber
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getName()
Short name of this renderer.String
toKeyString(Key key)
Create a textual representation for aKey
object.String
toToolTip(Key key)
Create a tooltip representation for aKey
object.
-
-
-
Method Detail
-
toKeyString
String toKeyString(Key key)
Create a textual representation for aKey
object.- Parameters:
key
- key- Returns:
- textual representation
-
toToolTip
String toToolTip(Key key)
Create a tooltip representation for aKey
object. This may also include <html>-tags.- Parameters:
key
- key- Returns:
- tooltip representation
-
getName
String getName()
Short name of this renderer. To be used in the user interface.- Returns:
- name
-
-