com.xmlmind.xmleditapp.desktop

Interface AppTool

All Superinterfaces:

AppPart

All Known Subinterfaces:

ToolBarTool

All Known Implementing Classes:

CheckValidityTool, ClipboardContentTool, ClipboardTool, DirTool, DocumentCacheTool, ListTypeMenu, NodePathTool, RecommendedOnlyToggle, StatusTool

public interface AppTool
extends AppPart

Interface implemented by a JComponent designed to be included in an horizontal tool bar or in a status bar. (Its shape should be a flat rectangle.)

Method Summary

Modifier and Type	Method and Description
String	getHelpId() Returns the online help ID of this component.
void	setHelpId(String helpId) Specifies the online help ID of this component.

Methods inherited from interface com.xmlmind.xmleditapp.desktop.AppPart

activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getApp, getId, initApp, isEditingContextSensitive, namespacePrefixesChanged, saveStateChanged, undoStateChanged, validityStateChanged

Method Detail

setHelpId

void setHelpId(String helpId)

Specifies the online help ID of this component.

This ID is almost always obtained from the declaration of this AppTool found in the .xxe_gui GUI specification file of the App.

getHelpId

String getHelpId()

Returns the online help ID of this component.