Class AbstractInspectorPanelController
java.lang.Object
org.micromanager.display.inspector.AbstractInspectorPanelController
- All Implemented Interfaces:
InspectorPanelController
public abstract class AbstractInspectorPanelController
extends Object
implements InspectorPanelController
A panel containing a section of the inspector window.
In addition to implementing this abstract class, inspector panels must
call the appropriate methods of Inspector to notify the latter of
certain changes.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidabstract voidattachDataViewer(DataViewer viewer) Attach to a data viewer.abstract voidDetach from any currently attached data viewer.protected voidprotected voidprotected voidProvide a menu used for miscellaneous controls.abstract StringgetTitle()abstract booleanIndicate whether the panel can be resized vertically by the user.final voidMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface InspectorPanelController
getPanel, initiallyExpand, setExpanded
-
Constructor Details
-
AbstractInspectorPanelController
public AbstractInspectorPanelController()
-
-
Method Details
-
addInspectorPanelListener
- Specified by:
addInspectorPanelListenerin interfaceInspectorPanelController
-
removeInspectorPanelListener
- Specified by:
removeInspectorPanelListenerin interfaceInspectorPanelController
-
fireInspectorPanelWillChangeHeight
protected void fireInspectorPanelWillChangeHeight() -
fireInspectorPanelDidChangeHeight
protected void fireInspectorPanelDidChangeHeight() -
fireInspectorPanelDidChangeTitle
protected void fireInspectorPanelDidChangeTitle() -
getTitle
- Specified by:
getTitlein interfaceInspectorPanelController
-
getGearMenu
Provide a menu used for miscellaneous controls. This menu will be attached to a "gear button" visible in the title bar, when this panel is currently open. May be null, in which case no gear button will be shown. This method is called when the panel is first added to the inspector to determine if the button should be used; then when the button is clicked, the method is called again, in case you need to re-generate your menu based on context (e.g. changes in display settings).It is permissible to always return the same JPopupMenu instance, as long as you ensure that it is updated each time this method is called.
This method is guaranteed to be called on the Swing/AWT event dispatch thread.
- Specified by:
getGearMenuin interfaceInspectorPanelController- Returns:
- the gear popup menu, or null if the panel does not use a gear menu
-
attachDataViewer
Attach to a data viewer.- Specified by:
attachDataViewerin interfaceInspectorPanelController- Parameters:
viewer- aDataViewer(never null)
-
detachDataViewer
public abstract void detachDataViewer()Detach from any currently attached data viewer. This method should not throw an exception if a viewer is not yet attached.- Specified by:
detachDataViewerin interfaceInspectorPanelController
-
isVerticallyResizableByUser
public abstract boolean isVerticallyResizableByUser()Indicate whether the panel can be resized vertically by the user.Note that this is independent of whether the panel resizes itself depending on its content.
- Specified by:
isVerticallyResizableByUserin interfaceInspectorPanelController- Returns:
- true if the panel can be resized vertically; false if the panel has a fixed height
-