Class: NavigationState (in Tools)

• Inheritance
• Description
• Class protocol
  • initialization
• Instance protocol
  • accessing
  • accessing-selection
  • accessing-subApps
  • accessing-subViews
  • aspects
  • aspects-kludges
  • history
  • printing & storing
  • queries

Inheritance:

   Object
   |
   +--Tools::NavigationState

Package:

stx:libtool

Category:

Interface-Browsers-New

Version:

rev: 1.83 date: 2023/11/20 10:37:24

user: cg

file: Tools__NavigationState.st directory: libtool

module: stx stc-classLibrary: libtool

Description:

documentation to be added.

class:
    <a short class summary here, describing what instances represent>

responsibilities:    
    <describing what my main role is>

collaborators:    
    <describing with whom and how I talk to>

API:
    <public api and main messages>
    
example:
    <a one-line examples on how to use - can also be in a separate example method>

implementation:
    <implementation points>


[instance variables:]

[class variables:]

copyright
COPYRIGHT (c) 2000 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 initialize

Invoked at system start or when the class is dynamically loaded.

Instance protocol:

 autoSearchAction

 autoSearchAction: aBlock

define an autosearch action (for semantic searches)

 autoSearchIgnoreCase

return true if the autoSearch is case-insensitive

 autoSearchIgnoreCase: aBoolean

define the autoSearches case-insensitivenes

 autoSearchIsMatch

return true if the autoSearch is a match search

 autoSearchIsMatch: aBoolean

define the automatic search pattern matching behavior

 autoSearchPattern

return the automatic search pattern.
The codeView will search for this automatically,
whenever the navigation is changing the shown method.

 autoSearchPattern: aStringOrPattern

define the automatic search pattern.
The codeView will search for this automatically,
whenever the navigation is changing the shown method.

 autoSearchPattern: aStringOrPattern ignoreCase: ignoreCaseBoolean match: isMatchBoolean

define the automatic search pattern.
The codeView will search for this automatically,
whenever the navigation is changing the shown method.

 browserLabel

return the assigned state-label (to be shown in the tab).

 browserLabel: aString

set the assigned state-label (to be shown in the tab).

 canvas

 canvas: something

 canvasType

return the type of canvas

 canvasType: aSpecSymbol

set the type of canvas

 codeAspect

return the codeAspect; a symbol describing what is shown in the codeView

 codeAspect: aSymbolOrNil

set the codeAspect; a symbol describing what is shown in the codeView

 codePaneAndPluginView

 codePaneAndPluginView: something

 codePaneAndPluginViewRelativeCorners

 codePaneAndPluginViewRelativeCorners: anArray

 editorNoteBookCanvasHolder

 editorNoteBookListHolder

 environment

 lastMethodShownInCodeView

 lastMethodShownInCodeView: something

 messagePaneView

 messagePaneView: something

 modified

check for modified code by asking the editTextView;
this one returns true if ever modified - even if
the modifications where undone in the editor
(i.e. not really modified).
Use #reallyModified if the contents should be compared
against the original contents

 modified: aBoolean

 noteBookView

 noteBookView: something

 realModifiedState

 realModifiedState: aBoolean

 realModifiedStateHolder

 selectedEditorNoteBookTabIndexHolder

 showMethodTemplate

 showMethodTemplate: aBoolean

 showingParseError

 showingParseError: something

 stringSearchToolView

 stringSearchToolView: aStringSearchTool

 tabContentView

 tabContentView: something

 worker

 worker: aProcess

 selectCategories: aCollection

 selectClasses: aCollection

 selectMethods: aCollection

 theSingleSelectedClass

if only one class is selected, return it.
Otherwise, return nil

 theSingleSelectedMethod

if only one method is selected, return it.
Otherwise, return nil

 applicationOfComponent: aComponentName

 applicationOfComponent: aComponentName or: anotherComponentName

 classCategoryListApplication

 classHierarchyListApplication

 classListApplication

 inlineMessageApplication

 metaToggleComponent

 methodCategoryListApplication

 methodListApplication

 nameSpaceListApplication

 projectListApplication

 variableList2Application

 variableListApplication

 versionDiffApplication

 versionDiffApplication: anApplication

 anySpecialEditorModified

 codeView

 doSaveInSpecialEditors

 documentationView

 getCodeView

 inheritanceView

 methodCategoryList: aView

 methodList: aView

 packageInfoButton

 packageInfoButton: something

 scrollableCodeView

 setUpScrollableCodeView

codeView setClipboardText:(codeView contents). "/ for undo

 specialEditorCanvasClassForResourceType: resourceTypeSymbol

 specialEditorCanvasForResourceType: resourceTypeSymbol

 bookmarkHolder

return/create the 'bookmarkHolder' value holder (automatically generated)

 categoryList

 categoryListGenerator

 classDocumentationHolder

 classHierarchyTopClass

 classList

 classListGenerator

 classListPerNameSpaceGenerator

 codeHolder

 codeModifiedHolder

 cursorColLabelHolder

self codeView isNil ifTrue:[^ nil].

 cursorLineAndColumnLabelHolder

 cursorLineLabelHolder

self codeView isNil ifTrue:[^ nil].

 editModeAutoIndentHolder

 editModeHolder

 filterClassVars

 hidePrivateClasses

 infoLabelHolder

 languageHolder

 lintRuleListGenerator

 messageHolder

return/create the 'messageHolder' value holder (automatically generated)

 messageHolder: aValueHolder

set the 'messageHolder' value holder (automatically generated)

 messageSpecHolder

return/create the 'messageSpecHolder' value holder (automatically generated)

 messageSpecHolder: something

set the 'messageSpecHolder' value holder (automatically generated)

 meta

 metaToggleLabelHolder

 methodInfo

 methodList

 modeLabelHolder

 nameSpaceFilter

 nameSpaceListGenerator

 navigationHistory

 noAllItem

 organizerMode

return the organizerMode holder;
holding a symbol describing how things are organized
(#category, #hierarchy, #project or #namespace)

 packageFilter

 packageInfoBackgroundColorHolder

 packageLabelHolder

 pluginVisibleHolder

 profilerStatistics

 profilerStatistics: aValueHolder

 progressHolder

return/create the 'progressHolder' value holder (automatically generated)

 progressHolder: aValueHolder

set the 'progressHolder' value holder (automatically generated)

 projectListGenerator

 protocolListGenerator

 selectedCategories

a value holder on the currently selected class categories

 selectedClasses

a value holder on the currently selected classes

 selectedLintRules

a value holder on the currently selected lint rules

 selectedMethods

a value holder on the currently selected methods

 selectedMethodsArrayAt: index

 selectedNamespaces

a value holder on the currently selected namespaces

 selectedProjects

a value holder on the currently selected projects

 selectedProtocols

a value holder on the currently selected protocols

 selectorListGenerator

a value holder on the current selector generator

 selectorListGeneratorArray

 selectorListGeneratorArrayAt: index

 sortBy

 theSingleSelectedBookmarkFromMethodOrClass

 theSingleSelectedClassFromMethodHolder

computes the class from the current single selected method

 theSingleSelectedClassHolder

 theSingleSelectedLanguageFromMethodOrClass

 theSingleSelectedMethodHolder

 updateBookmarkHolder

 updateLanguageHolder

 variableFilter

 metaToggle

 notMetaToggle

 addToHistory: class selector: selector

selector ifNil:[^self].

 colorizeForModifiedBuffer: someString

 nameString

a descriptive string of what this state shows

 nameStringOrNil

a descriptive string of what this state shows

 rawNameStringForCategory

 rawNameStringForNameSpace

 rawNameStringForProject

 rawNameStringOrNil

a descriptive string of what this state shows; nil, if nothing is selected

 rawNameStringOrNilWantShort: shortName

a descriptive string of what this state shows; nil, if nothing is selected

 shortNameString

a descriptive string of what this state shows

 isCategoryBrowser

 isChainBrowser

 isCheckOutputBrowser

 isClassBrowser

 isClassDocumentationBrowser

 isClassExtensionBrowser

 isFullBrowser

 isFullClassSourceBrowser

 isFullProtocolBrowser

 isLintResultBrowser

 isMethodBrowser

 isMethodListBrowser

 isNameSpaceBrowser

 isNameSpaceFullBrowser

 isProjectBrowser

 isProjectFullBrowser

showing a single or multiple full projects
(but not a regular browser, in projects-mode.

 isProtocolBrowser

 isProtocolOrFullProtocolBrowser

 isSingleCategoryBrowser

 isSingleClassBrowser

 isSingleFullProtocolBrowser

 isSingleMethodBrowser

 isSingleNamespaceBrowser

 isSingleNamespaceFullBrowser

 isSingleProjectBrowser

 isSingleProjectFullBrowser

 isSingleProtocolBrowser

 isVersionDiffBrowser