| gruntspud.GruntspudHost
All known Subclasses: gruntspud.standalone.JDK13GruntspudHost, gruntspud.jedit.JEditGruntspudHost,
| GruntspudHost | | public interface GruntspudHost (Code) | | To formalise the use of Gruntspud as a plugin into other applications,
the 'hosting' application must provide some basic services for
Gruntspud. The services are actions that may differ in implementation
depending on the 'Host'. The host must provide an implementation of this
interface and pass it to the main Gruntspud class when it is constructed.
author:
magicthize |
| Method Summary | |
| public boolean | canExit()
| | public void | diff(File f1, String title1, File f2, String title2, String encoding)
Perform a diff on the two files. | | public void | exit()
| | public JComponent | getAccessoryComponent()
| | public boolean | getBooleanProperty(String key)
| | public boolean | getBooleanProperty(String key, boolean defaultValue)
| | public String | getDiffViewerName()
If this host is capable of performing a diff on two files, this
method should return a name for the diff viewer. | | public Insets | getFileRendererInsets()
| | public String | getHTMLViewerName()
If this host is capable of displaying HTML, this method should return
a name for the HTML viewer. | | public Icon | getIcon(String name)
| | public int | getIntegerProperty(String key)
| | public int | getIntegerProperty(String key, int defaultValue)
| | public String | getLocalizedString(String name, String defaultValue)
| | public JComponent | getMainComponent()
| | public String | getName()
| | public TextStyle | getNodeStyle(CVSFileNode node)
| | public Properties | getProperties()
| | public String | getProperty(String key)
| | public String | getProperty(String key, String defaultValue)
| | public File | getTmpDir()
| | public boolean | isExitActionAvailable()
| | public boolean | isGeometryStored(String key)
| | public boolean | isNodeOpenedInEditor(CVSFileNode node)
| | public boolean | isUseCanonicalPaths()
| | public void | loadGeometry(Window component, String key)
| | public void | openNode(CVSFileNode node)
| | public void | reset()
| | public void | saveGeometry(Window component, String key)
| | public void | setBooleanProperty(String key, boolean value)
| | public void | setCommandRunning(boolean commandRunning)
| | public void | setIntegerProperty(String key, int value)
| | public void | setProperty(String key, String value)
| | public void | showException(Throwable t)
| | public void | showException(Throwable t, String message)
| | public void | showHelp(String resource)
| | public void | showPreferences()
Implement to show a dialog containing the preferences for Gruntspud. | | public void | unsetProperty(String key)
| | public void | updateComponentTreeUI()
| | public void | viewHTML(URL u)
View some HTML given a URL. | | public void | writeToConsole(TextStyle style, String message)
| | public void | writeToInfoLine(Color text, String message, Icon icon)
| | public void | writeToStatusLine(Color text, String message, Icon icon)
|
| canExit | | public boolean canExit()(Code) | | |
| diff | | public void diff(File f1, String title1, File f2, String title2, String encoding)(Code) | | Perform a diff on the two files. This will only be called if
the host declared itself to be capable of performing a diff by
returning a value other than null from the
getDiffViewerName() method
Parameters:
f1 - Description of the Parameter
Parameters:
f2 - Description of the Parameter |
| getAccessoryComponent | | public JComponent getAccessoryComponent()(Code) | | Gets the property attribute of the JEditPlugin object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| getBooleanProperty | | public boolean getBooleanProperty(String key)(Code) | | Gets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - Description of the Parameter The booleanProperty value |
| getBooleanProperty | | public boolean getBooleanProperty(String key, boolean defaultValue)(Code) | | Gets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The booleanProperty value |
| getDiffViewerName | | public String getDiffViewerName()(Code) | | If this host is capable of performing a diff on two files, this
method should return a name for the diff viewer. This will be
presented when the user requests a diff as one of the 'viewers' that
can be used to provided the differences.
the name of the diff viewer |
| getFileRendererInsets | | public Insets getFileRendererInsets()(Code) | | |
| getHTMLViewerName | | public String getHTMLViewerName()(Code) | | If this host is capable of displaying HTML, this method should return
a name for the HTML viewer.
the name of the diff viewer |
| getIntegerProperty | | public int getIntegerProperty(String key)(Code) | | Gets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - Description of the Parameter The booleanProperty value |
| getIntegerProperty | | public int getIntegerProperty(String key, int defaultValue)(Code) | | Gets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - Description of the Parameter The booleanProperty value |
| getLocalizedString | | public String getLocalizedString(String name, String defaultValue)(Code) | | Gets the localizedString attribute of the GruntspudHost object
Parameters:
name - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The localizedString value |
| getMainComponent | | public JComponent getMainComponent()(Code) | | Gets the property attribute of the JEditPlugin object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| getName | | public String getName()(Code) | | Return the name of the host
Parameters:
f - Description of the Parameter
exception:
IOException - Description of the Exception |
| getProperties | | public Properties getProperties()(Code) | | Gets the property attribute of the JEditPlugin object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| getProperty | | public String getProperty(String key)(Code) | | Return the value of a property
Parameters:
key - Description of the Parameter The property value |
| getProperty | | public String getProperty(String key, String defaultValue)(Code) | | Gets the property attribute of the GruntspudHost object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| getTmpDir | | public File getTmpDir()(Code) | | Return a directory that may be used for temporary storage
The tmpDir value |
| isExitActionAvailable | | public boolean isExitActionAvailable()(Code) | | |
| isGeometryStored | | public boolean isGeometryStored(String key)(Code) | | DOCUMENT ME!
Parameters:
key - DOCUMENT ME! DOCUMENT ME! |
| isUseCanonicalPaths | | public boolean isUseCanonicalPaths()(Code) | | Gets the useCanonicalPaths attribute of the GruntspudHost object
The useCanonicalPaths value |
| loadGeometry | | public void loadGeometry(Window component, String key)(Code) | | Description of the Method
Parameters:
component - Description of the Parameter
Parameters:
key - Description of the Parameter |
| openNode | | public void openNode(CVSFileNode node) throws IOException(Code) | | Description of the Method
Parameters:
f - Description of the Parameter
exception:
IOException - Description of the Exception |
| reset | | public void reset()(Code) | | Gets the property attribute of the JEditPlugin object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| saveGeometry | | public void saveGeometry(Window component, String key)(Code) | | Description of the Method
Parameters:
component - Description of the Parameter
Parameters:
key - Description of the Parameter |
| setBooleanProperty | | public void setBooleanProperty(String key, boolean value)(Code) | | Sets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - The new booleanProperty value
Parameters:
value - The new booleanProperty value |
| setCommandRunning | | public void setCommandRunning(boolean commandRunning)(Code) | | Inform of when a command starts running and stops running
Parameters:
commandRunning - command is running |
| setIntegerProperty | | public void setIntegerProperty(String key, int value)(Code) | | Sets the booleanProperty attribute of the GruntspudHost object
Parameters:
key - The new booleanProperty value
Parameters:
value - The new booleanProperty value |
| setProperty | | public void setProperty(String key, String value)(Code) | | Sets the property attribute of the GruntspudHost object
Parameters:
key - The new property value
Parameters:
value - The new property value |
| showException | | public void showException(Throwable t)(Code) | | Description of the Method
Parameters:
t - Description of the Parameter |
| showException | | public void showException(Throwable t, String message)(Code) | | Description of the Method
Parameters:
t - Description of the Parameter
Parameters:
message - Description of the Parameter |
| showHelp | | public void showHelp(String resource)(Code) | | DOCUMENT ME!
Parameters:
resource - DOCUMENT ME! |
| showPreferences | | public void showPreferences()(Code) | | Implement to show a dialog containing the preferences for Gruntspud.
|
| unsetProperty | | public void unsetProperty(String key)(Code) | | Gets the property attribute of the JEditPlugin object
Parameters:
key - Description of the Parameter
Parameters:
defaultValue - Description of the Parameter The property value |
| updateComponentTreeUI | | public void updateComponentTreeUI()(Code) | | DOCUMENT ME!
Parameters:
resource - DOCUMENT ME! |
| viewHTML | | public void viewHTML(URL u)(Code) | | View some HTML given a URL.
Parameters:
u - Description of the Parameter |
| writeToConsole | | public void writeToConsole(TextStyle style, String message)(Code) | | Description of the Method
Parameters:
text - Description of the Parameter
Parameters:
message - Description of the Parameter |
| writeToInfoLine | | public void writeToInfoLine(Color text, String message, Icon icon)(Code) | | Description of the Method
Parameters:
text - Description of the Parameter
Parameters:
message - Description of the Parameter |
| writeToStatusLine | | public void writeToStatusLine(Color text, String message, Icon icon)(Code) | | Description of the Method
Parameters:
text - Description of the Parameter
Parameters:
message - Description of the Parameter |
|
|