|
The Meta-Environment API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StudioComponent
The (visual) interface to a tab (window) that is hosted in a MetaStudio.
Method Summary | |
---|---|
void |
addNameChangedListener(NameChangedListener l)
Register a NameChangedListener. |
void |
addStudioComponentListener(StudioComponentListener l)
Register a listener (usually the plugin that this Component belongs to, and the MetaStudio). |
void |
addTooltipChangedListener(TooltipChangedListener l)
Register a TooltipChangedListener. |
void |
close()
Closes a component. |
javax.swing.Icon |
getIcon()
Tabs can be labelled with small icons too. |
java.lang.String |
getName()
The name is used to construct labels of tabs. |
javax.swing.JComponent[] |
getStatusBarComponents()
The MetaStudio has a status bar at the bottom. |
java.lang.String |
getTooltip()
The tooltip is used to show when hovering the mouse over tabs. |
javax.swing.JComponent |
getViewComponent()
The bridge to Swing is made here. |
void |
receiveFocus()
Receive the focus. |
void |
removeNameChangedListener(NameChangedListener l)
Unregister a NameChangedListener. |
void |
removeStudioComponentListener(StudioComponentListener l)
Unregister a listener. |
void |
removeTooltipChangedListener(TooltipChangedListener l)
Unregister a TooltipChangedListener. |
void |
requestClose()
Request to close the window. |
void |
setName(java.lang.String name)
The name can be changed. |
void |
setTooltip(java.lang.String tooltip)
The tooltip can be changed. |
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
name
- new name for this component.java.lang.String getTooltip()
void setTooltip(java.lang.String tooltip)
tooltip
- new tooltip for this component.javax.swing.Icon getIcon()
javax.swing.JComponent getViewComponent()
void addStudioComponentListener(StudioComponentListener l)
l
- the listener to register.void removeStudioComponentListener(StudioComponentListener l)
void requestClose() throws CloseAbortedException
CloseAbortedException
- if the component can not be closed (for example when the user chooses to cancel.void close()
void receiveFocus()
javax.swing.JComponent[] getStatusBarComponents()
void addNameChangedListener(NameChangedListener l)
void removeNameChangedListener(NameChangedListener l)
void addTooltipChangedListener(TooltipChangedListener l)
void removeTooltipChangedListener(TooltipChangedListener l)
|
The Meta-Environment API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |