Interface HomePageView


  • public interface HomePageView
    Interface for a component that is displayed on the home page. Objects that implement this interface should be very lightweight, at least until one of the get*View() methods are called.
    Author:
    Sean D. Reilly
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.swing.JComponent getGUIView​(AccountBook book)
      Returns a GUI component that provides a view of the info panel for the given data file.
      java.lang.String getID()
      Returns a unique identifier for this view.
      void refresh()
      Forces a refresh of the information in the view.
      void reset()
      Called when the view should clean up everything.
      void setActive​(boolean active)
      Sets the view as active or inactive.
      java.lang.String toString()
      Returns a short descriptive name of this view.
    • Method Detail

      • getID

        java.lang.String getID()
        Returns a unique identifier for this view. This identifier must be unique across all identifiers for all extensions.
      • toString

        java.lang.String toString()
        Returns a short descriptive name of this view.
        Overrides:
        toString in class java.lang.Object
      • getGUIView

        javax.swing.JComponent getGUIView​(AccountBook book)
        Returns a GUI component that provides a view of the info panel for the given data file.
      • setActive

        void setActive​(boolean active)
        Sets the view as active or inactive. When not active, a view should not have any registered listeners with other parts of the program. This will be called when an view is added to the home page, or the home page is refreshed after not being visible for a while.
      • refresh

        void refresh()
        Forces a refresh of the information in the view. For example, this is called after the preferences are updated.
      • reset

        void reset()
        Called when the view should clean up everything. For example, this is called when a file is closed and the GUI is reset. The view should disconnect from any resources that are associated with the currently opened data file.