Package com.intellij.openapi.actionSystem

Interface Toggleable

All Known Implementing Classes:

AbstractFocusOnAction, AbstractToggleUseSoftWrapsAction, AlignLabelsAction, AnnotateToggleAction, AutoShowProcessPopupAction, BaseToggleStateAction, BaseToolWindowToggleAction, BooleanPropertyToggleAction, CallTracer.CallTracerToggleAction, ChangeHierarchyViewActionBase, CheckboxAction, CheckBoxSearchEverywhereToggleAction, CompactReferencesViewAction, ContentEntryEditingAction, CyclicSplitLayoutChangeAction, DebugBuildProcessToggleAction, DeepCompareAction, DirDiffAction, DisablePCEAction, DumbAwareToggleAction, DumbAwareToggleBooleanProperty, DumbAwareToggleInvertedBooleanProperty, EditArrangementAliasRuleAction, EditArrangementRuleAction, EditorAndPreviewLayoutChangeAction, EditorHeaderSetSearchContextAction, EditorHeaderToggleAction, EditorOnlyLayoutChangeAction, EditorToggleDecorationAction, EnableBackgroundTrackingAction, EnableEqual, EnableFilterByRegexAction, EnableLeft, EnableMatchCaseAction, EnableNotEqual, EnableRight, EventLogToolWindowFactory.ToggleSoftWraps, ExternalSystemToggleAction, ExternalSystemViewGearAction, FavoritesAbbreviatePackageNamesAction, FavoritesAutoScrollToSourceAction, FavoritesCompactEmptyMiddlePackagesAction, FavoritesFlattenPackagesAction, FavoritesShowMembersAction, FavoritesToolbarButtonAction, FlattenModulesToggleAction, FlattenPackagesAction, FocusOnBreakpointAction, FocusOnStartAction, GroupByConfigurationStatusAction, GroupByConfigurationTypeAction, GroupByContributorAction, GroupByScopeTypeAction, GroupByServiceGroupsAction, GroupModulesAction, GroupTasksAction, HideWhitespaceAction, HierarchyBrowserBaseEx.AlphaSortAction, IgnoreExternalProjectAction, InspectionFilterAction, IntelliSortChooserToggleAction, LineStatusMarkerPopupRenderer.ToggleByWordDiffAction, MemberChooser.ShowContainersAction, MuteBreakpointAction, PauseOutputAction, PauseOutputAction, PinActiveTabAction, PinActiveTabAction.EW, PinActiveTabAction.TW, PinToolwindowTabAction, PreferCommitDateAction, PreviewOnlyLayoutChangeAction, ProjectWindowAction, PyRootTypeProvider.RootEntryEditingAction, PyVariableViewSettings.PolicyAction, PyVariableViewSettings.SimplifiedView, RefreshDirDiffAction, RegistryToggleAction, RepositoryBrowserDialog.DetailsAction, RestoreViewAction, RulerGuideAction, ScrollToTheEndToolbarAction, SetEditorBidiTextDirectionAction, SetEditorBidiTextDirectionAction.ContentBased, SetEditorBidiTextDirectionAction.Ltr, SetEditorBidiTextDirectionAction.Rtl, ShowChangesFromParentsAction, ShowClassesWithDiffAction, ShowClassesWithInstanceAction, ShowColumns, ShowComponentTagsAction, ShowDetailsAction, ShowDiffPreviewAction, ShowDiffPreviewAction, ShowExpert, ShowFilesAction, ShowFilterAction, ShowGridAction, ShowHiddensAction, ShowHideAspectAction, ShowHideMergePanelAction, ShowHideRecycledAction, ShowIgnoredAction, ShowInheritedTasksAction, ShowLongEdgesAction, ShowModuleGroupsAction, ShowModulesAction, ShowModulesAction, ShowOnlyAffectedChangesAction, ShowOtherBranchesAction, ShowRootsColumnAction, ShowServicesAction, ShowTagNamesAction, ShowTrackedAction, ShowTypesAction, SimpleThreesideDiffViewer.MyEditorReadOnlyLockAction, SortElementsToggleAction, SortValuesToggleAction, SwitchUpdateModeAction, SynchronizeDiff, TableTabAction, TextDiffViewerUtil.EditorReadOnlyLockAction, TextDiffViewerUtil.ReadOnlyLockAction, TextDiffViewerUtil.ToggleAutoScrollAction, TextDiffViewerUtil.ToggleExpandByDefaultAction, ThreesideTextDiffViewer.MyToggleAutoScrollAction, ThreesideTextDiffViewerEx.MyToggleExpandByDefaultAction, ToggleAction, ToggleAction, ToggleActionButton, ToggleAfterCompileTasksAction, ToggleAfterRebuildTasksAction, ToggleAfterSyncTaskAction, ToggleAnywhereAction, ToggleBeforeCompileTasksAction, ToggleBeforeRebuildTasksAction, ToggleBeforeRunTaskAction, ToggleBeforeSyncTaskAction, ToggleBoldAction, ToggleBookmarkAction, ToggleBookmarkWithMnemonicAction, ToggleBooleanProperty, ToggleBooleanProperty.Disablable, ToggleCodeSpanAction, ToggleColumnModeAction, ToggleCompletionHintsAction, ToggleDockModeAction, ToggleEditorModeAction, ToggleExceptCommentsAction, ToggleExceptCommentsAndLiteralsAction, ToggleExceptLiteralsAction, ToggleExcludedStateAction, ToggleFileNameAction, ToggleFileSizeAction, ToggleFloatingModeAction, ToggleFocusViewModeAction, ToggleGridAction, ToggleInCommentsAction, ToggleInLiteralsOnlyAction, ToggleInvertedBooleanProperty, ToggleItalicAction, ToggleLineBreakpointAction, ToggleMatchCase, ToggleOfflineAction, ToggleOfflineAction, ToggleOptionAction, TogglePinnedModeAction, TogglePowerSaveAction, TogglePreserveCaseAction, ToggleRegex, ToggleRenderDocsOnFileOpeningAction, ToggleSelectionOnlyAction, ToggleShowDocsOnHoverAction, ToggleShowElementContentAction, ToggleShowGutterIconsAction, ToggleShowImportPopupsAction, ToggleShowIndentLinesAction, ToggleShowIndentLinesGloballyAction, ToggleShowLineNumbersAction, ToggleShowLineNumbersGloballyAction, ToggleShowWhitespacesAction, ToggleSideModeAction, ToggleSourcesStateAction, ToggleStrikethroughAction, ToggleTagsPanelAction, ToggleTaskActivationAction, ToggleToolbarAction, ToggleTransparencyChessboardAction, ToggleUseSoftWrapsInPreviewAction, ToggleUseSoftWrapsMenuAction, ToggleUseSoftWrapsToolbarAction, ToggleWholeWordsOnlyAction, ToggleWindowedModeAction, ToolWindowDockPinnedAction, ToolWindowDockUnpinnedAction, ToolWindowFloatAction, ToolWindowViewModeAction, ToolWindowWindowAction, TrackInstancesToggleAction, TreeActionWrapper, TwosideTextDiffViewer.MyToggleAutoScrollAction, UiDropperAction, UiInspectorAction, UnmuteOnStopAction, UseInlineDebuggerAction, VerboseAction, ViewClassHierarchyAction, ViewInplaceCommentsAction, ViewMainMenuAction, ViewNavigationBarAction, ViewNavigationBarMembersAction, ViewStatusBarAction, ViewSubtypesHierarchyAction, ViewSupertypesHierarchyAction, ViewToolbarAction, ViewToolWindowButtonsAction, WarnOnDeletion, XSwitchWatchesInVariables

public interface Toggleable

A marker interface for the action which could be toggled between "selected" and "not selected" states.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SELECTED_PROPERTY A property for the presentation to hold the state of the toggleable action.

Method Summary

Modifier and Type	Method and Description
static boolean	isSelected(Presentation presentation) Checks whether given presentation is in the "selected" state
static void	setSelected(Presentation presentation, boolean selected) Sets the selected state for given presentation (assuming it's a presentation of a toggleable action)

Field Detail

SELECTED_PROPERTY

static final java.lang.String SELECTED_PROPERTY

A property for the presentation to hold the state of the toggleable action. Normally you should not use this directly. Use isSelected(Presentation) and setSelected(Presentation, boolean) methods instead.

See Also:

Constant Field Values

Method Detail

isSelected

static boolean isSelected(Presentation presentation)

Checks whether given presentation is in the "selected" state

Parameters:

presentation - presentation to check

Returns:

true if "selected", false if "not selected" or the state wasn't set previously.

setSelected

static void setSelected(Presentation presentation,
                        boolean selected)

Sets the selected state for given presentation (assuming it's a presentation of a toggleable action)

Parameters:

presentation - presentation to update

selected - whether the state should be "selected" or "not selected".