edu.mssm.crover.joe
Interface Joe

All Known Implementing Classes:
JoeImpl

public interface Joe


Method Summary
 void addDeskChoice(java.lang.String title)
          Add this title to the choice of available desks.
 java.lang.String getDeskChoice()
          Returns the title of the desk that is currently choosen.
 javax.swing.Icon getDeskIcon()
          Returns the icon that represents a desktop.
 LooseTabbedPane getLtp()
          Returns the LooseTabbedPane.
 JoeTool getToolInstanceByName(java.lang.String identifier)
          Retrieve an instance of a tool registered with Joe.
 void installMenus(javax.swing.JMenu[] menus)
          Requests that a set of menus be installed and shown to the user.
 void log(int level, java.lang.String message)
          Convenience method to log messages through the log system.
 void log(int level, java.lang.String message, java.lang.Exception e)
          Convenience method to log messages through the log system.
 void registerToolInstance(java.lang.String identifier, JoeTool instance)
          Registers an instance of a tool with joe so that this tool can be found by name latter on.
 void removeDeskChoice(java.lang.String title)
          Removes this title from the choice of available desks.
 void removeMenus(javax.swing.JMenu[] menus)
          Requests that a set of menus be removed and hidden to the user.
 java.lang.String suggestTitle(java.lang.String original)
          Construct unique titles for tabs.
 

Method Detail

getLtp

public LooseTabbedPane getLtp()
Returns the LooseTabbedPane.


getDeskChoice

public java.lang.String getDeskChoice()
Returns the title of the desk that is currently choosen. This is different from the current tab title. This title appear in the combo-box of RbDe at the right of the window. This is used to determine toward each desk a window will be moved. Or to indicate the name of a desk to create.


addDeskChoice

public void addDeskChoice(java.lang.String title)
Add this title to the choice of available desks.


removeDeskChoice

public void removeDeskChoice(java.lang.String title)
Removes this title from the choice of available desks.


getDeskIcon

public javax.swing.Icon getDeskIcon()
Returns the icon that represents a desktop.


suggestTitle

public java.lang.String suggestTitle(java.lang.String original)
Construct unique titles for tabs. Use the original title to generate a title for a new tab that has the property to be unique in the the LooseTabbedPane. An possible implementation would be to append a number to the original title so that the new title is unique. This method is most useful when more than one instance of a given tool is activate at once.


registerToolInstance

public void registerToolInstance(java.lang.String identifier,
                                 JoeTool instance)
Registers an instance of a tool with joe so that this tool can be found by name latter on.


getToolInstanceByName

public JoeTool getToolInstanceByName(java.lang.String identifier)
Retrieve an instance of a tool registered with Joe. If no tool was registered under the name identifier, null is returned, otherwise the instance of the tool.


installMenus

public void installMenus(javax.swing.JMenu[] menus)
Requests that a set of menus be installed and shown to the user.


removeMenus

public void removeMenus(javax.swing.JMenu[] menus)
Requests that a set of menus be removed and hidden to the user.


log

public void log(int level,
                java.lang.String message,
                java.lang.Exception e)
Convenience method to log messages through the log system.

See Also:
Log.log(int level, String message, Exception e)

log

public void log(int level,
                java.lang.String message)
Convenience method to log messages through the log system.

See Also:
Log.log(int level, String message)


Copyright @ 2003 Mount Sinai School of Medicine. All Rights Reserved.