Package ipsk.audio.arr.clip.ui
Interface AudioClipUI
-
- All Superinterfaces:
ActionProvider
,AudioClipListener
,java.util.EventListener
- All Known Implementing Classes:
AudioSignalClipView
,AudioSignalUI
,AudioTimeScaleUI
,BasicAudioClipUI
,EnergyAudioClipUI
,FourierUI
,FragmentActionBarUI
,PitchAudioClipUI
public interface AudioClipUI extends AudioClipListener, ActionProvider
Audio clip UI plugins have to implement this interface.- Author:
- klausj
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addActionListener(java.awt.event.ActionListener containerUI)
Add an actionlistener to the plugin.java.awt.Component
asComponent()
void
close()
LocalizableMessage
getLocalizableName()
Get localized name.java.lang.String
getName()
Get name of plugin.javax.swing.JComponent[]
getYScales()
boolean
hasControlDialog()
boolean
isPreferredFixedHeight()
void
removeActionListener(java.awt.event.ActionListener containerUI)
Remove an action listener.void
setAudioSample(AudioClip audiosample)
Set the audio sample.void
setMediaLengthUnit(MediaLengthUnit mediaLengthUnit)
Set media length units.void
setTimeFormat(java.text.Format format)
Set the time format to use.void
setTimeScaleTickProvider(TickProvider<java.lang.Long> timeScaleTickProvider)
Set the provider for time scale ticks.void
showJControlDialog(java.awt.Component parentComponent)
Show a dialog component for plugin controls.-
Methods inherited from interface ipsk.swing.action.tree.ActionProvider
getActionTreeRoot
-
Methods inherited from interface ipsk.audio.arr.clip.AudioClipListener
audioClipChanged
-
-
-
-
Method Detail
-
getName
java.lang.String getName()
Get name of plugin.- Returns:
- name
-
getLocalizableName
LocalizableMessage getLocalizableName()
Get localized name.- Returns:
- localized name
-
setMediaLengthUnit
void setMediaLengthUnit(MediaLengthUnit mediaLengthUnit)
Set media length units. (time or frames)
-
setTimeFormat
void setTimeFormat(java.text.Format format)
Set the time format to use. For example framecount or media timne format ("00:00:00.000")- Parameters:
format
-
-
setAudioSample
void setAudioSample(AudioClip audiosample)
Set the audio sample.- Parameters:
audiosample
- the audiosample or null to clear
-
setTimeScaleTickProvider
void setTimeScaleTickProvider(TickProvider<java.lang.Long> timeScaleTickProvider)
Set the provider for time scale ticks. If there is a time scale in the audio sample GUI, it can provide the time ticks for the other plugins to display vertical time scale lines.- Parameters:
timeScaleTickProvider
-
-
addActionListener
void addActionListener(java.awt.event.ActionListener containerUI)
Add an actionlistener to the plugin.- Parameters:
containerUI
-
-
removeActionListener
void removeActionListener(java.awt.event.ActionListener containerUI)
Remove an action listener.- Parameters:
containerUI
-
-
close
void close()
-
isPreferredFixedHeight
boolean isPreferredFixedHeight()
-
hasControlDialog
boolean hasControlDialog()
-
showJControlDialog
void showJControlDialog(java.awt.Component parentComponent)
Show a dialog component for plugin controls.
-
getYScales
javax.swing.JComponent[] getYScales()
-
asComponent
java.awt.Component asComponent()
-
-