Index
All Classes|All Packages
I
- IMAGE_NO_REPEAT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_BOTTOM_CENTER - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_BOTTOM_LEFT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_BOTTOM_RIGHT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_CENTRE_CENTER - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_CENTRE_LEFT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_CENTRE_RIGHT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_TOP_CENTER - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_TOP_LEFT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_POSITION_TOP_RIGHT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_REPEAT - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_REPEAT_X - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- IMAGE_REPEAT_Y - Static variable in interface com.ebasetech.xi.api.controls.ControlConstants
- ImageColumnControl - Interface in com.ebasetech.xi.api.controls
-
Image Column Control.
- ImageControl - Interface in com.ebasetech.xi.api.controls
-
Image Control.
- ImageControlProperties - Interface in com.ebasetech.xi.api.controls
-
Image Control properties.
- ImageStyleProperties - Interface in com.ebasetech.xi.api.controls
-
The
ImageStyleProperties
interface represents common image styling properties. - IncludeControl - Interface in com.ebasetech.xi.api.controls
-
An Include Control represents an external JSP or HTML file that is to be inserted into the generated page output at the location represented by the control.
- IndividualTabStateProperties - Interface in com.ebasetech.xi.api.controls
-
The
IndividualTabStateProperties
interface representsTab Control
styling properties for a specific tab state. - InfoPopupProperties - Interface in com.ebasetech.xi.api.controls
-
The
InfoPopupProperties
interface represents the properties passed to the Javascript window.open() statement used to create the popup window for field help texts. - InfoProperties - Interface in com.ebasetech.xi.api.controls
-
The
InfoProperties
interface represents properties that apply to field help texts. - InitiateUploadControl - Interface in com.ebasetech.xi.api.controls
-
Initiate Upload Control uploads the file(s) selected by the associated file upload control when clicked.
- insert() - Method in interface com.ebasetech.xi.api.DatabaseResource
-
Builds and executes an insert SQL statement and inserts a table row with values obtained from mapped form fields.
- insertRow() - Method in interface com.ebasetech.xi.api.Table
-
Inserts a new row into the table and sets this row as the current row of the table (see
Table.getCurrentRow()
). - IntegrationResource - Interface in com.ebasetech.xi.api
-
The
IntegrationResource
interface represents an Integration Resource. - IntegrationService - Interface in com.ebasetech.xi.api
-
The
IntegrationService
interface represents an Integration Service. - INTERLEAVED - Static variable in interface com.ebasetech.xi.api.controls.BarcodeControl
-
A constant to represent an Interleaved 2 of 5 barcode for use with setType() method.
- invalidate() - Method in interface com.ebasetech.xi.api.FormSession
-
Invalidates the current form session and frees all memory associated with it
- invalidate(String) - Method in interface com.ebasetech.xi.api.FormSession
-
Invalidates the specified form session and frees all memory associated with it
- invokeTemplateFromFile(String) - Static method in class com.ebasetech.xi.services.VelocityServices
-
This is equivalent to invoking method
invokeTemplateFromFile(String, int)
with log level warn. - invokeTemplateFromFile(String, int) - Static method in class com.ebasetech.xi.services.VelocityServices
-
Invokes the Velocity template contained in the file specified by
fileName
. - invokeTemplateFromInlineString(String) - Static method in class com.ebasetech.xi.services.VelocityServices
-
This is equivalent to invoking method
invokeTemplateFromInlineString(String, int)
with log level warn. - invokeTemplateFromInlineString(String, int) - Static method in class com.ebasetech.xi.services.VelocityServices
-
Invokes the Velocity template contained in parameter
templateString
. - isAriaRequired() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates whether or not this is an aria required field.
- isAuthorized(String, String, String) - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns
true
when a user is logged on and the user has the authorization identified bytype
,name
andfunction
;otherwise returnsfalse
. - isBackButtonSupported() - Method in interface com.ebasetech.xi.api.WebForm
-
Returns
true
if use of the back button is supported for the current form. - isBackButtonUsed() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
if the user has clicked the back button immediately prior to the request currently being processed. - isBackground() - Method in interface com.ebasetech.xi.api.WebForm
-
Returns
true
if this form is running in background e.g. - isButtonDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates whether or not the image specified in the
buttonImageUrl
property is displayed instead of a button. - isButtonSkipValidation() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Returns whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
- isCalledForm() - Method in interface com.ebasetech.xi.api.WebForm
-
Returns
true
if this form has been called from another form using methodWebForm.callForm(String, Map)
. - isChrome() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is Chrome, otherwise returnsfalse
. - isClientAccessible() - Method in interface com.ebasetech.xi.api.WebFormFieldOrColumn
-
Returns true if the form field or table column is accessible via the client api, otherwise returns false.
- isCompleted() - Method in interface com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor
-
Answers whether the job has completed or not
- isComponent() - Method in interface com.ebasetech.xi.api.WebFormEventContext
-
Returns
true
if the event currently being executed forms part of a deployed component i.e. - isContainer() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns true if this control is a container control i.e.
- isDebug() - Method in interface com.ebasetech.xi.api.Resource
-
Returns
true
if debug is activated for the resource. - isDebugging() - Method in interface com.ebasetech.xi.api.EbaseSystem
-
Returns true if a Javascript debugging session is active on this server.
- isDeletable() - Method in interface com.ebasetech.xi.api.controls.TableControl
-
Returns whether or not the user row deletion built-in feature is activated.
- isDesignerUser() - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns
true
when a form has been submitted from the designer, otherwise returnsfalse
. - isDirectory(String) - Static method in class com.ebasetech.xi.services.FileServices
-
Returns true if file path represents a directory.
- isDisabled() - Method in interface com.ebasetech.xi.api.controls.ButtonControlProperties
-
Returns
true
if the button is marked as disabled, otherwise returnsfalse
. - isDisabled() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Returns
true
if the field is marked as disabled, otherwise returnsfalse
. - isDisplay() - Method in class com.ebasetech.xi.api.PdfOptions
-
Returns the
display
option. - isDisplayAsHyperlink() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties
-
Returns
true
if the image should behave as a hyperlink when clicked, otherwise returnsfalse
. - isDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.EbaseButtonControlProperties
-
Indicates whether or not the button is displayed as an image.
- isDisplayChecksum() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl
-
Returns whether to display the checksum digit at the end of the barcode
- isDisplayEditor() - Method in interface com.ebasetech.xi.api.controls.FieldControl
-
Returns
true
if the editor part of the field should be displayed, otherwise returnsfalse
; - isDisplayInfoPrefix() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
Indicates whether or not the navigation bar prefix text is displayed.
- isDisplayInfoText() - Method in interface com.ebasetech.xi.api.controls.FieldControl
-
Returns
true
if the help part of the field should be displayed, otherwise returnsfalse
; - isDisplayIvAsImage() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates that a button is displayed as an image, and is applicable only when Javascript is disabled and immediate validation is simulated using buttons/images to be clicked by the user.
- isDisplayLabelText() - Method in interface com.ebasetech.xi.api.controls.FieldControl
-
Returns
true
if the label part of the field should be displayed, otherwise returnsfalse
; - isDisplayOnly() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if the control is marked as display only, otherwise returnsfalse
. - isDisplayOnlyIncludingParents() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if the control or any of its parents is marked as display only, otherwise returnsfalse
. - isDisplayScrollTopBottomIcons() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
Indicates whether or not scroll to top and scroll to bottom icons or corresponding texts are included in the navigation bar.
- isDisplayStartStop() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl
-
Indicates whether the start and stop character will be displayed as part of the human-readable message.
- isEdge() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is MS Edge, otherwise returnsfalse
. - isEditableRadioOrCheckboxList() - Method in interface com.ebasetech.xi.api.controls.FieldControl
-
Returns true if the field represents a list that will be displayed as a list of radio buttons or checkboxes.
- isEnabled() - Method in interface com.ebasetech.xi.api.controls.StaticMenuItemControl
-
When enabled, the menu item can be clicked; when disabled the menu item is still displayed but cannot be clicked.
- isEventField() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if the control is an event field i.e. - isExpired() - Method in interface com.ebasetech.xi.api.JWT
- isFile(String) - Static method in class com.ebasetech.xi.services.FileServices
-
Returns true if file path represents a file.
- isFinishDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel
-
Indicates whether or not the finish button is displayed as an image.
- isFirefox() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is Firefox, otherwise returnsfalse
. - isGatewayRequest() - Method in interface com.ebasetech.xi.api.GatewayAuthentication
-
Returns true if the Http Request Gateway security parameter that contains the JWE (JSON Web Encrypted) token
- isGatewayRequest() - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns true if the incoming Http Request contains the Gateway Authentication Token, otherwise false
- isGatewayServer() - Method in interface com.ebasetech.xi.api.Gateway
-
Returns true if the licence supports the feature: Gateway Server, otherwise false.
- isGatewayUser() - Method in interface com.ebasetech.xi.api.Gateway
-
Returns true if the user has logged onto the system via the Gateway Server otherwise false
- isGutter() - Method in interface com.ebasetech.xi.api.controls.BootstrapRowControl
-
Have the gutters between columns been enabled.
- isHidden() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if the control is marked as hidden, otherwise returnsfalse
. - isHyperlink() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates whether or not the field's value should be displayed as a hyperlink.
- isIE() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is MS Internet Explorer, otherwise returnsfalse
. - isImageGrayscale() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl
-
Returns whether the image should be rendered gray scaled and anti aliased
- isImmediateUpload() - Method in interface com.ebasetech.xi.api.controls.FileUploadControl
-
Returns true if selected files are immediately uploaded, otherwise returns false.
- isImmediateValidation() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates whether or not control should pass immediately to the Ebase Server when the user changes the field's value.
- isIncludePageNumbers() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
Indicates whether or not clickable page numbers are included in the navigation bar.
- isInheritMsg() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if Use parent control setting is checked in the Message Options properties for the control, otherwise returnsfalse
. - isInsertable() - Method in interface com.ebasetech.xi.api.controls.TableControl
-
Returns whether or not the user row insertion built-in feature is activated.
- isJavascriptUsed() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
if Javascript is currently being used. - isLoadedByServiceWorker() - Method in interface com.ebasetech.xi.api.WebForm
-
Returns
true
if this form is being loaded by a client Javascript service worker. - isLocalMsg() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if Local Message is checked in the Message Options properties for the control, otherwise returnsfalse
. - isLocation() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
- isLockHeld(String, String) - Method in interface com.ebasetech.xi.api.LockManager
-
Returns true if the lock is held by another user, returns false if no lock exists or the lock is held by the user associated with the current thread.
- isMandatory() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Deprecated.
- isMarkParentsAsSelected() - Method in interface com.ebasetech.xi.api.controls.MenuControl
-
Indicates whether or not all parent menu items are also marked as selected when a lower level menu item is selected.
- isMenuBar() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
-
Returns
true
if the popup window should display the browser menu bar, otherwise returnsfalse
. - isMobile() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is a mobile phone. - isMultipleFilesSupported() - Method in interface com.ebasetech.xi.api.controls.FileUploadControl
-
Returns true if multiple files can be uploaded at once, otherwise returns false.
- isNewLine() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns the new line property.
- isNextDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel
-
Indicates whether or not the next page button is displayed as an image.
- isOmitBrackets() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl
-
Returns whether to include the brackets in the human readable part of the message
- isOpera() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is Opera, otherwise returnsfalse
. - isPopup() - Method in class com.ebasetech.xi.api.PdfOptions
-
Returns the
popup
option. - isPrevDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel
-
Indicates whether or not the previous page button is displayed as an image.
- isQuietZoneEnabled() - Method in interface com.ebasetech.xi.api.controls.BarcodeControl
-
Returns whether the quiet zone should be rendered
- isReplaceDuplicateFiles() - Method in interface com.ebasetech.xi.api.controls.FileUploadControl
-
Returns true if files with duplicate names will be replaced, otherwise returns false.
- isReportMode() - Method in class com.ebasetech.xi.api.PdfOptions
-
Returns the
report mode
option. - isRequired() - Method in interface com.ebasetech.xi.api.controls.FieldControlProperties
-
Indicates whether or not this is a required field.
- isResizable() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
-
Returns
true
if the popup window should be resizable, otherwise returnsfalse
. - isRestoreDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel
-
Indicates whether or not the restore button is displayed as an image.
- isRowDeletedByUser() - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the current row (see
Table.getCurrentRow()
) is marked as deleted by the user. - isRowDeletedByUser(int) - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the specified row is marked as deleted by the user.
- isRowEmpty() - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the current row (see
Table.getCurrentRow()
) is marked as empty. - isRowEmpty(int) - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the specified row is marked as empty.
- isRowInserted() - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the current row (see
Table.getCurrentRow()
) has been inserted. - isRowInserted(int) - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the specified row has been inserted.
- isRowModified() - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the current row (see
Table.getCurrentRow()
) has been modified. - isRowModified(int) - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the specified row has been modified.
- isRowSelected() - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the current row (see
Table.getCurrentRow()
) is marked as selected - isRowSelected(int) - Method in interface com.ebasetech.xi.api.Table
-
Returns true if the specified row is marked as selected.
- isSafari() - Method in interface com.ebasetech.xi.api.Client
-
Returns
true
when the client browser is Safari, otherwise returnsfalse
. - isSave() - Method in class com.ebasetech.xi.api.PdfOptions
-
Returns the
save
option. - isSaveDisplayAsImage() - Method in interface com.ebasetech.xi.api.controls.PageNavigationPanel
-
Indicates whether or not the save button is displayed as an image.
- isScrollBar() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
-
Returns
true
if the popup window should display scroll bars when applicable, otherwise returnsfalse
. - isSecure() - Method in interface com.ebasetech.xi.api.Client
-
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
- isSelectable() - Method in interface com.ebasetech.xi.api.controls.TableControl
-
Returns whether or not the user row selection built-in feature is activated.
- isShareable() - Method in interface com.ebasetech.xi.api.controls.MenuControl
-
Indicates whether the menu state can be shared with menu controls on other pages or forms.
- isShowColumnHeaders() - Method in interface com.ebasetech.xi.api.controls.TableControl
-
Indicates whether or not column headers are displayed.
- isShowInactiveScrollIcons() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
Indicates whether or not inactive scroll icons/texts are included in the navigation bar.
- isShowInfoMessage() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
Indicates whether or not the row information text is displayed in the navigation bar.
- isShowing() - Method in interface com.ebasetech.xi.api.controls.Control
-
Returns
true
if the control will be included in the web page when it's next displayed to the user, otherwise returnsfalse
. - isShowTableHeadersOverPDFPages() - Method in interface com.ebasetech.xi.api.controls.TableControl
-
When a page is included in a PDF, indicates whether column headers will be re-displayed at the top of each expansion page.
- isSigned() - Method in interface com.ebasetech.xi.api.JWS
-
Return true if the specified JWT compact string represents a signed JWS, false otherwise.
- isSkipValidation() - Method in interface com.ebasetech.xi.api.controls.ButtonControlProperties
-
Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
- isSkipValidation() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl
-
Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the hyperlink's on click event.
- isSkipValidation() - Method in interface com.ebasetech.xi.api.controls.ImageControlProperties
-
Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the image's on click event (if configured).
- isSkipValidation() - Method in interface com.ebasetech.xi.api.controls.MenuControl
-
Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped when a menu item is selected.
- isSkipValidation() - Method in interface com.ebasetech.xi.api.controls.TabSetControl
-
Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the on tab click event (if configured).
- isSortable() - Method in interface com.ebasetech.xi.api.controls.FieldColumnControl
-
Indicates whether or not the user can sort the table by this column.
- isStartNewRowOnNextPage() - Method in interface com.ebasetech.xi.api.controls.BaseTableControl
-
When a page is included in a PDF, indicates whether the content of a table row can be split across two pages.
- isStatic() - Method in interface com.ebasetech.xi.api.controls.IncludeControl
-
Indicates whether the JSP/HTML file represented by this control should be refreshed when Ajax communication is enabled and a page is redisplayed e.g.
- isStatusBar() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
-
Returns
true
if the popup window should display the browser status line, otherwise returnsfalse
. - isSuccess() - Method in interface com.ebasetech.xi.services.RestResponse
-
Returns whether response code is successful following a
RestServices
call. - isToolBar() - Method in interface com.ebasetech.xi.api.controls.InfoPopupProperties
-
Returns
true
if the popup window should display the browser tool bar with forward and back buttons etc, otherwise returnsfalse
. - isUrlParameter() - Method in interface com.ebasetech.xi.api.WebFormField
-
Returns true if the field is a URL parameter field.
- isUseExternalURL() - Method in interface com.ebasetech.xi.api.controls.HyperlinkControl
-
Indicates whether the link is external or internal.
- isUseJavascript() - Method in interface com.ebasetech.xi.api.SystemPreferences
-
Returns
false
if the Do not use Javascript option is checked in System Preferences (see Tools > System Prefences > Accessibility), otherwise returnstrue
. - isUsePopups() - Method in interface com.ebasetech.xi.api.SystemPreferences
-
Returns
false
if the Do not popup new windows option is checked in System Preferences (see Tools > System Prefences > Accessibility), otherwise returnstrue
. - isUserLoggedOn() - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns
true
when a user is logged on to the current session, otherwise returnsfalse
. - isUserLoggedOn(String) - Method in interface com.ebasetech.xi.api.SecurityManager
-
Returns
true
if the named user is currently logged on to the server, otherwise returnsfalse
. - isWorkingDay(Date) - Static method in class com.ebasetech.xi.services.DateServices
-
Returns true if the date is configured as a non-working day in the organisational calendar, otherwise false.
All Classes|All Packages
FieldControlProperties.isRequired()
instead