org.micromanager.quickaccess

Interface QuickAccessManager

public interface QuickAccessManager

The QuickAccessManager provides API access to the Quick Access Panel(s). It can accessed via Studio.quick() or Studio.getQuickAccessManager().

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getCustomIcon(PropertyMap config, javax.swing.Icon defaultIcon) Generate an Icon based on information contained in the provided PropertyMap.
java.util.Map<java.lang.String,javax.swing.JFrame>	getPanels() Retrieve a mapping of Quick Access Panel titles to the panels themselves.
void	loadSettingsFromFile(java.io.File file) Load a settings file as generated by saveSettingsToFile().
void	saveSettingsToFile(java.io.File file) Save the Quick Access Panel settings to a file, so they may be transferred between users or to another system.
void	showPanels() Show the Quick Access Panels.

Method Detail

showPanels

void showPanels()

Show the Quick Access Panels. This loads all saved information in the user's profile relating to Quick Access Panels and ensures all such panels are visible. If there is no saved information in the profile, then a new, blank panel will be created.

getPanels

java.util.Map<java.lang.String,javax.swing.JFrame> getPanels()

Retrieve a mapping of Quick Access Panel titles to the panels themselves.

getCustomIcon

javax.swing.Icon getCustomIcon(PropertyMap config,
                               javax.swing.Icon defaultIcon)

Generate an Icon based on information contained in the provided PropertyMap. This method should be used by WidgetPlugins that support customizable icons (i.e. their getCanCustomizeIcon() method returns true) to insert the custom icon into their UI. Note that just because the UI *can* have a custom icon does not necessarily mean that it *will* have a custom icon; in such situations this method will return the defaultIcon value instead.

Parameters:

config - A PropertyMap potentially containing information about user-customized icons.

defaultIcon - Icon to use if no custom icon information is set.

Returns:

A custom Icon derived from the PropertyMap, or the defaultIcon if no icon information is available.

saveSettingsToFile

void saveSettingsToFile(java.io.File file)

Save the Quick Access Panel settings to a file, so they may be transferred between users or to another system. Please note that some widgets in the Quick Access Panel may be hardware-specific or rely on files accessible to the current user; these widgets may not work on different systems.

Parameters:

file - File to which settings should be saved.

loadSettingsFromFile

void loadSettingsFromFile(java.io.File file)

Load a settings file as generated by saveSettingsToFile(). This will create new Quick Access Panels as needed and populate them with the widgets described in the file. Please note that some widgets in the Quick Access Panel may be hardware-specific or rely on files accessible to the current user; these widgets may not work on different systems.

Parameters:

file - File from which settings should be loaded.