public interface WidgetDisplayContext
This context is provided by the user interface container.
UICustomWidget
Modifier and Type | Method and Description |
---|---|
String |
displayOccurrence(Object aValue,
boolean useLabels)
Returns a string to display the specified value
according to the current locale of this context.
|
Perspective |
getCurrentPerspective()
Returns the current perspective.
|
com.orchestranetworks.hierarchy.Member |
getHierarchyMember()
Returns the current hierarchy member if the current
UIBeanEditor
is instantiated in the context of a hierarchy. |
HierarchyNode |
getHierarchyNode()
Deprecated.
Replaced by
getHierarchyMember() . |
SchemaNode |
getNode()
Returns the node to which the component is attached, as specified in the data model.
|
String |
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.
|
AccessPermission |
getPermission()
Returns the current user's access rights on the current node.
|
AccessPermission |
getPermission(Path aPath)
Returns the current user's access rights on the node specified by
a path.
|
ValueContext |
getValueContext()
Returns the value context of the current element.
|
ValueContext |
getValueContext(Path aPath)
Returns the value context of the target element.
|
boolean |
isCreatingRecord()
Returns
true if this component is displayed in
the context of a new record creation. |
boolean |
isDisplayedInForm()
Returns true if this widget is currently displayed in a form.
|
boolean |
isDisplayedInTable()
Returns true if this widget is currently displayed in a table grid cell.
|
boolean |
isDuplicatingRecord()
Returns
true if this component is displayed in
the context of the duplication of an existing record. |
SchemaNode getNode()
ValueContext.getNode()
ValueContext getValueContext()
ValueContext getValueContext(Path aPath)
String displayOccurrence(Object aValue, boolean useLabels)
The specified value must be related to the current node.
String getOptionalRequestParameterValue(String aParameterName)
String[] getOptionalRequestParameterValues(String aParameterName)
boolean isDisplayedInForm()
boolean isDisplayedInTable()
AccessPermission getPermission()
AccessPermission getPermission(Path aPath)
aPath
- the path of the node. The path must be relative to the path of
the current widget.PathAccessException
- to report that the path is invalid.SessionPermissions.getNodeAccessPermissionForForm(SchemaNode, Adaptation)
boolean isCreatingRecord()
true
if this component is displayed in
the context of a new record creation. In this case, the persistent record
does not yet exist.boolean isDuplicatingRecord()
true
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.com.orchestranetworks.hierarchy.Member getHierarchyMember()
UIBeanEditor
is instantiated in the context of a hierarchy.
Returns null
otherwise.
This method allows specializing the look and feel of the user interface for hierarchy contexts.
HierarchyNode getHierarchyNode()
getHierarchyMember()
.Perspective getCurrentPerspective()