Properties and Events | |
| Property | isLocked = false |
| The bottom-level container for Tower of Psych GUIs. More... | |
| Property | isBaseItemTitle = false |
| whether to show a title for baseItem | |
Protected Properties | |
| Property | parentFigure |
| the topsFigure that holds this panel | |
| Property | pan |
| the Matlab uipanel | |
| Property | currentItem |
| the "current item" in use in the GUI | |
| Property | currentItemName |
| name to give the "current item" | |
| Property | baseItem |
| the item this panel is representing | |
| Property | baseItemName |
| name to give baseItem | |
Methods | |
| self | topsPanel (parentFigure) |
| Make a new panel in the given figure. More... | |
| delete (self) | |
| Clear references to graphics and handle objects. | |
| setBaseItem (self, baseItem, baseItemName) | |
| Choose the item to represent. More... | |
| setCurrentItem (self, currentItem, currentItemName) | |
| Choose the current item. More... | |
| refresh (self) | |
| Refresh the panel's contents. | |
Protected Methods | |
| initialize (self) | |
| Create and arrange fresh components. | |
| updateContents (self) | |
| Update the panel's contents (used internally) | |
| item | subItemFromPath (self, subPath) |
| Get an item referenced below baseItem. More... | |
Constructor
◆ topsPanel()
| self topsPanel | ( | parentFigure | ) |
Make a new panel in the given figure.
- Parameters
-
parentFigure topsFigure to work with
Creates a new topsPanel to show GUI content. parentFigure must be a topsFigure object, otherwise the panel won't display any content.
Methods
◆ setBaseItem()
| setBaseItem | ( | self | , |
| baseItem | , | ||
| baseItemName | |||
| ) |
Choose the item to represent.
- Parameters
-
baseItem the item to represent baseItemName string name for baseItem
baseItem is the item to represnet in this topsPanel. Different topsPanle subclasses may treat baseItem differently, or even ignore it. bassItemName is a name to display for the bass item. bassItemName is optional. If ommitted, defaults to the present value of bassItemName.
◆ setCurrentItem()
| setCurrentItem | ( | self | , |
| currentItem | , | ||
| currentItemName | |||
| ) |
Choose the current item.
- Parameters
-
currentItem the new current item currentItemName name to use for the current item
Assigns currentItem and currentItemName to this panel.
◆ subItemFromPath()
|
protected |
Get an item referenced below baseItem.
- Parameters
-
subPath string path beneath baseItem
Resolves a reference to a sub-item beneath baseItem and returns the sub-item. A sub-item may be an element, field, or property, or a combination of these, contained in baseItem. subPath must be a string referencing the sub-item, as might be typed in the command window. For example, '.myField', '(3,5)', and '.otherField{5}', might be valid subPath strings.
Properties and Events
◆ isLocked
| Property isLocked = false |
The bottom-level container for Tower of Psych GUIs.
topsPanel provides a uniform interface for detailed content panels. The uniform interface allows multiple panels to collaborate with a topsFigure and with each other.
Each panel manages a Matlab uipanel, in which it can display plots, data, text, etc., as well as interactive controls.
Each panel also keeps track of a "current item". This may be any Matlab variable, such as a Tower of Psych object or a piece of data, which was most recently viewed or used through the GUI. A panel can set the current item in response to user actions, or update itself to reflect a current item that was selected in a different panel. whether to leave the currentItem and contents as static
The documentation for this class was generated from the following file:
- topsPanel.m
