Package org.apache.hop.ui.hopgui.file

Interface IHopFileTypeHandler

    • Method Detail

      • getSubject

        Object getSubject()
        What is this handling? (pipeline, workflow, ...)
        Returns:
        The subject being handled

      • getName

        String getName()
        Get the user friendly name of the file being handled
        Returns:
        The user friendly name

      • setName

        void setName​(String name)
        Set the user friendly name of the underlying file
        Parameters:
        name - The user friendly name

      • getFileType

        IHopFileType getFileType()
        Get a hold of the file type details
        Returns:

      • getFilename

        String getFilename()
        Returns:
        The filename of the hop file

      • setFilename

        void setFilename​(String filename)
        Change the filename of the hop file
        Parameters:
        filename - The new filename

      • start

        void start()
        Start execution

      • stop

        void stop()
        Stop execution

      • pause

        void pause()
        Pause execution

      • resume

        void resume()
        Resume execution

      • preview

        void preview()
        Preview this file

      • debug

        void debug()
        Debug the file

      • redraw

        void redraw()
        Refresh the graphical file representation after model changes

      • updateGui

        void updateGui()
        Update the toolbar, menus and so on. This is needed after a file, context or capabilities changes

      • selectAll

        void selectAll()
        Select all items in the current files

      • unselectAll

        void unselectAll()
        Unselect all items in the current file

      • copySelectedToClipboard

        void copySelectedToClipboard()
        Copy the selected items to the clipboard

      • cutSelectedToClipboard

        void cutSelectedToClipboard()
        Cut the selected items to the clipboard

      • deleteSelected

        void deleteSelected()
        Delete the selected items

      • pasteFromClipboard

        void pasteFromClipboard()
        Paste items from the clipboard

      • isCloseable

        boolean isCloseable()
        Perform any task needed to close a file, save it if needed
        Returns:
        true if the file is ready to close. Return false if there was a problem saving or any other issue.

      • close

        void close()
        Actually close the file, remove it from the user interface.

      • hasChanged

        boolean hasChanged()
        See if there anything has been changed by the user
        Returns:
        true if there were changes worth saving, false if nothing has been changed.

      • undo

        void undo()
        Undo a change to the file

      • redo

        void redo()
        Redo a change to the file

      • getStateProperties

        Map<String,​Object> getStateProperties()
        Describe the state properties of the file being handled: zoomLevel, scrollX, scrollY, active, ...
        Returns:
        The state properties

      • applyStateProperties

        void applyStateProperties​(Map<String,​Object> stateProperties)

      • getVariables

        IVariables getVariables()
        The variables associated with the file. It's usually keeping internal variables and other file specific settings like active unit test settings.
        Returns:
        The variables associated with the loaded file

      • reload

        default void reload()
        Reload the file

      • markDeleted

        default void markDeleted()
        mark the file as deleted