|
The Meta-Environment API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nl.cwi.sen1.gui.component.StudioComponentImpl
public class StudioComponentImpl
A default implementation of a StudioComponent. This is the starting point for any StudioComponent. This convience class wraps a JComponent, and implements the default behavior for the StudioComponent interface.
Field Summary | |
---|---|
private javax.swing.Icon |
icon
|
private javax.swing.event.EventListenerList |
listenerList
|
private java.lang.String |
name
|
private java.lang.String |
tooltip
|
private javax.swing.JComponent |
viewComponent
|
Constructor Summary | |
---|---|
StudioComponentImpl(java.lang.String name,
javax.swing.JComponent viewComponent)
Construct a new component. |
|
StudioComponentImpl(java.lang.String name,
javax.swing.JComponent viewComonent,
java.lang.String tooltip)
|
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. |
protected void |
fireComponentClose()
|
protected void |
fireComponentFocusReceived()
|
protected void |
fireComponentRequestClose()
|
void |
fireNameChangedEvent()
|
void |
fireTooltipChangedEvent()
|
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 |
setIcon(javax.swing.Icon icon)
|
void |
setName(java.lang.String name)
The name can be changed. |
void |
setTooltip(java.lang.String tooltip)
The tooltip can be changed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private javax.swing.Icon icon
private javax.swing.event.EventListenerList listenerList
private java.lang.String name
private java.lang.String tooltip
private javax.swing.JComponent viewComponent
Constructor Detail |
---|
public StudioComponentImpl(java.lang.String name, javax.swing.JComponent viewComponent)
name
- the name of the component (for a tab label).viewComponent
- the Swing component to show in the tab.public StudioComponentImpl(java.lang.String name, javax.swing.JComponent viewComonent, java.lang.String tooltip)
Method Detail |
---|
public java.lang.String getName()
StudioComponent
getName
in interface StudioComponent
public void setName(java.lang.String name)
StudioComponent
setName
in interface StudioComponent
name
- new name for this component.public java.lang.String getTooltip()
StudioComponent
getTooltip
in interface StudioComponent
public void setTooltip(java.lang.String tooltip)
StudioComponent
setTooltip
in interface StudioComponent
tooltip
- new tooltip for this component.public javax.swing.JComponent getViewComponent()
StudioComponent
getViewComponent
in interface StudioComponent
public void addStudioComponentListener(StudioComponentListener l)
StudioComponent
addStudioComponentListener
in interface StudioComponent
l
- the listener to register.public void removeStudioComponentListener(StudioComponentListener l)
StudioComponent
removeStudioComponentListener
in interface StudioComponent
protected void fireComponentRequestClose() throws CloseAbortedException
CloseAbortedException
protected void fireComponentClose()
protected void fireComponentFocusReceived()
public javax.swing.Icon getIcon()
StudioComponent
getIcon
in interface StudioComponent
public void setIcon(javax.swing.Icon icon)
public void requestClose() throws CloseAbortedException
StudioComponent
requestClose
in interface StudioComponent
CloseAbortedException
- if the component can not be closed (for example when the user chooses to cancel.public void close()
StudioComponent
close
in interface StudioComponent
public void receiveFocus()
StudioComponent
receiveFocus
in interface StudioComponent
public javax.swing.JComponent[] getStatusBarComponents()
StudioComponent
getStatusBarComponents
in interface StudioComponent
public void addNameChangedListener(NameChangedListener l)
StudioComponent
addNameChangedListener
in interface StudioComponent
public void removeNameChangedListener(NameChangedListener l)
StudioComponent
removeNameChangedListener
in interface StudioComponent
public void fireNameChangedEvent()
public void addTooltipChangedListener(TooltipChangedListener l)
StudioComponent
addTooltipChangedListener
in interface StudioComponent
public void removeTooltipChangedListener(TooltipChangedListener l)
StudioComponent
removeTooltipChangedListener
in interface StudioComponent
public void fireTooltipChangedEvent()
|
The Meta-Environment API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |