public interface WidgetWriter extends UIFormWriter
UICustomWidget
Modifier and Type | Method and Description |
---|---|
void |
addEmptyFieldButton(String buttonId,
boolean isDisabled,
String aJavaScriptCommand)
Adds a button with the built-in "empty field" button look and feel.
|
void |
addServiceButton(Path aPath)
Adds a service menu button to the specified node.
|
void |
addUIDescription(Path aPath) |
void |
addUIDisplayValue(Path aPath)
Displays the value of the specified field.
|
void |
addUILabel(Path aPath)
Adds the standard label of the specified data model node.
|
void |
addUIValidationMessage(Path aPath)
Adds the validation message associated with the specified node.
|
UITableCellStyleHandler |
getTableCellStyleHandler()
This method allows customizing the look of a table cell.
|
String |
getWidgetName()
Returns the custom widget name based on the node path to which this widget is bound.
|
String |
getWidgetName(Path aPath)
Returns the custom widget name based on the given path.
|
String |
getWidgetName(String aLocalId)
Returns the custom widget name based on the given string.
|
String |
getWidgetNameOfParent()
Returns the custom widget name of the parent component.
|
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, startFormRow
addButtonHelp, 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, startTableFormRow
add_cr, add_cr, add, add, add, addSafeAttribute, addSafeAttribute, addSafeInnerHTML, addSafeInnerHTML
addJS_addResizeWorkspaceListener, addJS_cr, addJS_cr, addJS_openPreviewImage, addJS_openPreviewImageFromVar, addJS_setButtonDisabled, addJS_setExpandCollapseBlockExpanded, addJS_setStateToToggleButton, addJS_switchToPerspective, addJS_switchToPerspectiveAction, addJS
createWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelection
addJavaScriptDependency
getLocale, getSession
String getWidgetName()
The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
String getWidgetName(Path aPath)
The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
aPath
- location of the target relative to the current node (for maximizing reusability,
it is advised to use a relative path)String getWidgetName(String aLocalId)
The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
aLocalId
- must respect the pattern [a-zA-Z0-9_.-]+
String getWidgetNameOfParent()
The web name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the web name policy can be modified at any time.
UITableCellStyleHandler getTableCellStyleHandler() throws IllegalStateException
It can only be invoked in the context of a table grid cell display.
See WidgetDisplayContext.isDisplayedInTable()
for more information.
IllegalStateException
- if this method is called outside of a table cell.void addEmptyFieldButton(String buttonId, boolean isDisabled, String aJavaScriptCommand)
A click on this button will execute the given JavaScript command.
void addServiceButton(Path aPath)
If no services are defined for the node, or if no services are granted to the user according to access rights, no button will be added.
The standard position of the service button is to the right of the component; the standard position of the validation message is below the component.
aPath
- required, location of the target, relative to the current node;
to improve reusability, use a relative path.addUIValidationMessage(Path)
void addUIValidationMessage(Path aPath)
The standard position of the validation message is below the component, and the standard position of the service button is to the right of the component.
aPath
- required, location of the target, relative to the current node;
to improve reusability, use a relative path.addServiceButton(Path)
void addUIDescription(Path aPath)
aPath
- required, location of the target, relative to the current node;
to improve reusability, use a relative path.void addUILabel(Path aPath)
The description and additional information about the node are available in a pop-up.
aPath
- required, location of the target, relative to the current node
(for better reusability, it is advised to use a relative path)UIComponentWriter.addUILabel(UIFormLabelSpec)
void addUIDisplayValue(Path aPath)
aPath
- required, location of the target, relative to the current node;
to improve reusability, use a relative path.