Interface WidgetDisplayContext
public interface WidgetDisplayContext
Context of a custom widget, containing values and
information about the context in which the widget is called.
This context is provided by the user interface container.
- Since:
- 5.8.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondisplayOccurrence
(Object aValue, boolean useLabels) Returns a string to display the specified value according to the current locale of this context.Returns the current perspective.Returns the view context.com.orchestranetworks.hierarchy.Member
Returns the current hierarchy member if the currentUIBeanEditor
is instantiated in the context of a hierarchy.Deprecated.getNode()
Returns the node to which the component is attached, as specified in the data model.getOptionalRequestParameterValue
(String aParameterName) Returns the HTTP parameter value in the incoming request.String[]
getOptionalRequestParameterValues
(String aParameterName) Returns the HTTP parameter values in the incoming request.Returns the current user's access rights on the current node.getPermission
(Path aPath) Returns the current user's access rights on the node specified by a path.Returns the value context of the current element.getValueContext
(Path aPath) Returns the value context of the target element.boolean
Returnstrue
if this component is displayed in the context of a new record creation.boolean
Returns true if this widget is currently displayed in a form.boolean
Returns true if this widget is currently displayed in a table grid cell.boolean
Returnstrue
if this component is displayed in the context of the duplication of an existing record.
-
Method Details
-
getNode
SchemaNode getNode()Returns the node to which the component is attached, as specified in the data model.- See Also:
-
getValueContext
ValueContext getValueContext()Returns the value context of the current element. -
getValueContext
Returns the value context of the target element. -
displayOccurrence
Returns a string to display the specified value according to the current locale of this context.The specified value must be related to the current node.
-
getOptionalRequestParameterValue
Returns the HTTP parameter value in the incoming request. -
getOptionalRequestParameterValues
Returns the HTTP parameter values in the incoming request. -
isDisplayedInForm
boolean isDisplayedInForm()Returns true if this widget is currently displayed in a form. -
isDisplayedInTable
boolean isDisplayedInTable()Returns true if this widget is currently displayed in a table grid cell. -
getPermission
AccessPermission getPermission()Returns the current user's access rights on the current node. -
getPermission
Returns the current user's access rights on the node specified by a path.- Parameters:
aPath
- the path of the node. The path must be relative to the path of the current widget.- Throws:
PathAccessException
- to report that the path is invalid.- See Also:
-
isCreatingRecord
boolean isCreatingRecord()Returnstrue
if this component is displayed in the context of a new record creation. In this case, the persistent record does not yet exist. -
isDuplicatingRecord
boolean isDuplicatingRecord()Returnstrue
if this component is displayed in the context of the duplication of an existing record. In this case, the target persistent record does not yet exist. -
getHierarchyMember
com.orchestranetworks.hierarchy.Member getHierarchyMember()Returns the current hierarchy member if the currentUIBeanEditor
is instantiated in the context of a hierarchy. Returnsnull
otherwise.This method allows specializing the look and feel of the user interface for hierarchy contexts.
-
getHierarchyNode
Deprecated.Replaced bygetHierarchyMember()
. -
getCurrentPerspective
Perspective getCurrentPerspective()Returns the current perspective.- Since:
- 6.0.0
-
getCustomViewContext
UICustomViewContext getCustomViewContext()Returns the view context.- Since:
- 6.1.0
-
getHierarchyMember()
.