Interface DependentPageItem

  • All Known Implementing Classes:
    CardFace

    public interface DependentPageItem
    A page item that depends on an external file to recreate its content.
    Author:
    Chris Jennings
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getPath()
      Returns the path to the external data source.
      boolean refresh()
      Indicates to the item that it should recreate its content because the external file has changed.
      void setPath​(java.lang.String path)
      Set the path the external data source.
    • Method Detail

      • getPath

        java.lang.String getPath()
        Returns the path to the external data source.
        Returns:
        the path to the data this item depends upon
      • setPath

        void setPath​(java.lang.String path)
        Set the path the external data source.
        Parameters:
        path - the path to the data this item depends upon
      • refresh

        boolean refresh()
        Indicates to the item that it should recreate its content because the external file has changed. This method should return true if the item is updated successfully, or false if the item could not be updated, typically because the new item is incompatible with the old one.
        Returns:
        true if the item was replaced