From 33613a85afc4b1481367fbe92a17ee59c240250b Mon Sep 17 00:00:00 2001 From: Sven Eisenhauer Date: Fri, 10 Nov 2023 15:11:48 +0100 Subject: add new repo --- .../client/jsf/dialog/VisualRepresentationId.html | 489 +++++++++++++++++++++ 1 file changed, 489 insertions(+) create mode 100644 Master/Reference Architectures and Patterns/labs/QuasarClient/api/com/sdm/quasar/client/jsf/dialog/VisualRepresentationId.html (limited to 'Master/Reference Architectures and Patterns/labs/QuasarClient/api/com/sdm/quasar/client/jsf/dialog/VisualRepresentationId.html') diff --git a/Master/Reference Architectures and Patterns/labs/QuasarClient/api/com/sdm/quasar/client/jsf/dialog/VisualRepresentationId.html b/Master/Reference Architectures and Patterns/labs/QuasarClient/api/com/sdm/quasar/client/jsf/dialog/VisualRepresentationId.html new file mode 100644 index 0000000..dc8df90 --- /dev/null +++ b/Master/Reference Architectures and Patterns/labs/QuasarClient/api/com/sdm/quasar/client/jsf/dialog/VisualRepresentationId.html @@ -0,0 +1,489 @@ + + + + + + +VisualRepresentationId (Quasar Client Building Blicks API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.sdm.quasar.client.jsf.dialog +
+Class VisualRepresentationId

+
+java.lang.Object
+  extended bycom.sdm.quasar.client.jsf.dialog.VisualRepresentationId
+
+
+
+
public class VisualRepresentationId
extends java.lang.Object
+ +

+

+ The VisualRepresentationId defines the parameters which identify a + VisualRepresentation. The parameters are added to a response as + hidden fiels (addIdToPage(PostParameters) or as url parameters + (addIdToRequestParameters(GetParameters)). + They could also be addad as token to the view id (getIdAsToken()). + Thus, in any case the corresponding VisualRepresentation will be + identified at the next request from this page + (identifyVisualRepresentation(HttpServletRequest, BrowserWindow)). +

+

+ The Id of a VisualRepresentation is build out of the dialog id and + the dialog instance id of the dialog of the VisualRepresentation. +

+

+ +

+

+
Author:
+
Martin Haft
+
+
+ +

+ + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringDIALOGID_REQUEST_PARAMETER_NAME + +
+          the tag identifying the dialog-id information
+static java.lang.StringDIALOGINSTANCEID_REQUEST_PARAMETER_NAME + +
+          the tag identifying the dialog-instance-id information
+  + + + + + + + + + + + +
+Constructor Summary
+protected VisualRepresentationId(VisualRepresentation visualRepresentation) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddIdToPage(PostParameters postParameters) + +
+          Add the id parameters to the PostParameters.
+ voidaddIdToRequestParameters(GetParameters parameters) + +
+          Add the id parameters to the GetParameters.
+protected static booleancheck(com.sdm.quasar.client.jsf.dialog.InternalId internalId, + VisualRepresentation visualRepresentation) + +
+           
+protected static java.lang.StringgetDialogIdFromToken(java.lang.String token) + +
+           
+protected static java.lang.StringgetDialogInstanceIdFromToken(java.lang.String token) + +
+           
+ java.lang.StringgetIdAsToken() + +
+          Returns a unique token for this dialog-instance id.
+static VisualRepresentationidentifyVisualRepresentation(HttpServletRequest request, + BrowserWindow browserWindow) + +
+          A VisualRepresentation registered at a BrowserWindow is ideentified + from the parameters of the request.
+protected static com.sdm.quasar.client.jsf.dialog.InternalIdreadInternalId(HttpServletRequest request) + +
+          Reads the id parameters from the request and returns then. +
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DIALOGID_REQUEST_PARAMETER_NAME

+
+public static java.lang.String DIALOGID_REQUEST_PARAMETER_NAME
+
+
the tag identifying the dialog-id information +

+

+
+
+
+ +

+DIALOGINSTANCEID_REQUEST_PARAMETER_NAME

+
+public static java.lang.String DIALOGINSTANCEID_REQUEST_PARAMETER_NAME
+
+
the tag identifying the dialog-instance-id information +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+VisualRepresentationId

+
+protected VisualRepresentationId(VisualRepresentation visualRepresentation)
+
+
+ + + + + + + + +
+Method Detail
+ +

+addIdToRequestParameters

+
+public void addIdToRequestParameters(GetParameters parameters)
+
+
Add the id parameters to the GetParameters. +

+

+
Parameters:
parameters - the get parameters the id is added to
+
+
+
+ +

+addIdToPage

+
+public void addIdToPage(PostParameters postParameters)
+                 throws java.io.IOException
+
+
Add the id parameters to the PostParameters. +

+

+ +
Throws: +
java.io.IOException
+
+
+
+ +

+getIdAsToken

+
+public java.lang.String getIdAsToken()
+
+
Returns a unique token for this dialog-instance id. +

+

+ +
Returns:
the token representing the dialog-instance id
+
+
+
+ +

+identifyVisualRepresentation

+
+public static VisualRepresentation identifyVisualRepresentation(HttpServletRequest request,
+                                                                BrowserWindow browserWindow)
+
+
A VisualRepresentation registered at a BrowserWindow is ideentified + from the parameters of the request. If no VisualRepresentation of the given + BrowserWindow matches the id parameters of the request, null is returned +

+

+
Parameters:
request - the current request
browserWindow - the current BrowserWindow +
Returns:
the identified VisualRepresentation or null if no VisualRepresentation + is found.
+
+
+
+ +

+readInternalId

+
+protected static com.sdm.quasar.client.jsf.dialog.InternalId readInternalId(HttpServletRequest request)
+
+
Reads the id parameters from the request and returns then. + If id parameters are missing, null is returned. +

+

+
Parameters:
request - the current request +
Returns:
the id parameters readed from the request or null if parameters are + missing or incomplete.
+
+
+
+ +

+check

+
+protected static boolean check(com.sdm.quasar.client.jsf.dialog.InternalId internalId,
+                               VisualRepresentation visualRepresentation)
+
+
+ +
Returns:
true, if the given VisualRepresentation is identified by the given Id
+
+
+
+ +

+getDialogIdFromToken

+
+protected static java.lang.String getDialogIdFromToken(java.lang.String token)
+
+
+
+
+
+
+ +

+getDialogInstanceIdFromToken

+
+protected static java.lang.String getDialogInstanceIdFromToken(java.lang.String token)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + -- cgit v1.2.3