public interface UserServiceDisplayConfigurator extends UserServiceResourceLocator
UserService.setupDisplay(UserServiceSetupDisplayContext, UserServiceDisplayConfigurator)
Modifier and Type | Method and Description |
---|---|
UIButtonSpecNavigation |
newActionButton(String aLabel,
UserServiceEvent aCallback)
Creates a specification for an action button.
|
UIButtonSpecNavigation |
newActionButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a specification for a localized action button.
|
UIButtonSpecNavigation |
newBackButton(UserServiceEvent aCallback)
Creates a specification for a back button.
|
UIButtonSpecNavigation |
newCancelButton()
Creates a specification for a cancel button.
|
UIButtonSpecNavigation |
newCloseButton()
Creates a specification for a close button.
|
UIButtonSpecSubmit |
newFinishButton(UserServiceEvent aCallback)
Creates a specification for a finish button.
|
UIButtonSpecSubmit |
newNextButton(UserServiceEvent aCallback)
Creates a specification for a next button.
|
UIButtonSpecNavigation |
newRevertButton()
Creates a specification for a revert button.
|
UIButtonSpecSubmit |
newSaveButton(UserServiceEvent aCallback)
Creates a specification for a save button.
|
UIButtonSpecSubmit |
newSaveCloseButton(UserServiceEvent aCallback)
Creates a specification for a save and close button.
|
UIButtonSpecSubmit |
newSubmitButton(String aLabel,
UserServiceEvent aCallback)
Creates a specification for a submit button.
|
UIButtonSpecSubmit |
newSubmitButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a localized specification for a submit button.
|
UserServiceRootTabbedPane |
newTabbedPane()
Creates a tabbed pane.
|
UserServiceRootTabbedPane |
newTabbedPane(String anId)
Creates a tabbed pane.
|
Action |
newToolbarAction(UserServiceEvent aCallback)
Returns a toolbar action that can be used in a top toolbar.
|
void |
setAlwaysConfirmLeaveEnabled(boolean isEnabled)
Sets whether or not the user is always prompted for a confirmation
when the page is abandoned before submitting the input.
|
void |
setBottomBarDisplayed(boolean isBottomBarDisplayed)
Displays or hides the user service bottom bar.
|
void |
setBreadcrumbs(String... labels)
Sets the header's breadcrumbs.
|
void |
setBreadcrumbs(UIFormLabelSpec... labels)
Sets the localized header's breadcrumbs.
|
void |
setCenterButtons(UIButtonSpec... buttons)
Sets the bottom bar center buttons.
|
void |
setCloseCallback(UserServiceEvent aCallback)
Sets the close and cancel buttons callback.
|
void |
setContent(UserServicePane aCallback)
Sets a callback used for rendering a pane.
|
void |
setContent(UserServiceRawPane aCallback)
Sets a callback used for rendering a view pane.
|
void |
setDefaultButtons(UserServiceEvent aSaveCallback)
Sets the default bottom bar.
|
void |
setDetectionOfLostModificationDisabled(boolean isDisabled)
Sets whether or not the user is prompted for a confirmation when information
have been entered in the form, but the page is abandoned before submitting
the input.
|
void |
setFileUploadEnabled(boolean isEnabled)
Sets whether or not the EBX® form can upload files, that
is if the form encryption type is in "multipart/form-data".
|
void |
setHeaderDisplayed(boolean isHeaderDisplayed)
Displays or hides the user service header.
|
void |
setLeftButtons(UIButtonSpec... buttons)
Sets the bottom bar left buttons.
|
void |
setRightButtons(UIButtonSpec... buttons)
Sets the bottom bar right buttons.
|
void |
setTitle(String aTitle)
Sets the title of the service.
|
void |
setTitle(UIFormLabelSpec aTitle)
Sets the localized title of the service.
|
void |
setTitle(UserMessage aTitle)
Sets the localized title of the service.
|
void |
setToolbar(String aToolbarName,
Adaptation aRecord)
Sets the toolbar to one defined in a schema for a record.
|
void |
setToolbar(String aToolbarName,
AdaptationTable aTable)
Sets the toolbar to one defined in a schema for a table.
|
void |
setToolbar(String aToolbarName,
ObjectKey anObjectKey,
boolean isForTable)
Sets the toolbar to one defined in a schema for a record or a table.
|
void |
setToolbar(Toolbar aToolbar)
Sets the toolbar to one defined programmatically.
|
void |
setToolbar(Toolbar aToolbar,
Adaptation aRecord)
Sets the toolbar to one defined programmatically for a record.
|
void |
setToolbar(Toolbar aToolbar,
AdaptationTable aTable)
Sets the toolbar to one defined programmatically for a table.
|
void |
setToolbar(Toolbar aToolbar,
ObjectKey anObjectKey,
boolean isForTable)
Sets the toolbar to one defined programmatically for a record or a table.
|
void |
setToolbarFirstCallback(UserServiceEvent aCallback)
Sets the toolbar "first" button callback.
|
void |
setToolbarLastCallback(UserServiceEvent aCallback)
Sets the toolbar "last" button callback.
|
void |
setToolbarNavigationAlwaysDisplayed(boolean isAlwaysDisplayed)
Sets the toolbar navigation display mode.
|
void |
setToolbarNextCallback(UserServiceEvent aCallback)
Sets the toolbar "next" button callback.
|
void |
setToolbarPreviousCallback(UserServiceEvent aCallback)
Sets the toolbar "previous" button callback.
|
void |
setURLForContextualHelp(String aURL)
Sets the URL for the help page and displays a help button.
|
getURLForAction, getURLForAction, getURLForAjaxRequest, getURLForAjaxRequest, getURLForEndingService, getURLForGetRequest, getURLForGetRequest, getURLForResource, getURLForResource, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection
createWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelection
void setHeaderDisplayed(boolean isHeaderDisplayed)
isHeaderDisplayed
- if true
the header is displayed, if false
the header is hidden,void setTitle(String aTitle)
aTitle
- The title of the service.void setTitle(UserMessage aTitle)
aTitle
- The title of the service.void setTitle(UIFormLabelSpec aTitle)
aTitle
- The title of the service.void setURLForContextualHelp(String aURL)
aURL
- the url for the help page.UserServiceResourceLocator
void setCloseCallback(UserServiceEvent aCallback)
Default callback simply closes current service.
aCallback
- the callback.newCloseButton()
,
newCancelButton()
void setToolbar(String aToolbarName, ObjectKey anObjectKey, boolean isForTable)
aToolbarName
- A toolbar name defined in the schema.anObjectKey
- An object key of a record. The schema of this record must define
a toolbar with a name equal to aToolbarName
for
location "table on top" if isForTable
is true
or "record form on top" if isForTable
is false
.isForTable
- if true
, the toolbar is for the table of the record, if
false
, the toolbar is for the record itself. In this
latter case, the record cannot be a new one not yet persisted.void setToolbar(Toolbar aToolbar, ObjectKey anObjectKey, boolean isForTable)
aToolbar
- The toolbar.anObjectKey
- An object key of a record.isForTable
- if true
, the toolbar is for the table of the record, if
false
, the toolbar is for the record itself. In this
latter case, the record cannot be a new one not yet persisted.void setToolbar(String aToolbarName, Adaptation aRecord)
aToolbarName
- A toolbar name defined in the schema.aRecord
- The record. The schema of this record must define
a toolbar with a name equal to aToolbarName
for
location "record form on top".void setToolbar(Toolbar aToolbar, Adaptation aRecord)
aToolbar
- The toolbar.aRecord
- the record.void setToolbar(String aToolbarName, AdaptationTable aTable)
aToolbarName
- A toolbar name defined in the schema.aTable
- A table. The schema of this record must define
a toolbar with a name equal to aToolbarName
for
location "table on top".void setToolbar(Toolbar aToolbar, AdaptationTable aTable)
aToolbar
- The toolbar.aTable
- A table.void setToolbar(Toolbar aToolbar)
aToolbar
- The toolbar.void setToolbarNavigationAlwaysDisplayed(boolean isAlwaysDisplayed)
isAlwaysDisplayed
- If true
, the navigation buttons will always
be displayed. If false
, navigation buttons will be
displayed only if a least one of the callbacks for the first,
previous, next or last buttons are set.void setToolbarFirstCallback(UserServiceEvent aCallback)
aCallback
- the action callback that will be called when user clicks
on "first" button.void setToolbarLastCallback(UserServiceEvent aCallback)
aCallback
- the action callback that will be called when user clicks
on "last" button.void setToolbarPreviousCallback(UserServiceEvent aCallback)
aCallback
- the action callback that will be called when user clicks
on "previous" button.void setToolbarNextCallback(UserServiceEvent aCallback)
aCallback
- the action callback that will be called when user clicks
on "next" button.Action newToolbarAction(UserServiceEvent aCallback)
aCallback
- the callback that is called when the action is triggered by the user.void setBreadcrumbs(String... labels)
labels
- the label of each breadcrumb, from left (first label)
to right (last label).void setBreadcrumbs(UIFormLabelSpec... labels)
labels
- the label of each breadcrumb, from left (first label) to
right (last label).void setDetectionOfLostModificationDisabled(boolean isDisabled)
Default value is false
.
This value is ignored if the content is not in a pane.
isDisabled
- true
to disable form detection upon leaving the page,
false
to enable it.UIButtonSpecNavigation.setAskBeforeLeavingModifiedForm(boolean)
void setAlwaysConfirmLeaveEnabled(boolean isEnabled)
Default value is false
.
This value is ignored if the content is not an EBX® form
or if setDetectionOfLostModificationDisabled(boolean)
was
called with value true
.
isEnabled
- true
to always prompt for a confirmation when the page is
abandoned before submitting the input, false
to prompt for
a confirmation only if input was modified and the page is abandoned
before submitting.UIButtonSpecNavigation.setAskBeforeLeavingModifiedForm(boolean)
void setFileUploadEnabled(boolean isEnabled)
Default value is false
.
This value is ignored if the content is not an EBX® form.
isEnabled
- true
to enable file upload,
false
to disable it.void setContent(UserServicePane aCallback)
aCallback
- the pane callback.void setContent(UserServiceRawPane aCallback)
aCallback
- the view callback.void setBottomBarDisplayed(boolean isBottomBarDisplayed)
Note: the bottom bar is always hidden if no button can be displayed.
isBottomBarDisplayed
- if true
the bottom bar is displayed, if
false
the bottom bar is hidden,void setDefaultButtons(UserServiceEvent aSaveCallback)
void setLeftButtons(UIButtonSpec... buttons)
buttons
- an array of buttons to display.void setCenterButtons(UIButtonSpec... buttons)
buttons
- an array of buttons to display.void setRightButtons(UIButtonSpec... buttons)
buttons
- an array of buttons to display.UIButtonSpecNavigation newCloseButton()
setCloseCallback(UserServiceEvent)
UIButtonSpecNavigation newCancelButton()
setCloseCallback(UserServiceEvent)
UIButtonSpecSubmit newSaveButton(UserServiceEvent aCallback)
aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpec.setDefaultButton(boolean)
UIButtonSpecSubmit newSaveCloseButton(UserServiceEvent aCallback)
aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecNavigation newRevertButton()
UIButtonSpecNavigation newBackButton(UserServiceEvent aCallback)
By default, the back button does not ask for a confirmation if the current input was modified.
UIButtonSpecSubmit newNextButton(UserServiceEvent aCallback)
aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecSubmit newFinishButton(UserServiceEvent aCallback)
aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecNavigation newActionButton(String aLabel, UserServiceEvent aCallback)
aLabel
- the button's label.aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecNavigation newActionButton(UserMessage aLabel, UserServiceEvent aCallback)
aLabel
- the button's label.aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecSubmit newSubmitButton(String aLabel, UserServiceEvent aCallback)
aLabel
- the button's label.aCallback
- the callback that is called when a button is clicked by the user.UIButtonSpecSubmit newSubmitButton(UserMessage aLabel, UserServiceEvent aCallback)
aLabel
- the button's label.aCallback
- the callback that is called when a button is clicked by the user.UserServiceRootTabbedPane newTabbedPane()
If this pane is added to a page whose structure may vary at each display,
one should consider using insted method {newTabbedPane(String)
.
UserServiceRootTabbedPane newTabbedPane(String anId)
anId
- The id for the pane. If this pane is added to a page whose structure
may vary at each display, id should be a fixed none null
value. Not doing so prevents EBX® from reselecting
previously selected tab after a redisplay.