Package org.spiderwiz.admin.data

Class PageInfo

java.lang.Object
org.spiderwiz.admin.data.PageInfo
@WizSerializable
public class PageInfo
extends Object
Specifies the layout of an application page in SpiderAdmin.

The exact layout of the page that SpiderAdmin displays for each application is determined by the method Main.getPageInfo() that the application implements (or inherits from Main). The method returns an object of the class that is described here.

An application page consists of operation buttons at the top and then a list of tables. This class specifies the buttons and the functions that are assigned to them, the tables and the structure of each table.

See Also:
TableData

  • Constructor Details

    • PageInfo

      public PageInfo()
      Constructs a default object.

    • PageInfo

      public PageInfo​(Boolean showUpdateSettings, Boolean showFlushLogs)
      Constructs an object with initial values.
      Parameters:
      showUpdateSettings - true if the page shall show the "Update Configuration" button.
      showFlushLogs - true if the page shall show the "Flush Logs" button.

  • Method Details

    • getButtonInfo

      public List<PageInfo.ButtonInfo> getButtonInfo()
      Gets the value of the buttonInfo property.

      The buttonInfo property is a list of descriptors for all the custom buttons in the page.

      Returns:
      the value of the buttonInfo property.

    • getTableInfo

      public List<PageInfo.TableInfo> getTableInfo()
      Gets the value of the tableInfo property.

      The tableInfo property is a list of descriptors for all the tables in the page.

      Returns:
      the value of the tableInfo property.

    • isShowReloadSettings

      public Boolean isShowReloadSettings()
      Gets the value of the showReloadSettings property.

      The showReloadSettings property specifies whether to show the "Reload Configuration" button at the top of the page. When this button is clicked, application configuration is loaded from the configuration file assuming that it was edited manually.

      Returns:
      the value of the showReloadSettings property.

    • setShowReloadSettings

      public void setShowReloadSettings​(Boolean value)
      Sets the value of the showReloadSettings property. The showReloadSettings property specifies whether to show the "Reload Configuration" button at the top of the page. When this button is clicked, application configuration is loaded from the configuration file assuming that it was edited manually.
      Parameters:
      value -

    • isShowUpdateSettings

      public Boolean isShowUpdateSettings()
      Gets the value of the showUpdateSettings property.

      The showUpdateSettings property specifies whether to show the "Update Configuration" button at the top of the page.

      Returns:
      the value of the showUpdateSettings property.

    • setShowUpdateSettings

      public void setShowUpdateSettings​(Boolean value)
      Sets the value of the showUpdateSettings property.

      The showUpdateSettings property specifies whether to show the "Update Configuration" button at the top of the page.

      Parameters:
      value -

    • isShowFlushLogs

      public Boolean isShowFlushLogs()
      Gets the value of the showFlushLogs property.

      The showFlushLogs property specifies whether to show the "Flush Logs" button at the top of the page.

      Returns:
      the value of the showFlushLogs property.

    • setShowFlushLogs

      public void setShowFlushLogs​(Boolean value)
      Sets the value of the showFlushLogs property.

      The showFlushLogs property specifies whether to show the "Flush Logs" button at the top of the page.

      Parameters:
      value -

    • isExternalAddress

      public boolean isExternalAddress()
      Gets the value of the externalAddress property.

      The externalAddress property informs that SpiderAdmin has been activated from an external IP address and therefore the "Update Configuration" button is replaced by "Show Configuration" and the "Maintenance" button is not shown at all.

      Returns:
      the value of the externalAddress property.

    • setExternalAddress

      public void setExternalAddress​(boolean value)
      Sets the value of the externalAddress property.

      The externalAddress property informs that SpiderAdmin has been activated from an external IP address and therefore the "Update Configuration" button is replaced by "Show Configuration" and the "Maintenance" button is not shown at all.

      Parameters:
      value -

    • addButton

      public PageInfo addButton​(String text, String service, boolean verify)
      Adds a custom button to the page layout.

      The method arguments specify the attributes of the button as follows:

      • text: The label of the button.
      • service: The service code attached to the button that is used by Main.customAdminService() to determine the operation of the button.
      • verify: Determines whether a user that clicks this button is asked to verify the operation.
      Parameters:
      text - Button's label.
      service - Button's service code.
      verify - true when the browser shall verify operation after button click,
      Returns:
      this object

    • addTable

      public PageInfo addTable​(PageInfo.TableInfo tableInfo)
      Adds a table descriptor to the page layout.
      Parameters:
      tableInfo - specifies the table layout.
      Returns:
      this object