public interface UserServicePaneWriter extends UIFormWriter, UserServiceWriter
This interface provides useful methods for rendering a user service pane.
Some methods of this class have a Path parameter. These paths are always relative.
If a path is for an item of a dynamic model or a dataset adaptation, it is relative to the schema root element.
If a path is for an item of a record, the path is relative to the record root element.
Documentation
UserServicePane.writePane(UserServicePaneContext, UserServicePaneWriter)| Modifier and Type | Method and Description |
|---|---|
void |
addPane(UserServicePane aPane)
Adds a pane.
|
ObjectKey |
getCurrentObjectKey()
Returns the key of the current object.
|
String |
getPreviousTabSelected(String aTabbedPaneId)
Returns the id of the selected tab of a tabbed pane prior to last
submit or
null if the tabbed pane was not yet submitted. |
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.
|
UserServiceTabbedPane |
newTabbedPane()
Creates a tabbed pane.
|
UserServiceTabbedPane |
newTabbedPane(String anId)
Creates a tabbed pane.
|
void |
setCurrentObject(ObjectKey anObjectKey)
Sets the current object that will be used to resolve path expressions.
|
addFormGroup, addFormRow, addFormRow, addFormRow, addFormRow, addFormRowOrGroup, addJS_getNodeValue, addJS_hideTab, addJS_setNodeMandatoryIndicator, addJS_setNodeValue, addJS_showTab, addLabel, addWidget, addWidget, getDisplayMode, getPrefixedPath, newBestMatching, newCheckBox, newCheckBoxGroup, newColorPicker, newComboBox, newCustomWidget, newDatasetSelector, newDataspaceSelector, newDateTime, newDropDownList, newFormGroup, newFormRow, newListBox, newPassword, newRadioButton, newRadioButtonGroup, newTable, newTextBox, startBorder, startFormGroup, startFormRowaddButton, newActionButton, newActionButtonaddButtonHelp, addButtonJavaScript, addButtonJavaScriptToggle, addUILabel, addUserAvatar, buildButtonPreview, buildButtonPreview, buildButtonPreview, endBorder, endExpandCollapseBlock, endFormGroup, endFormRow, endTableFormRow, newExpandCollapseBlock, newFormGroup, newFormRow, startBorder, startBorder, startBorder, startExpandCollapseBlock, startExpandCollapseBlock, startFormGroup, startFormGroup, startFormRow, startFormRow, startFormRow, startFormRow, startTableFormRowadd_cr, add_cr, add, add, add, addSafeAttribute, addSafeAttribute, addSafeInnerHTML, addSafeInnerHTMLaddJS_addResizeWorkspaceListener, addJS_cr, addJS_cr, addJS_openPreviewImage, addJS_openPreviewImageFromVar, addJS_setButtonDisabled, addJS_setExpandCollapseBlockExpanded, addJS_setStateToToggleButton, addJS_switchToPerspective, addJS_switchToPerspectiveAction, addJSaddJavaScriptDependencygetLocale, getSessiongetURLForAction, getURLForAction, getURLForAjaxRequest, getURLForAjaxRequest, getURLForEndingService, getURLForGetRequest, getURLForGetRequest, getURLForResource, getURLForResource, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelection, getURLForServiceSelectioncreateWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelectionvoid setCurrentObject(ObjectKey anObjectKey)
anObjectKey - the key of an object of the current object context or null if no current object.UIFormWriter.getPrefixedPath(Path)ObjectKey getCurrentObjectKey()
null if no current object.void addPane(UserServicePane aPane)
aPane - the pane to be added.UIButtonSpecSubmit newSubmitButton(String aLabel, UserServiceEvent aCallback)
aLabel - the button's label.aCallback - the callback.UIButtonSpecSubmit newSubmitButton(UserMessage aLabel, UserServiceEvent aCallback)
aLabel - the button's label.aCallback - the callback.UserServiceTabbedPane newTabbedPane()
If this pane is added to a page whose structure may vary at each display,
one should consider using instead the method {newTabbedPane(String).
UserServiceTabbedPane 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, non-null
value. Not doing so prevents EBX® from reselecting
previously selected tabs after a redisplay.String getPreviousTabSelected(String aTabbedPaneId)
null if the tabbed pane was not yet submitted.aTabbedPaneId - A valid id of a tabbed pane.null
if the tabbed pane was not yet submitted or if id is unknown.