de.tif.jacob.screen
Class IClientContext

java.lang.Object
  SessionContext
      de.tif.jacob.screen.IClientContext

public abstract class IClientContext
extends SessionContext

Client context in which an user action has been performed. A proper initialized instance of this class will be provided to all relevant GUI hooks, if a client performs a server request. Application programmers could/should use this abstract class to create user dialog windows in a client independent way.

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Method Summary

void	clearApplication() Completely resets the application object associated with the application window, i.e. this includes the reset off all application's domains.
void	clearDomain() Resets the current domain.
void	clearForm() Resets the current form.
void	clearForm(java.lang.String domainName, java.lang.String formName) Resets a specified form.
abstract void	clearGroup() Resets the current group.
abstract IAskDialog	createAskDialog(java.lang.String question, IAskDialogCallback callback)
abstract IAskDialog	createAskDialog(java.lang.String question, java.lang.String startValue, IAskDialogCallback callback)
abstract IDocumentDialog	createDocumentDialog(DataDocumentValue document) Creates a document dialog to download or display the given document value.
abstract IDocumentDialog	createDocumentDialog(java.lang.String mimeType, DataDocumentValue document) Creates a document dialog to download or display the given document value.
abstract IDocumentDialog	createDocumentDialog(java.lang.String mimeType, java.lang.String fileName, byte[] content) Creates a document dialog to download or display the given file content.
abstract IExcelDialog	createExcelDialog()
abstract IFormDialog	createFormDialog(java.lang.String title, FormLayout layout, IFormDialogCallback callback)
abstract IGridTableDialog	createGridTableDialog(IGuiElement anchor) Creates a grid table dialog.
abstract IGridTableDialog	createGridTableDialog(IGuiElement anchor, IGridTableDialogCallback callback) Creates a grid table dialog.
abstract IMessageDialog	createMessageDialog(Message message)
abstract IMessageDialog	createMessageDialog(java.lang.String message)
abstract IOkCancelDialog	createOkCancelDialog(Message question, IOkCancelDialogCallback callback)
abstract IOkCancelDialog	createOkCancelDialog(java.lang.String question, IOkCancelDialogCallback callback)
abstract IRecordTreeDialog	createRecordTreeDialog(IGuiElement anchor, IDataTableRecord record, IRelationSet relationSet, Filldirection filldirection, IRecordTreeDialogCallback callback)
abstract IUploadDialog	createUploadDialog(IUploadDialogCallback callback) Creates a file upload dialog.
abstract IUrlDialog	createUrlDialog(java.lang.String url) Creates a file URL dialog.
IApplication	getApplication() Returns the application object.
IDataBrowser	getDataBrowser() Returns the current data browser for the group in which the user action has been performed.
IDataTable	getDataTable() Returns the current data table for the group in which the user action has been performed.
IDomain	getDomain() Returns the current working domain.
IDomain	getDomain(java.lang.String domainName) Returns the domain object specified by name.
IForm	getForm() Returns the current form.
IGroup	getGroup() Returns the current group.
IBrowser	getGUIBrowser() Returns the search browser of the current group.
IDataTableRecord	getSelectedRecord() Returns the selected data table record of the current group, i.e. the group in which the user action has been performed.
Session	getSession()
abstract boolean	getShowSQL() Internal method to check whether visualization of SQL request is switched on or off.
void	refreshGroup() Refetchs the data element from the database of the current group.
void	setCurrentForm(java.lang.String formName) Sets the current form, i.e. switches the form to be displayed.
void	setCurrentForm(java.lang.String domainName, java.lang.String formName) Sets the current form, i.e. switches the form to be displayed.
void	setDataBrowser(IDataBrowser browser) Set the current data browser for the group in which the action has performed.
abstract void	setShowSQL(boolean enable) Internal method to switch on/off visualization of SQL requests.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Method Detail

setShowSQL

public abstract void setShowSQL(boolean enable)

Internal method to switch on/off visualization of SQL requests.

Parameters:

enable - true to switch on, false to switch off

getShowSQL

public abstract boolean getShowSQL()

Internal method to check whether visualization of SQL request is switched on or off.

Returns:

true if switch on, false if switch off

createRecordTreeDialog

public abstract IRecordTreeDialog createRecordTreeDialog(IGuiElement anchor,
                                                         IDataTableRecord record,
                                                         IRelationSet relationSet,
                                                         Filldirection filldirection,
                                                         IRecordTreeDialogCallback callback)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

createFormDialog

public abstract IFormDialog createFormDialog(java.lang.String title,
                                             FormLayout layout,
                                             IFormDialogCallback callback)

createOkCancelDialog

public abstract IOkCancelDialog createOkCancelDialog(java.lang.String question,
                                                     IOkCancelDialogCallback callback)

createOkCancelDialog

public abstract IOkCancelDialog createOkCancelDialog(Message question,
                                                     IOkCancelDialogCallback callback)

createAskDialog

public abstract IAskDialog createAskDialog(java.lang.String question,
                                           IAskDialogCallback callback)

createAskDialog

public abstract IAskDialog createAskDialog(java.lang.String question,
                                           java.lang.String startValue,
                                           IAskDialogCallback callback)

createUrlDialog

public abstract IUrlDialog createUrlDialog(java.lang.String url)

Creates a file URL dialog.

Either jACOB (application) internal or external web pages could be displayed.
External URLs must start with "http://", otherwise the URL is treated as internal and will be completed by means of "http://server:port/jacob/".

Examples:

url	resulting URL
http://www.google.com	http://www.google.com
groupinfo.jsp	http://www.tarragon.de:8080/jacob/groupinfo.jsp
application/marketplace/1.0/index.html	http://www.tarragon.de:8080/jacob/application/marketplace/1.0/index.html

Parameters:

url - the URL to the web page to display

Returns:

the created URL dialog

createMessageDialog

public abstract IMessageDialog createMessageDialog(java.lang.String message)

createMessageDialog

public abstract IMessageDialog createMessageDialog(Message message)

createExcelDialog

public abstract IExcelDialog createExcelDialog()

createUploadDialog

public abstract IUploadDialog createUploadDialog(IUploadDialogCallback callback)

Creates a file upload dialog.

Parameters:

callback - the dialog callback

Returns:

the created file upload dialog

createDocumentDialog

public abstract IDocumentDialog createDocumentDialog(DataDocumentValue document)

Creates a document dialog to download or display the given document value.

Parameters:

document - the document value to create dialog for

Returns:

the created document dialog. Call IDialog.show() to display the dialog.

See Also:

IDataRecord.getDocumentValue(String)

createDocumentDialog

public abstract IDocumentDialog createDocumentDialog(java.lang.String mimeType,
                                                     DataDocumentValue document)

Creates a document dialog to download or display the given document value.

Parameters:

mimeType - the mime type to use or null for default mime type

document - the document value to create dialog for

Returns:

the created document dialog. Call IDialog.show() to display the dialog.

See Also:

IDataRecord.getDocumentValue(String)

createDocumentDialog

public abstract IDocumentDialog createDocumentDialog(java.lang.String mimeType,
                                                     java.lang.String fileName,
                                                     byte[] content)

Creates a document dialog to download or display the given file content.

Parameters:

mimeType - the mime type to use or null for default mime type

fileName - the file name

content - the file content

Returns:

the created document dialog. Call IDialog.show() to display the dialog.

createGridTableDialog

public abstract IGridTableDialog createGridTableDialog(IGuiElement anchor)

Creates a grid table dialog.

Parameters:

anchor - the anchor GUI element

Returns:

the created grid table dialog

createGridTableDialog

public abstract IGridTableDialog createGridTableDialog(IGuiElement anchor,
                                                       IGridTableDialogCallback callback)

Creates a grid table dialog.

Parameters:

anchor - the anchor GUI element

callback - the dialog callback

Returns:

the created grid table dialog

getDataBrowser

public final IDataBrowser getDataBrowser()
                                  throws java.lang.Exception

Returns the current data browser for the group in which the user action has been performed.

Returns:

the current data browser

Throws:

java.lang.Exception

setDataBrowser

public final void setDataBrowser(IDataBrowser browser)
                          throws java.lang.Exception

Set the current data browser for the group in which the action has performed.

Throws:

java.lang.Exception

getDataTable

public final IDataTable getDataTable()
                              throws java.lang.Exception

Returns the current data table for the group in which the user action has been performed.

Returns:

the current data table

Throws:

java.lang.Exception

getGUIBrowser

public final IBrowser getGUIBrowser()
                             throws java.lang.Exception

Returns the search browser of the current group. The current group is the the group which has fired the last event.

Returns:

The current/visible search browser

Throws:

java.lang.Exception

clearApplication

public final void clearApplication()
                            throws java.lang.Exception

Completely resets the application object associated with the application window, i.e. this includes the reset off all application's domains.

Throws:

java.lang.Exception

See Also:

clearDomain()

clearDomain

public final void clearDomain()
                       throws java.lang.Exception

Resets the current domain.

Throws:

java.lang.Exception

clearForm

public final void clearForm()
                     throws java.lang.Exception

Resets the current form.

Throws:

java.lang.Exception

clearForm

public void clearForm(java.lang.String domainName,
                      java.lang.String formName)
               throws java.lang.Exception

Resets a specified form.

Parameters:

domainName - The parent domain of the form to reset

formName - The name of the form to reset

Throws:

java.lang.Exception

clearGroup

public abstract void clearGroup()
                         throws java.lang.Exception

Resets the current group.

Throws:

java.lang.Exception

refreshGroup

public void refreshGroup()
                  throws java.lang.Exception

Refetchs the data element from the database of the current group.

Throws:

java.lang.Exception

getSelectedRecord

public IDataTableRecord getSelectedRecord()
                                   throws java.lang.Exception

Returns the selected data table record of the current group, i.e. the group in which the user action has been performed.

Returns:

the selected data table record or null if no selected record exists

Throws:

java.lang.Exception

setCurrentForm

public void setCurrentForm(java.lang.String formName)
                    throws java.lang.Exception

Sets the current form, i.e. switches the form to be displayed. The specified form must be contained in the current domain.

Parameters:

formName - the name of the form to display

Throws:

java.lang.Exception - on any problem

setCurrentForm

public void setCurrentForm(java.lang.String domainName,
                           java.lang.String formName)
                    throws java.lang.Exception

Sets the current form, i.e. switches the form to be displayed. The specified form must be contained in the given domain.

Parameters:

domainName - the name of the domain which contains the form to display

formName - the name of the form to display

Throws:

java.lang.Exception - on any problem, e.g. no such domain or form exists

getDomain

public final IDomain getDomain()

Returns the current working domain. This is the domain in which the last user action has been performed.

Returns:

the current domain

getDomain

public final IDomain getDomain(java.lang.String domainName)
                        throws java.lang.Exception

Returns the domain object specified by name.

Parameters:

domainName - the name of the domain object to return

Returns:

the desired domain

Throws:

java.lang.Exception - on any problem, e.g. no such domain exists.

getForm

public final IForm getForm()

Returns the current form.

Returns:

the current form

getGroup

public final IGroup getGroup()

Returns the current group.

Returns:

the current group

getApplication

public final IApplication getApplication()

Returns the application object.

Returns:

the application object

getSession

public final Session getSession()

See Also:

de.tif.jacob.core.SessionContext#getSession()