javax.rad.application
Interface IWorkScreen

All Superinterfaces:

IComponent, IContent, IMessageConstants, INamedObject, IResource

All Known Implementing Classes:

RemoteWorkScreen, WorkScreen

public interface IWorkScreen
extends IContent, IMessageConstants

Platform and technology independent work screen definition. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

Fields inherited from interface javax.rad.application.IMessageConstants

MESSAGE_BUTTON_OK, MESSAGE_BUTTON_OK_CANCEL, MESSAGE_BUTTON_YES_NO, MESSAGE_BUTTON_YES_NO_CANCEL, MESSAGE_ICON_ERROR, MESSAGE_ICON_INFO, MESSAGE_ICON_QUESTION, MESSAGE_ICON_WARNING

Method Summary

IWorkScreenApplication	getApplication() Gets the main application of this work-screen.
java.lang.Object	getParameter(java.lang.String pName) Gets the value of an additional parameter from the work-screen.
boolean	isModal() Returns the modal state of this workscreen.
boolean	isParameterSet(java.lang.String pName) Gets whether the given parameter is set.
void	notifyActivate() Notifies the IWorkScreen, that it will be "visible again".
void	reload() Reloads the workscreen and discard changes.
java.lang.Object	removeParameter(java.lang.String pName) Removes the parameter from the parameter list.
void	save() Saves the workscreen changes.
void	setModal(boolean pModal) Sets whether this workscreen should be modal.
java.lang.Object	setParameter(java.lang.String pName, java.lang.Object pValue) Sets additional parameters for the work-screen.

Methods inherited from interface javax.rad.application.IContent

getOpener, isDestroyed, notifyDestroy, notifyVisible, setOpener

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Method Detail

notifyActivate

void notifyActivate()

Notifies the IWorkScreen, that it will be "visible again".

getApplication

IWorkScreenApplication getApplication()

Gets the main application of this work-screen.

Returns:

the main application base

save

void save()
          throws java.lang.Throwable

Saves the workscreen changes.

Throws:

java.lang.Throwable - if the save process failed

reload

void reload()
            throws java.lang.Throwable

Reloads the workscreen and discard changes.

Throws:

java.lang.Throwable - if the save process failed

isModal

boolean isModal()

Returns the modal state of this workscreen.

Returns:

true if this workscreen should be modal, otherwise false

setModal

void setModal(boolean pModal)

Sets whether this workscreen should be modal.

Parameters:

pModal - true if this workscreen should be modal, otherwise false

setParameter

java.lang.Object setParameter(java.lang.String pName,
                              java.lang.Object pValue)

Sets additional parameters for the work-screen. This method should be used for additional configuration steps.

Parameters:

pName - the parameter name

pValue - the parameter

Returns:

the previous value for the parameter name or null if the parameter was not set before

getParameter

java.lang.Object getParameter(java.lang.String pName)

Gets the value of an additional parameter from the work-screen.

Parameters:

pName - the parameter name

Returns:

the parameter

isParameterSet

boolean isParameterSet(java.lang.String pName)

Gets whether the given parameter is set.

Parameters:

pName - the parameter name

Returns:

true if the parameter is set, false otherwise

removeParameter

java.lang.Object removeParameter(java.lang.String pName)

Removes the parameter from the parameter list.

Parameters:

pName - the parameter name

Returns:

the old object