Package org.eclipse.help.ui.internal
Class HelpActivitySupport
java.lang.Object
org.eclipse.help.ui.internal.HelpActivitySupport
- All Implemented Interfaces:
org.eclipse.help.internal.base.IHelpActivitySupport
public class HelpActivitySupport
extends Object
implements org.eclipse.help.internal.base.IHelpActivitySupport
Wrapper for eclipse ui activity support
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidenableActivities(String href) Enables activities with patterns matching the hrefgetDocumentMessage(boolean embedded) Returns document message for disabled activities.booleangetDocumentMessageUsesLiveHelp(boolean embedded) Returns the message to show in the warning dialog when filtering is toggled off.booleanChecks if href matches an enabled activity.booleanisEnabledTopic(String href, String locale) Checks whether topic belongs to a TOC that mathes enabled activity.booleanbooleanbooleanisRoleEnabled(String href) Checks if href is matches an enabled activity.booleanvoidsetFilteringEnabled(boolean enabled) voidsetLinkWithSelection(boolean syncSel)
-
Constructor Details
-
HelpActivitySupport
-
-
Method Details
-
isFilteringEnabled
public boolean isFilteringEnabled()- Specified by:
isFilteringEnabledin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
setFilteringEnabled
public void setFilteringEnabled(boolean enabled) - Specified by:
setFilteringEnabledin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
isLinkWithSelectionEnabled
public boolean isLinkWithSelectionEnabled()- Specified by:
isLinkWithSelectionEnabledin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
setLinkWithSelection
public void setLinkWithSelection(boolean syncSel) - Specified by:
setLinkWithSelectionin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
isUserCanToggleFiltering
public boolean isUserCanToggleFiltering()- Specified by:
isUserCanToggleFilteringin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
isEnabled
Description copied from interface:org.eclipse.help.internal.base.IHelpActivitySupportChecks if href matches an enabled activity. If it does not match any defined activites, it is assumed to be enabled. If Help role filtering is disabled, this method always returnstrue.- Specified by:
isEnabledin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
isRoleEnabled
Description copied from interface:org.eclipse.help.internal.base.IHelpActivitySupportChecks if href is matches an enabled activity. If it does not match any defined activites, it is assumed to be enabled.- Specified by:
isRoleEnabledin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport- Parameters:
href- the topic href- Returns:
trueif role for this href is enabled,falseotherwise.
-
isEnabledTopic
Checks whether topic belongs to a TOC that mathes enabled activity. Enabled children TOCs are searched if linked by also enabled TOCs. Additionally topic may match description topic of a root TOC.- Specified by:
isEnabledTopicin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport- Parameters:
locale- locale for which TOCs are checked- Returns:
- true if topic belongs to an enabled TOC
-
enableActivities
Description copied from interface:org.eclipse.help.internal.base.IHelpActivitySupportEnables activities with patterns matching the href- Specified by:
enableActivitiesin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport
-
getShowAllMessage
Description copied from interface:org.eclipse.help.internal.base.IHelpActivitySupportReturns the message to show in the warning dialog when filtering is toggled off.- Specified by:
getShowAllMessagein interfaceorg.eclipse.help.internal.base.IHelpActivitySupport- Returns:
- the message for the filtering warning dialog
-
getDocumentMessage
Description copied from interface:org.eclipse.help.internal.base.IHelpActivitySupportReturns document message for disabled activities.- Specified by:
getDocumentMessagein interfaceorg.eclipse.help.internal.base.IHelpActivitySupport- Parameters:
embedded- iftrue, the message will be added to a document in the workbench window. Otherwise, it will be shown in a separate Help window.- Returns:
- the document message with Java script string substituted if found.
-
getDocumentMessageUsesLiveHelp
public boolean getDocumentMessageUsesLiveHelp(boolean embedded) - Specified by:
getDocumentMessageUsesLiveHelpin interfaceorg.eclipse.help.internal.base.IHelpActivitySupport- Parameters:
embedded- iftrue, the message will be added to a document in the workbench window. Otherwise, it will be shown in a separate Help window.- Returns:
trueif the document message uses live help and requires live help Java script header, orfalseotherwise.
-