OAUIController (com.viaoa:oa-core 3.7.12 API)

java.lang.Object
- com.viaoa.hub.HubListenerAdapter
- - com.viaoa.uicontroller.OAUIController

All Implemented Interfaces:

HubListener, EventListener

Direct Known Subclasses:

OAUICommandController, OAUITypeAheadController
```
public abstract class OAUIController
extends HubListenerAdapter
```
Base controller class for OA UI components. Implements the HubListeners and provides most of the methods required for creating controller Classes (Model/View/Controller) for UI components.

See Also:

abstract method of update UI component., abstract method of update label.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class OAUIController.MyHubChangeListener
- Nested classes/interfaces inherited from interface com.viaoa.hub.HubListener
  HubListener.InsertLocation

Nested Classes
Modifier and Type	Class and Description
`protected class`	`OAUIController.MyHubChangeListener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`backgroundColorPropertyPath`
`protected boolean`	`bAoOnly`
`protected boolean`	`bEnableUndo`
`protected boolean`	`bHtml`
`protected boolean`	`bIgnoreUpdate`
`protected boolean`	`bIsHubCalc`
`protected boolean`	`bListenToHubSize`
`protected boolean`	`bRequired`
`protected boolean`	`bUseObjectCallback`
`protected OAUIController.MyHubChangeListener`	`changeListener`
`protected OAUIController.MyHubChangeListener`	`changeListenerEnabled`
`protected OAUIController.MyHubChangeListener`	`changeListenerVisible`
`protected char`	`conversion` 'U'ppercase, 'L'owercase, 'T'itle, 'J'ava identifier 'E'ncrpted password/encrypt 'S'HA password
`boolean`	`DEBUG`
`static boolean`	`DEBUGUI`
`protected String`	`displayTemplate` HTML used for displaying in some components (label, combo, list, autocomplete), and used for table cell rendering
`protected Class`	`endPropertyClass`
`protected Class`	`endPropertyFromClass`
`protected String`	`endPropertyName`
`protected String`	`fontPropertyPath`
`protected String`	`foregroundColorPropertyPath`
`protected String`	`format`
`protected Hub`	`hub`
`protected HubChangeListener.Type`	`hubChangeListenerType`
`protected String`	`hubListenerPropertyName`
`protected Object`	`hubObject`
`protected Hub`	`hubSelect`
`protected Hub`	`hubTemp`
`protected String`	`iconColorPropertyPath`
`protected String`	`imageClassPath`
`protected String`	`imageDirectory`
`protected String`	`imagePropertyPath`
`protected int`	`maxImageHeight`
`protected int`	`maxImageWidth`
`protected String`	`nullDescription`
`protected OAPropertyPath`	`oaPropertyPath`
`protected String`	`propertyPath`
`protected Class`	`rootImageClassPath`
`protected OATemplate`	`templateDisplay`
`protected OATemplate`	`templateToolTipText`
`protected String`	`toolTipTextPropertyPath`
`protected String`	`toolTipTextTemplate`
`protected String`	`undoDescription`

Constructor Summary

Constructors
Constructor and Description
`OAUIController(Hub hub, Object object, String propertyPath, boolean bAoOnly, HubChangeListener.Type type)` Create new controller for Hub and Jfc component
`OAUIController(Hub hub, String propertyPath)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_afterPropertyChange(HubEvent e)`
`protected void`	`_reset()`
`protected void`	`_update()`
`HubChangeListener.HubProp`	`addEnabledCheck(Hub hub, HubChangeListener.Type type)`
`HubChangeListener.HubProp`	`addEnabledCheck(Hub hub, String pp)`
`HubChangeListener.HubProp`	`addEnabledCheck(Hub hub, String property, HubChangeListener.Type type)`
`HubChangeListener.HubProp`	`addEnabledCheck(Hub hub, String pp, Object value)`
`HubChangeListener.HubProp`	`addEnabledEditQueryCheck(Hub hub, String propertyName)`
`HubChangeListener.HubProp`	`addEnabledObjectCallbackCheck(Hub hub, String propertyName)`
`HubChangeListener.HubProp`	`addVisibleCheck(Hub hub, String pp)`
`HubChangeListener.HubProp`	`addVisibleCheck(Hub hub, String property, HubChangeListener.Type type)`
`HubChangeListener.HubProp`	`addVisibleCheck(Hub hub, String pp, Object value)`
`HubChangeListener.HubProp`	`addVisibleEditQueryCheck(Hub hub, String propertyName)`
`HubChangeListener.HubProp`	`addVisibleObjectCallbackCheck(Hub hub, String propertyName)`
`void`	`afterAdd(HubEvent e)` Event sent after object is added to Hub, before cache size is checked and before property to master is set.
`protected void`	`afterChangeActiveObject()`
`void`	`afterChangeActiveObject(HubEvent e)` Event sent after ActiveObject has been set.
`void`	`afterInsert(HubEvent e)`
`void`	`afterNewList(HubEvent e)` Called after onNewList is called
`protected void`	`afterPropertyChange()`
`void`	`afterPropertyChange(HubEvent e)`
`void`	`afterRemove(HubEvent e)` Event sent after an object is removed from a Hub.
`void`	`afterRemoveAll(HubEvent e)` Sent after all objects are removed/cleared from the Hub.
`void`	`beforePropertyChange(HubEvent e)` Event sent whenever a property is changed.
`void`	`bind(Hub hub, String propertyPath)`
`protected void`	`callUpdate()` Called to have component update itself.
`void`	`close()`
`protected boolean`	`confirmPropertyChange(Object obj, Object newValue)` confirm a new change.
`void`	`enableVisibleListener(boolean b)` Called to add or remove a UI specific listener (ex: inactive/hidden tab) that is used to know if the component is visible to the user.
`protected void`	`finalize()`
`boolean`	`getAllowRemovingFromSelectHub()`
`String`	`getBackgroundColorPropertyPath()`
`HubChangeListener`	`getChangeListener()` Used to listen to additional changes that will then call this.update()
`String`	`getCompletedMessage()`
`String`	`getConfirmMessage()` Popup message used to confirm button click before running code.
`char`	`getConversion()`
`Object`	`getConvertedValue(Object value, String fmt)` Converts a value to correct type needed for setMethod
`String`	`getDescription()`
`String`	`getDisplayTemplate()`
`String`	`getDisplayText(Object obj, String defaultText)` Used to display values, uses display template if defined.
`HubChangeListener`	`getEnabledChangeListener()`
`String`	`getEnabledMessage()`
`boolean`	`getEnableUndo()`
`Class`	`getEndPropertyClass()`
`Class`	`getEndPropertyFromClass()`
`String`	`getEndPropertyName()`
`String`	`getFontProperty()`
`String`	`getForegroundColorPropertyPath()`
`String`	`getFormat()` Returns format to use for displaying value as a String.
`boolean`	`getHtml()`
`Hub`	`getHub()`
`String`	`getHubListenerPropertyName()`
`String`	`getIconColorPropertyPath()`
`String`	`getImageDirectory()` Root directory path where images are stored.
`String`	`getImagePropertyPath()`
`static String`	`getMaskPasswordValue()`
`int`	`getMaxDisplay()`
`int`	`getMaxImageHeight()`
`int`	`getMaxImageWidth()`
`int`	`getMinDisplay()`
`Hub`	`getMultiSelectHub()`
`String`	`getNullDescription()` The "word(s)" to use for the empty slot (null value).
`Object`	`getObject()`
`String`	`getPropertyPath()`
`protected Object`	`getRealObject(Object fromObject)`
`Hub`	`getSelectHub()` Returns the Hub that this component will work with.
`OATemplate`	`getTemplateForDisplay()`
`OATemplate`	`getTemplateForToolTipText()`
`String`	`getTitle()`
`String`	`getToolTipText(Object obj, String ttDefault)`
`String`	`getToolTipTextPropertyPath()`
`String`	`getToolTipTextTemplate()`
`String`	`getUndoDescription()` Description to use for Undo and Redo presentation names.
`Object`	`getValue(Object obj)`
`String`	`getValueAsString(Object obj)`
`String`	`getValueAsString(Object obj, String fmt)`
`String`	`getValueAsString(Object obj, String fmt, int maxLength)`
`HubChangeListener`	`getVisibleChangeListener()`
`String`	`getVisibleMessage()`
`boolean`	`isEnabled()`
`protected boolean`	`isListeningTo(Hub hub, Object object, String prop)`
`boolean`	`isParentEnabled()` Utility used to "see" if this component or any of its parent containers are disabled.
`boolean`	`isRequired()`
`String`	`isValid(Object obj, Object newValue)` Used to verify a property change.
`boolean`	`isVisible()`
`boolean`	`isVisibleListenerEnabled()`
`boolean`	`isVisibleOnScreen()`
`protected boolean`	`onConfirmPropertyChangeShowOptionDialog(String confirmMessage, String confirmTitle)`
`void`	`onNewList(HubEvent e)` Event sent when a new list of objects is available for a Hub.
`protected void`	`onVisibleListenerChange()` Used when enabledVisibleListener(true) is set up.
`protected void`	`reset()` Called when changes are made that affects the setup for component.
`void`	`setBackgroundColorPropertyPath(String pp)`
`void`	`setCompletedMessage(String msg)`
`void`	`setConfirmMessage(String msg)` Popup message used to confirm button click before running code.
`void`	`setConversion(char conv)` 'U'ppercase, 'L'owercase, 'T'itle, 'J'ava identifier 'E'ncrpted password/encrypt 'S'HA password (one way hash)
`void`	`setDescription(String description)`
`void`	`setDisplayTemplate(String s)`
`void`	`setEnableUndo(boolean b)` Flag to enable undo, default is true.
`void`	`setFontPropertyPath(String pp)`
`void`	`setForegroundColorPropertyPath(String pp)`
`void`	`setFormat(String fmt)` Format used to display this property.
`void`	`setHtml(boolean b)`
`void`	`setHub(Hub hub)`
`void`	`setIconColorPropertyPath(String pp)`
`void`	`setImageClassPath(Class root, String path)` Class path where images are stored.
`void`	`setImageDirectory(String s)` Root directory path where images are stored.
`void`	`setImagePropertyPath(String pp)`
`void`	`setMaxDisplay(int x)` max number of characters to display (number of characters).
`void`	`setMaxImageHeight(int maxImageHeight)`
`void`	`setMaxImageWidth(int maxImageWidth)`
`void`	`setMaxLength(int x)` max input length for input (number of characters).
`void`	`setMinDisplay(int x)` minimum number of characters to display (number of characters).
`void`	`setMultiSelectHub(Hub newHub)`
`void`	`setNullDescription(String s)`
`void`	`setPropertyPath(String propPath)`
`void`	`setReadOnly(boolean b)`
`void`	`setSelectHub(Hub newHub)`
`void`	`setSelectHub(Hub newHub, boolean bAllowRemovingFromSelectHub)` Sets the MultiSelect that this component will work with.
`void`	`setTitle(String title)`
`void`	`setToolTipTextPropertyPath(String pp)`
`void`	`setToolTipTextTemplate(String s)`
`void`	`setUndoDescription(String s)` Description to use for Undo and Redo presentation names.
`void`	`setValue(Object value)`
`void`	`setValue(Object obj, Object value)`
`void`	`setValue(Object obj, Object newValue, String fmt)`
`void`	`setValueDirectly(Object obj, Object newValue)`
`void`	`setViewOnly(boolean b)`
`abstract void`	`updateComponent(Object object)` Called when a change is necessary for UI component.
`abstract void`	`updateLabel(Object object)`

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

Field Detail

DEBUG
```
public boolean DEBUG
```

DEBUGUI
```
public static boolean DEBUGUI
```

hub
```
protected Hub hub
```

bAoOnly
```
protected final boolean bAoOnly
```

propertyPath
```
protected String propertyPath
```

oaPropertyPath

protected OAPropertyPath oaPropertyPath

endPropertyFromClass
```
protected Class endPropertyFromClass
```

endPropertyName
```
protected String endPropertyName
```

endPropertyClass
```
protected Class endPropertyClass
```

hubListenerPropertyName

protected String hubListenerPropertyName

hubObject
```
protected Object hubObject
```

hubTemp
```
protected Hub hubTemp
```

bUseObjectCallback
```
protected final boolean bUseObjectCallback
```
See Also:

Constant Field Values

hubChangeListenerType

protected HubChangeListener.Type hubChangeListenerType

bIsHubCalc
```
protected boolean bIsHubCalc
```

bListenToHubSize
```
protected boolean bListenToHubSize
```

bEnableUndo
```
protected boolean bEnableUndo
```

undoDescription
```
protected String undoDescription
```

hubSelect
```
protected Hub hubSelect
```

format
```
protected String format
```

fontPropertyPath
```
protected String fontPropertyPath
```

backgroundColorPropertyPath

protected String backgroundColorPropertyPath

foregroundColorPropertyPath

protected String foregroundColorPropertyPath

iconColorPropertyPath
```
protected String iconColorPropertyPath
```

maxImageHeight
```
protected int maxImageHeight
```

maxImageWidth
```
protected int maxImageWidth
```

imageDirectory
```
protected String imageDirectory
```

imageClassPath
```
protected String imageClassPath
```

rootImageClassPath
```
protected Class rootImageClassPath
```

imagePropertyPath
```
protected String imagePropertyPath
```

toolTipTextPropertyPath

protected String toolTipTextPropertyPath

nullDescription
```
protected String nullDescription
```

bHtml
```
protected boolean bHtml
```

changeListener

protected OAUIController.MyHubChangeListener changeListener

changeListenerEnabled

protected OAUIController.MyHubChangeListener changeListenerEnabled

changeListenerVisible

protected OAUIController.MyHubChangeListener changeListenerVisible

displayTemplate
```
protected String displayTemplate
```
HTML used for displaying in some components (label, combo, list, autocomplete), and used for table cell rendering

templateDisplay
```
protected OATemplate templateDisplay
```

toolTipTextTemplate
```
protected String toolTipTextTemplate
```

templateToolTipText

protected OATemplate templateToolTipText

bRequired
```
protected boolean bRequired
```

conversion
```
protected char conversion
```
'U'ppercase, 'L'owercase, 'T'itle, 'J'ava identifier 'E'ncrpted password/encrypt 'S'HA password

bIgnoreUpdate

protected volatile boolean bIgnoreUpdate

Constructor Detail

OAUIController

public OAUIController(Hub hub,
                      String propertyPath)

OAUIController
```
public OAUIController(Hub hub,
                      Object object,
                      String propertyPath,
                      boolean bAoOnly,
                      HubChangeListener.Type type)
```
Create new controller for Hub and Jfc component

Parameters:

hub -

object - if hub is null, then this object will be put in temp hub and made the AO

propertyPath - property used by component

bAoOnly - should controller listen to propChange for all objects in hub, or just AO.

type - default type of change listener

Method Detail

reset
```
protected void reset()
```
Called when changes are made that affects the setup for component.

_reset
```
protected void _reset()
```

bind

public void bind(Hub hub,
                 String propertyPath)

getHub
```
public Hub getHub()
```

setHub
```
public void setHub(Hub hub)
```

getObject
```
public Object getObject()
```

getPropertyPath
```
public String getPropertyPath()
```

setPropertyPath

public void setPropertyPath(String propPath)

getEndPropertyName
```
public String getEndPropertyName()
```

getEndPropertyClass
```
public Class getEndPropertyClass()
```

getEndPropertyFromClass

public Class getEndPropertyFromClass()

getHubListenerPropertyName

public String getHubListenerPropertyName()

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

close
```
public void close()
```

enableVisibleListener
```
public void enableVisibleListener(boolean b)
```
Called to add or remove a UI specific listener (ex: inactive/hidden tab) that is used to know if the component is visible to the user.

getSelectHub
```
public Hub getSelectHub()
```
Returns the Hub that this component will work with.

getMultiSelectHub
```
public Hub getMultiSelectHub()
```

getAllowRemovingFromSelectHub

public boolean getAllowRemovingFromSelectHub()

setSelectHub

public void setSelectHub(Hub newHub,
                         boolean bAllowRemovingFromSelectHub)

Sets the MultiSelect that this component will work with.

setSelectHub
```
public void setSelectHub(Hub newHub)
```

setMultiSelectHub

public void setMultiSelectHub(Hub newHub)

getRealObject

protected Object getRealObject(Object fromObject)

getValue
```
public Object getValue(Object obj)
```

getValueAsString

public String getValueAsString(Object obj)

getValueAsString

public String getValueAsString(Object obj,
                               String fmt)

getValueAsString

public String getValueAsString(Object obj,
                               String fmt,
                               int maxLength)

setValue
```
public void setValue(Object value)
```

setValue

public void setValue(Object obj,
                     Object value)

setValue

public void setValue(Object obj,
                     Object newValue,
                     String fmt)

setValueDirectly

public void setValueDirectly(Object obj,
                             Object newValue)

setEnableUndo
```
public void setEnableUndo(boolean b)
```
Flag to enable undo, default is true.

getEnableUndo
```
public boolean getEnableUndo()
```

setConfirmMessage
```
public void setConfirmMessage(String msg)
```
Popup message used to confirm button click before running code.

getConfirmMessage
```
public String getConfirmMessage()
```
Popup message used to confirm button click before running code.

beforePropertyChange
```
public void beforePropertyChange(HubEvent e)
```
Description copied from interface: HubListener

Event sent whenever a property is changed. This includes OAObject or Hub properties.
OAObject: any object property, changed, editable, new
Hub: allowDelete, allowNew, allowEdit, eof, bof

Note: propertyChanges are sent for any changed object, not just the ActiveObject

Specified by:

beforePropertyChange in interface HubListener

Overrides:

beforePropertyChange in class HubListenerAdapter

confirmPropertyChange

protected boolean confirmPropertyChange(Object obj,
                                        Object newValue)

confirm a new change.

onConfirmPropertyChangeShowOptionDialog

protected boolean onConfirmPropertyChangeShowOptionDialog(String confirmMessage,
                                                          String confirmTitle)

getConvertedValue

public Object getConvertedValue(Object value,
                                String fmt)

Converts a value to correct type needed for setMethod

setViewOnly
```
public void setViewOnly(boolean b)
```

setReadOnly
```
public void setReadOnly(boolean b)
```

isValid

public String isValid(Object obj,
                      Object newValue)

Used to verify a property change.

Returns:: null if no errors, else error message

getFormat
```
public String getFormat()
```
Returns format to use for displaying value as a String.

See Also:

see OAConverterNumber#OAConverterNumber

setFormat
```
public void setFormat(String fmt)
```
Format used to display this property. Used to format Date, Times and Numbers. set to "" (blank) for no formatting. If null, then the default format will be used.

See Also:

see OAConverterNumber#OAConverterNumber

isParentEnabled
```
public boolean isParentEnabled()
```
Utility used to "see" if this component or any of its parent containers are disabled.

setFontPropertyPath

public void setFontPropertyPath(String pp)

getFontProperty
```
public String getFontProperty()
```

setForegroundColorPropertyPath

public void setForegroundColorPropertyPath(String pp)

getForegroundColorPropertyPath

public String getForegroundColorPropertyPath()

setBackgroundColorPropertyPath

public void setBackgroundColorPropertyPath(String pp)

getBackgroundColorPropertyPath

public String getBackgroundColorPropertyPath()

setIconColorPropertyPath

public void setIconColorPropertyPath(String pp)

getIconColorPropertyPath

public String getIconColorPropertyPath()

setToolTipTextPropertyPath

public void setToolTipTextPropertyPath(String pp)

getToolTipTextPropertyPath

public String getToolTipTextPropertyPath()

setImageDirectory
```
public void setImageDirectory(String s)
```
Root directory path where images are stored.

getImageDirectory
```
public String getImageDirectory()
```
Root directory path where images are stored.

setImageClassPath

public void setImageClassPath(Class root,
                              String path)

Class path where images are stored.

setImagePropertyPath

public void setImagePropertyPath(String pp)

getImagePropertyPath
```
public String getImagePropertyPath()
```

getNullDescription
```
public String getNullDescription()
```
The "word(s)" to use for the empty slot (null value). Example: "none of the above". Default: "" (blank). Set to null if none should be used

setNullDescription

public void setNullDescription(String s)

getChangeListener
```
public HubChangeListener getChangeListener()
```
Used to listen to additional changes that will then call this.update()

getEnabledChangeListener

public HubChangeListener getEnabledChangeListener()

getVisibleChangeListener

public HubChangeListener getVisibleChangeListener()

addEnabledCheck

public HubChangeListener.HubProp addEnabledCheck(Hub hub,
                                                 String pp)

addEnabledCheck

public HubChangeListener.HubProp addEnabledCheck(Hub hub,
                                                 String pp,
                                                 Object value)

addEnabledCheck

public HubChangeListener.HubProp addEnabledCheck(Hub hub,
                                                 String property,
                                                 HubChangeListener.Type type)

addEnabledCheck

public HubChangeListener.HubProp addEnabledCheck(Hub hub,
                                                 HubChangeListener.Type type)

addEnabledEditQueryCheck

public HubChangeListener.HubProp addEnabledEditQueryCheck(Hub hub,
                                                          String propertyName)

addEnabledObjectCallbackCheck

public HubChangeListener.HubProp addEnabledObjectCallbackCheck(Hub hub,
                                                               String propertyName)

addVisibleCheck

public HubChangeListener.HubProp addVisibleCheck(Hub hub,
                                                 String pp)

addVisibleCheck

public HubChangeListener.HubProp addVisibleCheck(Hub hub,
                                                 String pp,
                                                 Object value)

addVisibleCheck

public HubChangeListener.HubProp addVisibleCheck(Hub hub,
                                                 String property,
                                                 HubChangeListener.Type type)

addVisibleEditQueryCheck

public HubChangeListener.HubProp addVisibleEditQueryCheck(Hub hub,
                                                          String propertyName)

addVisibleObjectCallbackCheck

public HubChangeListener.HubProp addVisibleObjectCallbackCheck(Hub hub,
                                                               String propertyName)

callUpdate
```
protected void callUpdate()
```
Called to have component update itself. This will call updateComponent and updateLabel

_update
```
protected void _update()
```

isVisible
```
public boolean isVisible()
```

isEnabled
```
public boolean isEnabled()
```

getEnabledMessage
```
public String getEnabledMessage()
```

getVisibleMessage
```
public String getVisibleMessage()
```

setMinDisplay
```
public void setMinDisplay(int x)
```
minimum number of characters to display (number of characters).

getMinDisplay
```
public int getMinDisplay()
```

setMaxDisplay
```
public void setMaxDisplay(int x)
```
max number of characters to display (number of characters).

getMaxDisplay
```
public int getMaxDisplay()
```

setMaxLength
```
public void setMaxLength(int x)
```
max input length for input (number of characters).

getMaxImageHeight
```
public int getMaxImageHeight()
```

setMaxImageHeight

public void setMaxImageHeight(int maxImageHeight)

getMaxImageWidth
```
public int getMaxImageWidth()
```

setMaxImageWidth

public void setMaxImageWidth(int maxImageWidth)

setHtml
```
public void setHtml(boolean b)
```

getHtml
```
public boolean getHtml()
```

setUndoDescription
```
public void setUndoDescription(String s)
```
Description to use for Undo and Redo presentation names.

See Also:

OAUndoableEdit.setPresentationName(java.lang.String)

getUndoDescription
```
public String getUndoDescription()
```
Description to use for Undo and Redo presentation names.

See Also:

OAUndoableEdit.setPresentationName(java.lang.String)

afterAdd
```
public void afterAdd(HubEvent e)
```
Description copied from interface: HubListener

Event sent after object is added to Hub, before cache size is checked and before property to master is set.

Specified by:

afterAdd in interface HubListener

Overrides:

afterAdd in class HubListenerAdapter

See Also:

Hub.add

afterRemove
```
public void afterRemove(HubEvent e)
```
Description copied from interface: HubListener

Event sent after an object is removed from a Hub.

Specified by:

afterRemove in interface HubListener

Overrides:

afterRemove in class HubListenerAdapter

afterRemoveAll
```
public void afterRemoveAll(HubEvent e)
```
Description copied from interface: HubListener

Sent after all objects are removed/cleared from the Hub.

Specified by:

afterRemoveAll in interface HubListener

Overrides:

afterRemoveAll in class HubListenerAdapter

onNewList
```
public void onNewList(HubEvent e)
```
Description copied from interface: HubListener

Event sent when a new list of objects is available for a Hub.

Specified by:

onNewList in interface HubListener

Overrides:

onNewList in class HubListenerAdapter

afterInsert
```
public void afterInsert(HubEvent e)
```
Specified by:

afterInsert in interface HubListener

Overrides:

afterInsert in class HubListenerAdapter

afterChangeActiveObject
```
public void afterChangeActiveObject(HubEvent e)
```
Description copied from interface: HubListener

Event sent after ActiveObject has been set.

Specified by:

afterChangeActiveObject in interface HubListener

Overrides:

afterChangeActiveObject in class HubListenerAdapter

afterNewList
```
public void afterNewList(HubEvent e)
```
Description copied from interface: HubListener

Called after onNewList is called

Specified by:

afterNewList in interface HubListener

Overrides:

afterNewList in class HubListenerAdapter

afterPropertyChange
```
public void afterPropertyChange(HubEvent e)
```
Specified by:

afterPropertyChange in interface HubListener

Overrides:

afterPropertyChange in class HubListenerAdapter

_afterPropertyChange

protected void _afterPropertyChange(HubEvent e)

afterPropertyChange
```
protected void afterPropertyChange()
```

afterChangeActiveObject

protected void afterChangeActiveObject()

setDisplayTemplate

public void setDisplayTemplate(String s)

getDisplayTemplate
```
public String getDisplayTemplate()
```

getTemplateForDisplay

public OATemplate getTemplateForDisplay()

getDisplayText

public String getDisplayText(Object obj,
                             String defaultText)

Used to display values, uses display template if defined.

setToolTipTextTemplate

public void setToolTipTextTemplate(String s)

getToolTipTextTemplate

public String getToolTipTextTemplate()

getTemplateForToolTipText

public OATemplate getTemplateForToolTipText()

getToolTipText

public String getToolTipText(Object obj,
                             String ttDefault)

onVisibleListenerChange
```
protected void onVisibleListenerChange()
```
Used when enabledVisibleListener(true) is set up. Will be called when component is in a visible window/tab. default is to call update().

isListeningTo

protected boolean isListeningTo(Hub hub,
                                Object object,
                                String prop)

isRequired
```
public boolean isRequired()
```

getMaskPasswordValue

public static String getMaskPasswordValue()

setConversion
```
public void setConversion(char conv)
```
'U'ppercase, 'L'owercase, 'T'itle, 'J'ava identifier 'E'ncrpted password/encrypt 'S'HA password (one way hash)

getConversion
```
public char getConversion()
```

isVisibleListenerEnabled

public boolean isVisibleListenerEnabled()

isVisibleOnScreen
```
public boolean isVisibleOnScreen()
```

setTitle
```
public void setTitle(String title)
```

getTitle
```
public String getTitle()
```

setDescription

public void setDescription(String description)

getDescription
```
public String getDescription()
```
Overrides:

getDescription in class HubListenerAdapter

setCompletedMessage

public void setCompletedMessage(String msg)

getCompletedMessage
```
public String getCompletedMessage()
```

updateComponent
```
public abstract void updateComponent(Object object)
```
Called when a change is necessary for UI component.

updateLabel

public abstract void updateLabel(Object object)

Class OAUIController

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.viaoa.hub.HubListenerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface com.viaoa.hub.HubListener

Field Detail

DEBUG

DEBUGUI

hub

bAoOnly

propertyPath

oaPropertyPath

endPropertyFromClass

endPropertyName

endPropertyClass

hubListenerPropertyName

hubObject

hubTemp

bUseObjectCallback

hubChangeListenerType

bIsHubCalc

bListenToHubSize

bEnableUndo

undoDescription

hubSelect

format

fontPropertyPath

backgroundColorPropertyPath

foregroundColorPropertyPath

iconColorPropertyPath

maxImageHeight

maxImageWidth

imageDirectory

imageClassPath

rootImageClassPath

imagePropertyPath

toolTipTextPropertyPath

nullDescription

bHtml

changeListener

changeListenerEnabled

changeListenerVisible

displayTemplate

templateDisplay

toolTipTextTemplate

templateToolTipText

bRequired

conversion

bIgnoreUpdate

Constructor Detail

OAUIController

OAUIController

Method Detail

reset

_reset

bind

getHub

setHub

getObject

getPropertyPath

setPropertyPath

getEndPropertyName

getEndPropertyClass

getEndPropertyFromClass

getHubListenerPropertyName

finalize

close

enableVisibleListener

getSelectHub

getMultiSelectHub

getAllowRemovingFromSelectHub

setSelectHub

setSelectHub

setMultiSelectHub

getRealObject

getValue