com.axemble.vdoc.sdk.interfaces

Interface IResourceController

All Superinterfaces:

IController, Serializable

public interface IResourceController
extends IController

This class allows to interact with the user interface.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IWorkflowInstance, ILinkedResource

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM_CONTAINER The identifier of the bottom container.
static int	TOP_CONTAINER The identifier of the top container.

Method Summary

Modifier and Type	Method and Description
void	alert(String message) Allows to display an alert box.
void	alert(String message, com.axemble.vdp.ui.framework.components.listeners.AlertBoxListener listener) Allows to display an alert box and get notified on the CLICK event.
void	confirm(String message, com.axemble.vdp.ui.framework.components.listeners.ConfirmBoxListener listener) Allows to display a confirm box and interact with OK, CANCEL events.
void	execute(com.axemble.vdp.ui.framework.widgets.CtlButton button) Executes the button as if that was the logged on user.
String	getAccessKey(String propertyName) Gets the access key.
com.axemble.vdp.ui.framework.widgets.CtlButton	getBottomButton(String buttonName) Gets a button from the bottom container.
com.axemble.vdp.ui.framework.widgets.CtlButton	getButton(String buttonName, int container) Gets a button from the specified container.
com.axemble.vdp.ui.framework.runtime.NamedContainer	getButtonContainer(int container) Gets a button container by selecting either the top or bottom container.
com.axemble.vdp.ui.framework.foundation.Widget	getDefaultWidget(String propertyName) Gets the first writable field.
int	getTabIndex(String propertyName) Gets the tab index.
com.axemble.vdp.ui.framework.widgets.CtlButton	getTopButton(String buttonName) Gets a button from the top container.
void	inform(String propertyName, String message) Allow to set a message underneath the field widget.
void	inform(String fragmentName, String propertyName, String message) Allow to set a message underneath the field widget in a specified fragment.
boolean	isAllEditable(String fragmentName, String propertyName) Checks if all specified fields are editable in a specified fragment.
boolean	isAllHidden(String fragmentName, String propertyName) Checks if all specified fields are hidden in a specified fragment.
boolean	isAllMandatory(String fragmentName, String propertyName) Checks if all specified fields are mandatory in a specified fragment.
boolean	isEditable(String propertyName) Checks if a specified field is writable.
boolean	isHidden(String propertyName) Checks if a specified field is hidden.
boolean	isMandatory(String propertyName) Checks if a specified field is mandatory.
void	popup(String url) Allows to open a child window (as a popup window).
void	popup(String url, String parameters) Allows to open a child window (as a popup window) and specify the window.open parameters.
void	setAccessKey(String propertyName, String accessKey) Sets the access key of the field.
void	setDocumentInformation(String newInformation) Sets the process document information message.
void	setDocumentTitle(String newTitle) Sets the process document title.
void	setEditable(String propertyName, boolean editable) Sets to writable a specified field.
void	setEditable(String fragmentName, String propertyName, boolean editable) Sets to writable a specified field in a fragment.
void	setHidden(String propertyName, boolean hidden) Hide a specified field.
void	setHidden(String fragmentName, String propertyName, boolean hidden) Hide a specified field in a specified fragment.
void	setHtml(String id, String content) Allows to fill an tag with HTML content.
void	setMandatory(String propertyName, boolean mandatory) Set to mandatory a specified field.
void	setMandatory(String fragmentName, String propertyName, boolean mandatory) Set to mandatory a specified field in a fragment.
void	setTabIndex(String propertyName, int tabIndex) Sets the tab index of the field.
void	setThrowEvents(String propertyName, boolean throwEvents) Allow the field to post-back to the server.
void	setThrowEvents(String fragment, String propertyName, boolean throwEvents) Allow the field in a specified fragment to post-back to the server.
void	showBackToParentButton(boolean show) Allows to hide or display the back to parent button.
void	showBodyBlock(String marker, boolean show) Allows to hide or display a specified element by its marker within the body.
void	showHeaderBlock(String marker, boolean show) Allows to hide or display a specified element by its marker within the header.
void	showHeaderSection(boolean show) Allows to hide or display the header section.
void	showHelpButton(boolean show) Allows to hide or display the main help section.
void	showHistorySection(boolean show) Allows to hide or display the history section.
void	showPrintButton(boolean show) Allows to hide or display the print button.

Field Detail

TOP_CONTAINER

static final int TOP_CONTAINER

The identifier of the top container.

See Also:

Constant Field Values

BOTTOM_CONTAINER

static final int BOTTOM_CONTAINER

The identifier of the bottom container.

See Also:

Constant Field Values

Method Detail

getTopButton

com.axemble.vdp.ui.framework.widgets.CtlButton getTopButton(String buttonName)

Gets a button from the top container.

Parameters:

buttonName - the system name of the button.

Returns:

a CtlButton object.

getBottomButton

com.axemble.vdp.ui.framework.widgets.CtlButton getBottomButton(String buttonName)

Gets a button from the bottom container.

Parameters:

buttonName - the system name of the button.

Returns:

a CtlButton object.

getButton

com.axemble.vdp.ui.framework.widgets.CtlButton getButton(String buttonName,
                                                         int container)

Gets a button from the specified container.

Parameters:

buttonName - the system name of the button.

container - either one of the following values :

• IResourceController.TOP_CONTAINER (value 1)
• IResourceController.BOTTOM_CONTAINER (value 2)

Returns:

a CtlButton object.

getButtonContainer

com.axemble.vdp.ui.framework.runtime.NamedContainer getButtonContainer(int container)

Gets a button container by selecting either the top or bottom container.

Parameters:

container - either one of the following values :

• IResourceController.TOP_CONTAINER (value 1)
• IResourceController.BOTTOM_CONTAINER (value 2)

Returns:

a NamedContainer object.

execute

void execute(com.axemble.vdp.ui.framework.widgets.CtlButton button)

Executes the button as if that was the logged on user.

Parameters:

button - the CtlButton object.

setMandatory

void setMandatory(String propertyName,
                  boolean mandatory)

Set to mandatory a specified field.

Parameters:

propertyName - the system name of the field.

mandatory - true or false.

setMandatory

void setMandatory(String fragmentName,
                  String propertyName,
                  boolean mandatory)

Set to mandatory a specified field in a fragment.

Parameters:

fragmentName - the system name of the fragment

propertyName - the system name of the field.

mandatory - true or false.

isMandatory

boolean isMandatory(String propertyName)

Checks if a specified field is mandatory.

Parameters:

propertyName - the system name of the field.

Returns:

true or false.

isAllMandatory

boolean isAllMandatory(String fragmentName,
                       String propertyName)

Checks if all specified fields are mandatory in a specified fragment.

Parameters:

fragmentName -

propertyName - the system name of the field.

Returns:

true or false.

setHidden

void setHidden(String propertyName,
               boolean hidden)

Hide a specified field.

Parameters:

propertyName - the system name of the field.

hidden -

setHidden

void setHidden(String fragmentName,
               String propertyName,
               boolean hidden)

Hide a specified field in a specified fragment.

Parameters:

fragmentName - the system name of the fragment

propertyName - the system name of the field.

hidden -

isHidden

boolean isHidden(String propertyName)

Checks if a specified field is hidden.

Parameters:

propertyName - the system name of the field.

Returns:

true or false.

isAllHidden

boolean isAllHidden(String fragmentName,
                    String propertyName)

Checks if all specified fields are hidden in a specified fragment.

Parameters:

fragmentName -

propertyName - the system name of the field.

Returns:

true or false.

setEditable

void setEditable(String propertyName,
                 boolean editable)

Sets to writable a specified field.

Parameters:

propertyName - the system name of the field.

editable -

setEditable

void setEditable(String fragmentName,
                 String propertyName,
                 boolean editable)

Sets to writable a specified field in a fragment.

Parameters:

fragmentName - the system name of the fragment

propertyName - the system name of the field.

editable -

isEditable

boolean isEditable(String propertyName)

Checks if a specified field is writable.

Parameters:

propertyName -

Returns:

true or false.

isAllEditable

boolean isAllEditable(String fragmentName,
                      String propertyName)

Checks if all specified fields are editable in a specified fragment.

Parameters:

fragmentName -

propertyName - the system name of the field.

Returns:

true or false.

setThrowEvents

void setThrowEvents(String propertyName,
                    boolean throwEvents)

Allow the field to post-back to the server.

Parameters:

propertyName - the system name of the field.

throwEvents - true or false.

setThrowEvents

void setThrowEvents(String fragment,
                    String propertyName,
                    boolean throwEvents)

Allow the field in a specified fragment to post-back to the server.

Parameters:

fragment - the system name of the fragment

propertyName - the system name of the field.

throwEvents - true or false.

inform

void inform(String propertyName,
            String message)

Allow to set a message underneath the field widget.

Parameters:

propertyName - the system name of the field.

message - the message to display.

inform

void inform(String fragmentName,
            String propertyName,
            String message)

Allow to set a message underneath the field widget in a specified fragment.

Parameters:

fragmentName - the system name of the fragment

propertyName - the system name of the field.

message - the message to display.

getTabIndex

int getTabIndex(String propertyName)

Gets the tab index.

Parameters:

propertyName - the system name of the field.

Returns:

the index of the tab.

setTabIndex

void setTabIndex(String propertyName,
                 int tabIndex)

Sets the tab index of the field.

Parameters:

propertyName - the system name of the field.

tabIndex - the index of the tab to set.

getAccessKey

String getAccessKey(String propertyName)

Gets the access key.

Parameters:

propertyName - the system name of the field.

Returns:

a String object.

setAccessKey

void setAccessKey(String propertyName,
                  String accessKey)

Sets the access key of the field.

Parameters:

propertyName - the system name of the field.

accessKey - the access key to set.

getDefaultWidget

com.axemble.vdp.ui.framework.foundation.Widget getDefaultWidget(String propertyName)

Gets the first writable field.

Parameters:

propertyName - the system name of the field.

Returns:

a Widget object.

showHeaderBlock

void showHeaderBlock(String marker,
                     boolean show)

Allows to hide or display a specified element by its marker within the header.

Parameters:

marker - the system name of the marker.

show - true or false.

showBodyBlock

void showBodyBlock(String marker,
                   boolean show)

Allows to hide or display a specified element by its marker within the body.

Parameters:

marker - the system name of the marker.

show - true or false.

showHeaderSection

void showHeaderSection(boolean show)

Allows to hide or display the header section.

Parameters:

show - true or false.

showHistorySection

void showHistorySection(boolean show)

Allows to hide or display the history section.

Parameters:

show - true or false.

setDocumentTitle

void setDocumentTitle(String newTitle)

Sets the process document title.

Parameters:

newTitle - The new title to set.

setDocumentInformation

void setDocumentInformation(String newInformation)

Sets the process document information message.

Parameters:

newInformation - The new information message to set.

showHelpButton

void showHelpButton(boolean show)

Allows to hide or display the main help section.

Parameters:

show - true or false.

showPrintButton

void showPrintButton(boolean show)

Allows to hide or display the print button.

Parameters:

show - true or false.

showBackToParentButton

void showBackToParentButton(boolean show)

Allows to hide or display the back to parent button.

Parameters:

show - true or false.

alert

void alert(String message)

Allows to display an alert box.

Parameters:

message - The message to display.

alert

void alert(String message,
           com.axemble.vdp.ui.framework.components.listeners.AlertBoxListener listener)

Allows to display an alert box and get notified on the CLICK event.

Parameters:

message - The message to display.

listener - The listener object to handle events.

confirm

void confirm(String message,
             com.axemble.vdp.ui.framework.components.listeners.ConfirmBoxListener listener)

Allows to display a confirm box and interact with OK, CANCEL events.

Parameters:

message - The message to display.

listener - The listener object to handle events.

popup

void popup(String url)

Allows to open a child window (as a popup window).

Parameters:

url - The url to load.

popup

void popup(String url,
           String parameters)

Allows to open a child window (as a popup window) and specify the window.open parameters.

Parameters:

url - The url to load.

parameters - The parameters of the window.open() method. Example : "800 ,600, 1, 1, 1, 0".

setHtml

void setHtml(String id,
             String content)

Allows to fill an tag with HTML content.

Parameters:

id - Identifier of the tag.

content - HTML description.