Package com.axemble.vdoc.sdk.impl

Class ScreenResourceController

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.BaseResourceController

com.axemble.vdoc.sdk.impl.ScreenResourceController

All Implemented Interfaces:

IController, IResourceController, Serializable

public class ScreenResourceController
extends BaseResourceController
implements IResourceController

Resource controller for external IHM manipulation

Author:

vlygeros

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected com.axemble.vdp.ui.core.providers.INavigationListenerImpl	currentNavigation
protected GenericResource	resource

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Fields inherited from interface com.axemble.vdoc.sdk.interfaces.IResourceController

BOTTOM_CONTAINER, TOP_CONTAINER

Constructor Summary

Constructors

Constructor	Description
ScreenResourceController(IModule module, IResource resource)	Constructor

Method Summary

Modifier and Type	Method	Description
void	collapseSection(String identifier, boolean collapse)	Show or collapse the content of a section in a form
com.axemble.vdp.ui.framework.widgets.CtlButton	getBottomButton(String buttonName)	Gets a button from the bottom container.
IButton	getBottomIButton(String buttonName)	Gets a button from the bottom container.
com.axemble.vdp.ui.framework.runtime.NamedContainer	getButtonContainer(int container)	Gets a button container by selecting either the top or bottom container.
INamedContainer	getButtonIContainer(int container)	Gets a button container by selecting either the top or bottom container.
IWidget	getDefaultIWidget(String propertyName)	Gets the first writable field.
com.axemble.vdp.ui.framework.foundation.Widget	getDefaultWidget(String propertyName)	Gets the first writable field.
com.axemble.vdp.ui.framework.widgets.CtlButton	getTopButton(String buttonName)	Gets a button from the top container.
IButton	getTopIButton(String buttonName)	Gets a button from the top container.
Collection<com.axemble.vdp.ui.framework.foundation.Widget>	getWidgets(String propertyName)
Collection<com.axemble.vdp.ui.framework.foundation.Widget>	getWidgets(String marker, String propertyName)
void	setDocumentInformation(String newInformation)	Sets the process document information message.
void	setDocumentTitle(String newTitle)	Sets the process document title.
void	setHtml(String id, String content)	Allows to fill an tag with HTML content.
final void	setMandatory(String propertyName, boolean mandatory)	Set to mandatory a specified field.
final void	setMandatory(String fragmentName, String propertyName, boolean mandatory)	Set to mandatory a specified field in a fragment.
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.

Methods inherited from class com.axemble.vdoc.sdk.impl.BaseResourceController

alert, alert, alert, confirm, confirm, execute, execute, getAccessKey, getButton, getIButton, getTabIndex, inform, inform, isAllEditable, isAllHidden, isAllMandatory, isEditable, isHidden, isMandatory, popup, popup, setAccessKey, setEditable, setEditable, setHidden, setHidden, setTabIndex, setThrowEvents, setThrowEvents

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IResourceController

alert, alert, alert, confirm, confirm, execute, execute, getAccessKey, getButton, getIButton, getTabIndex, inform, inform, isAllEditable, isAllHidden, isAllMandatory, isEditable, isHidden, isMandatory, popup, popup, setAccessKey, setEditable, setEditable, setHidden, setHidden, setTabIndex, setThrowEvents, setThrowEvents

Field Details

resource

protected GenericResource resource

currentNavigation

protected com.axemble.vdp.ui.core.providers.INavigationListenerImpl currentNavigation

Constructor Details

ScreenResourceController

public ScreenResourceController(IModule module,
 IResource resource)

Constructor

Parameters:

module - the module

resource - the resource

Method Details

getButtonContainer

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

Description copied from interface: IResourceController

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

Specified by:

getButtonContainer in interface IResourceController

Parameters:

container - either one of the following values :

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

Returns:

a NamedContainer object.

getButtonIContainer

public INamedContainer getButtonIContainer(int container)

Description copied from interface: IResourceController

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

Specified by:

getButtonIContainer in interface IResourceController

Parameters:

container - either one of the following values :

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

Returns:

a INamedContainer object.

getTopButton

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

Description copied from interface: IResourceController

Gets a button from the top container.

Specified by:

getTopButton in interface IResourceController

Specified by:

getTopButton in class BaseResourceController

Parameters:

buttonName - the system name of the button.

Returns:

a CtlButton object.

getTopIButton

public IButton getTopIButton(String buttonName)

Description copied from interface: IResourceController

Gets a button from the top container.

Specified by:

getTopIButton in interface IResourceController

Specified by:

getTopIButton in class BaseResourceController

Parameters:

buttonName - the system name of the button.

Returns:

a IButton object.

getBottomButton

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

Description copied from interface: IResourceController

Gets a button from the bottom container.

Specified by:

getBottomButton in interface IResourceController

Specified by:

getBottomButton in class BaseResourceController

Parameters:

buttonName - the system name of the button.

Returns:

a CtlButton object.

getBottomIButton

public IButton getBottomIButton(String buttonName)

Description copied from interface: IResourceController

Gets a button from the bottom container.

Specified by:

getBottomIButton in interface IResourceController

Specified by:

getBottomIButton in class BaseResourceController

Parameters:

buttonName - the system name of the button.

Returns:

a IButton object.

getDefaultWidget

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

Description copied from interface: IResourceController

Gets the first writable field.

Specified by:

getDefaultWidget in interface IResourceController

Specified by:

getDefaultWidget in class BaseResourceController

Parameters:

propertyName - the system name of the field.

Returns:

a Widget object.

getDefaultIWidget

public IWidget getDefaultIWidget(String propertyName)

Description copied from interface: IResourceController

Gets the first writable field.

Specified by:

getDefaultIWidget in interface IResourceController

Specified by:

getDefaultIWidget in class BaseResourceController

Parameters:

propertyName - the system name of the field.

Returns:

a IWidget object.

getWidgets

public Collection<com.axemble.vdp.ui.framework.foundation.Widget> getWidgets(String propertyName)

Specified by:

getWidgets in class BaseResourceController

getWidgets

public Collection<com.axemble.vdp.ui.framework.foundation.Widget> getWidgets(String marker,
 String propertyName)

Specified by:

getWidgets in class BaseResourceController

setDocumentInformation

public void setDocumentInformation(String newInformation)

Description copied from interface: IResourceController

Sets the process document information message.

Specified by:

setDocumentInformation in interface IResourceController

Parameters:

newInformation - The new information message to set.

setDocumentTitle

public void setDocumentTitle(String newTitle)

Description copied from interface: IResourceController

Sets the process document title.

Specified by:

setDocumentTitle in interface IResourceController

Parameters:

newTitle - The new title to set.

showBodyBlock

public void showBodyBlock(String marker,
 boolean show)

Description copied from interface: IResourceController

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

Specified by:

showBodyBlock in interface IResourceController

Parameters:

marker - the system name of the marker.

show - true or false.

showHeaderBlock

public void showHeaderBlock(String marker,
 boolean show)

Description copied from interface: IResourceController

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

Specified by:

showHeaderBlock in interface IResourceController

Parameters:

marker - the system name of the marker.

show - true or false.

showHeaderSection

public void showHeaderSection(boolean show)

Description copied from interface: IResourceController

Allows to hide or display the header section.

Specified by:

showHeaderSection in interface IResourceController

Parameters:

show - true or false.

showHelpButton

public void showHelpButton(boolean show)

Description copied from interface: IResourceController

Allows to hide or display the main help section.

Specified by:

showHelpButton in interface IResourceController

Parameters:

show - true or false.

showPrintButton

public void showPrintButton(boolean show)

Description copied from interface: IResourceController

Allows to hide or display the print button.

Specified by:

showPrintButton in interface IResourceController

Parameters:

show - true or false.

showBackToParentButton

public void showBackToParentButton(boolean show)

Description copied from interface: IResourceController

Allows to hide or display the back to parent button.

Specified by:

showBackToParentButton in interface IResourceController

Parameters:

show - true or false.

showHistorySection

public void showHistorySection(boolean show)

Description copied from interface: IResourceController

Allows to hide or display the history section.

Specified by:

showHistorySection in interface IResourceController

Parameters:

show - true or false.

collapseSection

public void collapseSection(String identifier,
 boolean collapse)

Description copied from interface: IResourceController

Show or collapse the content of a section in a form

Specified by:

collapseSection in interface IResourceController

Parameters:

identifier - the session's identifier (visible in the studio)

collapse - true to collapse

setHtml

public void setHtml(String id,
 String content)

Description copied from interface: IResourceController

Allows to fill an tag with HTML content.

Specified by:

setHtml in interface IResourceController

Parameters:

id - Identifier of the tag.

content - HTML description.

setMandatory

public final void setMandatory(String propertyName,
 boolean mandatory)

Description copied from interface: IResourceController

Set to mandatory a specified field.

Specified by:

setMandatory in interface IResourceController

Parameters:

propertyName - the system name of the field.

mandatory - true or false.

setMandatory

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

Description copied from interface: IResourceController

Set to mandatory a specified field in a fragment.

Specified by:

setMandatory in interface IResourceController

Parameters:

fragmentName - the system name of the fragment

propertyName - the system name of the field.

mandatory - true or false.