Class PageInfo
@WizSerializable public class PageInfo extends Object
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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PageInfo.ButtonInfo
Specifies the label and the function of a custom button in an application page.static class
PageInfo.TableInfo
Specifies the structure of a table displayed in an application page. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description PageInfo
addButton(String text, String service, boolean verify)
Adds a custom button to the page layout.PageInfo
addTable(PageInfo.TableInfo tableInfo)
Adds a table descriptor to the page layout.List<PageInfo.ButtonInfo>
getButtonInfo()
Gets the value of the buttonInfo property.List<PageInfo.TableInfo>
getTableInfo()
Gets the value of the tableInfo property.boolean
isExternalAddress()
Gets the value of the externalAddress property.Boolean
isShowFlushLogs()
Gets the value of the showFlushLogs property.Boolean
isShowReloadSettings()
Gets the value of the showReloadSettings property.Boolean
isShowUpdateSettings()
Gets the value of the showUpdateSettings property.void
setExternalAddress(boolean value)
Sets the value of the externalAddress property.void
setShowFlushLogs(Boolean value)
Sets the value of the showFlushLogs property.void
setShowReloadSettings(Boolean value)
Sets the value of the showReloadSettings property.void
setShowUpdateSettings(Boolean value)
Sets the value of the showUpdateSettings property.
-
Constructor Details
-
Method Details
-
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
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
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
Sets the value of the showReloadSettings property. TheshowReloadSettings
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
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
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
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
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
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 byMain.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
Adds a table descriptor to the page layout.- Parameters:
tableInfo
- specifies the table layout.- Returns:
- this object
-