Class SaveImageAction

  • All Implemented Interfaces:
    DockingActionIf, HelpDescriptor

    public class SaveImageAction
    extends DockingAction
    An action to save the image from a NavigableImagePanel to a file.

    The user is asked to provide a file to save the image to.

    This class uses the ImageIO library to write the image to a file; the image format is determined by filename extension -- PNG, GIF and JPG extensions are recognized and honored, other extensions are ignored, and the file is written in PNG format. Image transparency is honored when possible.

    See Also:
    ImageIO
    • Field Detail

      • imagePanel

        protected final ImagePanel imagePanel
    • Constructor Detail

      • SaveImageAction

        public SaveImageAction​(java.lang.String owner,
                               ImagePanel imagePanel)
    • Method Detail

      • isEnabledForContext

        public boolean isEnabledForContext​(ActionContext context)
        Description copied from interface: DockingActionIf
        Method used to determine if this action should be enabled for the given context.

        This is the method implementors override to control when the action may be used.

        This method will be called by the DockingWindowManager for actions on the global menuBar and toolBar and for actions that have a keyBinding.

        This method will be called whenever one of the following events occur:

        1. when the user invokes the action via its keyBinding,
        2. the user changes focus from one component provider to another,
        3. the user moves a component to another position in the window or into another window,
        4. a component provider reports a change in it's context,
        5. any plugin or software component reports a general change in context (calls the tool.contextChanged(ComponentProvider) with a null parameter).
        The default implementation will simply return this action's enablement state.
        Specified by:
        isEnabledForContext in interface DockingActionIf
        Overrides:
        isEnabledForContext in class DockingAction
        Parameters:
        context - the current ActionContext for the window.
        Returns:
        true if the action should be enabled for the context or false otherwise.