Package com.tagtraum.beatunes
Interface KeyTextRenderer
-
- All Known Implementing Classes:
DefaultKeyTextRenderer,Id3KeyTextRenderer,MusicalKeyTextRenderer,OpenKeyNotationTextRenderer,WallClockKeyNotationTextRenderer
public interface KeyTextRendererRenderer that transforms aKeyobject 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 withBeaTunesas 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 StringgetName()Short name of this renderer.StringtoKeyString(Key key)Create a textual representation for aKeyobject.StringtoToolTip(Key key)Create a tooltip representation for aKeyobject.
-
-
-
Method Detail
-
toKeyString
String toKeyString(Key key)
Create a textual representation for aKeyobject.- Parameters:
key- key- Returns:
- textual representation
-
toToolTip
String toToolTip(Key key)
Create a tooltip representation for aKeyobject. 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
-
-