Package org.spiderwiz.admin.data

Class PageInfo.TableInfo

java.lang.Object
org.spiderwiz.admin.data.PageInfo.TableInfo
Enclosing class:
PageInfo
@WizSerializable
public static class PageInfo.TableInfo
extends Object
Specifies the structure of a table displayed in an application page.

  • Constructor Details

    • TableInfo

      public TableInfo()
      Constructs an empty object.

    • TableInfo

      public TableInfo​(String title, String service, boolean hideData)
      Constructs an object with initial values.

      The following values are set by this constructor:

      • title: The title that SpiderAdmin displays above the table.
      • service: The service code that is used by Main.customAdminService() to determine the data displayed in the table.
      • hideData: Specifies whether SpiderAdmin shall initially hide the table when displaying the page. The table can be revealed by the user by clicking the drop-down icon near the table title (which is not hidden if the table contains data).
      Parameters:
      title - The displayed table title (if not null).
      service - The service code used by the application to populate the table.
      hideData - If true then the table is initially hidden.

  • Method Details

    • getTitle

      public String getTitle()
      Gets the value of the title property.

      The title property is the title that SpiderAdmin displays above the table.

      Returns:
      the value of the title property.

    • setTitle

      public void setTitle​(String value)
      Sets the value of the title property.

      The title property is the title that SpiderAdmin displays above the table. You should not set it directly but rather specify when activating the class constructor.

      Parameters:
      value -

    • getService

      public String getService()
      Gets the value of the service property.

      The service property is the service code that is used by Main.customAdminService() to determine the data displayed in the table.

      Returns:
      the value of the service property.

    • setService

      public void setService​(String value)
      Sets the value of the service property.

      The service property is the service code that is used by Main.customAdminService() to determine the data displayed in the table.

      You should not set it directly but rather specify when activating the class constructor.

      Parameters:
      value -

    • isHideData

      public boolean isHideData()
      Gets the value of the hideData property.

      The hideData property specifies whether SpiderAdmin shall initially hide the table when displaying the page. The table can be revealed by the user by clicking the drop-down icon near the table title (which is not hidden if the table contains data).

      Returns:
      the value of the hideData property.

    • setHideData

      public void setHideData​(boolean value)
      Sets the value of the hideData property.

      The hideData property specifies whether SpiderAdmin shall initially hide the table when displaying the page. The table can be revealed by the user by clicking the drop-down icon near the table title (which is not hidden if the table contains data).

      You should not set it directly but rather specify when activating the class constructor.

      Parameters:
      value -

    • getColumnInfo

      public List<PageInfo.TableInfo.ColumnInfo> getColumnInfo()
      Gets the value of the columnInfo property.

      The columnInfo property lists all the column descriptors of the table.

      Returns:
      the value of the columnInfo property.

    • addColumn

      public PageInfo.TableInfo addColumn​(String title, String subTitle, int style, int summary)
      Add a column definition to the table specifying the following parameters:
      • title: The column title that is displayed in the table header for the referenced column. This value also identifies the column when TableData.addRow() is used to populate the table.
      • subTitle: The column subtitle that is displayed in the table sub-header for the referenced column. If the property value is null nothing is displayed in the table sub-header for this column.
      • style: A bit combination of PageInfo.TableInfo.Style values that specify the default HTML styles used for displaying the cells in the column. The property can be overridden for specific cells when TableData.addRow() is used.
      • summary: Determines the value displayed in the table summary line for the column. The possible values are defined in PageInfo.TableInfo.Summary.
      Parameters:
      title - Column title
      subTitle - Column sub-title
      style - Default styles for the column's cells.
      summary - The value to be displayed in the table's summary line.
      Returns:
      this object.