com.viaoa.uicontroller

Class OAUICommandController

java.lang.Object

com.viaoa.hub.HubListenerAdapter

com.viaoa.uicontroller.OAUIController

com.viaoa.uicontroller.OAUICommandController

All Implemented Interfaces:

HubListener, EventListener

public class OAUICommandController
extends OAUIController

Controller used to have UI components commands interact with Hub and OAObjects.

Author:

vince

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAUICommandController.Command

Nested classes/interfaces inherited from class com.viaoa.uicontroller.OAUIController

OAUIController.MyHubChangeListener

Nested classes/interfaces inherited from interface com.viaoa.hub.HubListener

HubListener.InsertLocation

Field Summary

Fields inherited from class com.viaoa.uicontroller.OAUIController

backgroundColorPropertyPath, bAoOnly, bEnableUndo, bHtml, bIgnoreUpdate, bIsHubCalc, bListenToHubSize, bRequired, bUseObjectCallback, changeListener, changeListenerEnabled, changeListenerVisible, conversion, DEBUG, DEBUGUI, displayTemplate, endPropertyClass, endPropertyFromClass, endPropertyName, fontPropertyPath, foregroundColorPropertyPath, format, hub, hubChangeListenerType, hubListenerPropertyName, hubObject, hubSelect, hubTemp, iconColorPropertyPath, imageClassPath, imageDirectory, imagePropertyPath, maxImageHeight, maxImageWidth, nullDescription, oaPropertyPath, propertyPath, rootImageClassPath, templateDisplay, templateToolTipText, toolTipTextPropertyPath, toolTipTextTemplate, undoDescription

Constructor Summary

Constructors

Constructor and Description
OAUICommandController(Hub hub, OAUICommandController.Command command)

Method Summary

Modifier and Type	Method and Description
OAUICommandController.Command	getCommand()
protected Object	getManualObject() For commands that will be manually assigning an object.
boolean	isEnabled()
boolean	isEnabled(Hub hub, OAObject obj)
boolean	onCommand()
protected void	onCompleted(String completedMessage, String title)
protected boolean	onConfirm(String confirmMessage, String title) These allow for overwriting to handle user interactions.
protected void	onError(String errorMessage, String detailMessage)
protected boolean	performCommand(Hub hub, OAObject obj) This is called to perform the actual command, after calling onConfirm, and before calling onCompleted.
void	setUpdateObject(String property, Object newValue)
void	updateComponent(Object object) Called when a change is necessary for UI component.
void	updateLabel(Object object)

Methods inherited from class com.viaoa.uicontroller.OAUIController

_afterPropertyChange, _reset, _update, addEnabledCheck, addEnabledCheck, addEnabledCheck, addEnabledCheck, addEnabledEditQueryCheck, addEnabledObjectCallbackCheck, addVisibleCheck, addVisibleCheck, addVisibleCheck, addVisibleEditQueryCheck, addVisibleObjectCallbackCheck, afterAdd, afterChangeActiveObject, afterChangeActiveObject, afterInsert, afterNewList, afterPropertyChange, afterPropertyChange, afterRemove, afterRemoveAll, beforePropertyChange, bind, callUpdate, close, confirmPropertyChange, enableVisibleListener, finalize, getAllowRemovingFromSelectHub, getBackgroundColorPropertyPath, getChangeListener, getCompletedMessage, getConfirmMessage, getConversion, getConvertedValue, getDescription, getDisplayTemplate, getDisplayText, getEnabledChangeListener, getEnabledMessage, getEnableUndo, getEndPropertyClass, getEndPropertyFromClass, getEndPropertyName, getFontProperty, getForegroundColorPropertyPath, getFormat, getHtml, getHub, getHubListenerPropertyName, getIconColorPropertyPath, getImageDirectory, getImagePropertyPath, getMaskPasswordValue, getMaxDisplay, getMaxImageHeight, getMaxImageWidth, getMinDisplay, getMultiSelectHub, getNullDescription, getObject, getPropertyPath, getRealObject, getSelectHub, getTemplateForDisplay, getTemplateForToolTipText, getTitle, getToolTipText, getToolTipTextPropertyPath, getToolTipTextTemplate, getUndoDescription, getValue, getValueAsString, getValueAsString, getValueAsString, getVisibleChangeListener, getVisibleMessage, isListeningTo, isParentEnabled, isRequired, isValid, isVisible, isVisibleListenerEnabled, isVisibleOnScreen, onConfirmPropertyChangeShowOptionDialog, onNewList, onVisibleListenerChange, reset, setBackgroundColorPropertyPath, setCompletedMessage, setConfirmMessage, setConversion, setDescription, setDisplayTemplate, setEnableUndo, setFontPropertyPath, setForegroundColorPropertyPath, setFormat, setHtml, setHub, setIconColorPropertyPath, setImageClassPath, setImageDirectory, setImagePropertyPath, setMaxDisplay, setMaxImageHeight, setMaxImageWidth, setMaxLength, setMinDisplay, setMultiSelectHub, setNullDescription, setPropertyPath, setReadOnly, setSelectHub, setSelectHub, setTitle, setToolTipTextPropertyPath, setToolTipTextTemplate, setUndoDescription, setValue, setValue, setValue, setValueDirectly, setViewOnly

Methods inherited from class com.viaoa.hub.HubListenerAdapter

afterDelete, afterLoad, afterMove, afterSave, afterSort, beforeAdd, beforeDelete, beforeInsert, beforeMove, beforeRefresh, beforeRemove, beforeRemoveAll, beforeSave, beforeSelect, getListener, getLocation, getName, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.viaoa.hub.HubListener

getAllowAdd, getAllowDelete, getAllowEnabled, getAllowRemove, getAllowRemoveAll, getAllowVisible, isValidAdd, isValidDelete, isValidPropertyChange, isValidRemove, isValidRemoveAll

Constructor Detail

OAUICommandController

public OAUICommandController(Hub hub,
                             OAUICommandController.Command command)

Method Detail

getCommand

public OAUICommandController.Command getCommand()

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class OAUIController

isEnabled

public boolean isEnabled(Hub hub,
                         OAObject obj)

onCommand

public boolean onCommand()

performCommand

protected boolean performCommand(Hub hub,
                                 OAObject obj)

This is called to perform the actual command, after calling onConfirm, and before calling onCompleted.

This should be overwritten for Commands: OtherUsesHub, OtherUsesAO

Call onError if needed.

Returns:

true if command was performed, false otherwise.

onConfirm

protected boolean onConfirm(String confirmMessage,
                            String title)

These allow for overwriting to handle user interactions.

onError

protected void onError(String errorMessage,
                       String detailMessage)

onCompleted

protected void onCompleted(String completedMessage,
                           String title)

getManualObject

protected Object getManualObject()

For commands that will be manually assigning an object.
For Commands NewManual, AddManual, and ManualChangeAO

This should be overwritten to supply the object to use.

updateComponent

public void updateComponent(Object object)

Description copied from class: OAUIController

Called when a change is necessary for UI component.

Specified by:

updateComponent in class OAUIController

updateLabel

public void updateLabel(Object object)

Specified by:

updateLabel in class OAUIController

setUpdateObject

public void setUpdateObject(String property,
                            Object newValue)