Java Doc for IUnApplication.java in  » J2EE » WiSerFramework » de » ug2t » unifiedGui » interfaces » Java Source Code / Java DocumentationJava Source Code and Java Documentation

author:
   IUnApplication is the common interface to application-objects for all
author:
   supported channels. The current release supports Java Swing and MARKUP based
author:
   Applications and corresponding clients
author:
  

Adds a mapping listener to the application.

Adds a page to the application.

Removes the service from the application without killing it.

renders the current page

the channel specific render-information.

Gets the application-context, which means that all objects which are associated to the application are collected within an instance of a HashMap.

map with all associated objects.

Sets the state of the workflow-statemachine.

Do events bubble up the component tree (default true).

Is the application-instance-client in mdi-mode or not.

Removes a mapping listener from the application.

Sets the specified page active.

Sets the gui-object-factory which is associated to this application-instance.

Sets whether events bubble up the component tree or not.

If a dialog is used within a mdi environment it may be reshaped.

Sets the host/domain name of an application.

Sets the communication port of the application.

Sets the icon which is displayed in the clients main-window.

Sets the URL of the application.

Sets a background processing function to the application.

Sets a background processing process (see process documentation for more information) to the application.

Sets the statemachine which rules the workflow of the application.

Sets the current user-name.

Every time the persist method is called a checkpoint is set in the HO session recording.

Executes a client-request

Parameters:
  xReq - channel specific request-object
Parameters:
  xResp - channel specific response-object
Parameters:
  xRobust - true indicates the all exceptions will be catched within thefunction.

Adds a listener to a widget placed at the specified path on the specified page

the widget which to which the listener was added

Parameters:
  xPage - page where the widget is placed
Parameters:
  xPath - path of the widget within the page
Parameters:
  xListener - listener-object to add

Adds a listener to a widget placed at the specified path in the application

the widget which to which the listener was added

Parameters:
  xPath - path of the widget within the page
Parameters:
  xListener - listener-object to add

Adds a mapping listener to the application. The listener is called whenever a value of a component is mapped to it's peer.

Parameters:
  xListen - listener to add

Adds a page to the application. After that the page can be set as the active-one by the given name. If there is already a page of this name it is removed

null if there was no page of this name available in the applicationbefore the page which had this name before

Parameters:
  xName - name of the page
Parameters:
  xPage - page-object to insert

Start a session transaction, for example to do several changes of remote widgets

For internal use only

Closes the application on client- and server-side before the system-cleanup is performed

a Type with

Commit a session transaction

Removes the service from the application without killing it. For Swing applications this has no effect until stopping the process.

process object for background processing

Disables the lazy widget feature

renders the current page

the channel specific render-information. In case of MARKUP thecorresponding String is returned

gets the current active page-object

active page-object

Returns the type of the application

application type

Returns whether the client poll the server or not

true indicates poll, false no poll

Gets the gui-object-factory which is associated to this application-instance

factory-object

Gets the application-context, which means that all objects which are associated to the application are collected within an instance of a HashMap.

map with all associated objects. New objects may be inserted here

Returns the name of the current template kit or null if no kit is available

templatekit name

Gets the external CSS stylesheet reference

Returns whether reshape events are generated or not

the genReshapeEvent property

Gets the hostname of the server which hosts the application in its String-representatation

current hostname

Gets the current main-menu of the application

interface to the current menu-object

Gets the communication-port of the application

tcp/ip - port

Gets the protocol for http bases communication

Gets the role of the current user

role-name

Gets the URL of the application

URL

Gets the background processing service from the application

process object for background processing

Gets the communication-session which handles all client-server communication for this application instance

session-object

Sets the state of the workflow-statemachine. This feature is currently not completely supported!

the previous state of the statemachine

Gets the associated gui-object which implements all common methods

gui-object

Gets the current user-name, which is signed on

user-name

Return whether css is supported or not

css supported

Do events bubble up the component tree (default true). If false, indirect events will not work! If bubbling is disabled the order of the events is random!

true indicate event bubbling

Is the application-instance-client in mdi-mode or not.

true indicate mdi-mode false indicates sdi-mode

Persits the current application

reactivation object (usually a string with a link)

Playback a recorded Session

Playback a recorded Session

For internal use only

Start Session recording

To inform a clustered container that session values changed

Removes a mapping listener from the application.

Parameters:
  xListen - listener to remove

For internal use only

Rollback a session transaction

Sets the specified page active. That means that this page will be rendered when the next GUI-refresh appears

null if the requested page-object was not found the active page-object

Parameters:
  xName - requested page-object

Sets the size of the main application-window

Parameters:
  xWi - width
Parameters:
  xHi - height

Sets the gui-object-factory which is associated to this application-instance. There is no need to use this function, the framework sets the correct value.

Parameters:
  xFact - factory-object

Sets whether events bubble up the component tree or not. If bubbling is disabled the order of the events is random!

Parameters:
  xBubble - true or false

Sets an external CSS stylesheet reference

If a dialog is used within a mdi environment it may be reshaped. Because the corresponding events lead to massive network traffic, they can be enabled and disabled separately.

Parameters:
  xReshapes - true or false

Sets the host/domain name of an application.

Sets the communication port of the application.

Sets the icon which is displayed in the clients main-window. The icon is specified by its registred name

a Type with

Parameters:
  xName - registred icon-object name

For internal use only

Set the Init-function of the application, this function is executed before any other operation of the application has been performed

Parameters:
  xInit - IScExecutable object

Sets the main-menu of the application

Parameters:
  xMainMenu - interface to a menu-object

Sets the protocol for http bases communication

Sets the handler wich is calld when the application has been resumed

Parameters:
  xResHdl - Handler, ccalled after resume service

Sets the role of the current user

previous role-name

Parameters:
  xRole - role-name

Sets the URL of the application. Mainly for internal use!

Parameters:
  xUrl - URL

Sets a background processing function to the application. The function is called every xPollService milliseconds. The Client is refreshed every xRefresh milliseconds

Parameters:
  xServiceFct - background processing function, null stops and removes an existingservice
Parameters:
  xPollService - poll intervall in milliseconds
Parameters:
  xRefresh - client refresh intervall in millisrconds (>1000)

Sets a background processing process (see process documentation for more information) to the application. This is used for complex, event driven or maybe distributed background processing. The Client is refreshed every xRefresh milliseconds.

Parameters:
  xPollServiceProc - poll intervall in milliseconds
Parameters:
  xRefresh - client refresh intervall in millisrconds (>1000)

Sets the statemachine which rules the workflow of the application. This feature is currently not completely supported!

Parameters:
  xState - workflow-statemachine

Sets the current user-name.

the previous user-name

Parameters:
  xUser - new user-name

Shows the applications main frame

Starts the client polling the server every xPollTime millis

Parameters:
  xPollTime - poll invervall in milli seconds

Stops the clinet polling th server

Every time the persist method is called a checkpoint is set in the HO session recording. This function sets the recording back to the last checkpoint.

Executes a client-request

Parameters:
  xReq - channel specific request-object
Parameters:
  xResp - channel specific response-object
Parameters:
  xRobust - true indicates the all exceptions will be catched within thefunction. false indicates that all exceptions will be propagatedto the calling api-level