public class BoundComponentInstance extends DynamicAttributeComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_NAME |
static java.lang.String |
BAD_BINDING_CSS |
boolean |
bound |
static java.lang.String |
BOUND_LABEL |
static java.lang.String |
COLUMN_NAME |
static java.lang.String |
CSS_CLASS |
static java.lang.String |
DATA_ATTRIBUTE |
static java.lang.String |
DEFAULT_LABEL |
static java.lang.String |
DOMAIN |
static java.lang.String |
ENTITY_NAME |
static java.lang.String |
EVENT_PRIORITY |
static java.lang.String |
FIELD_LABEL |
static java.lang.String |
HAS_LONG_DESCRIPTION |
static java.lang.String |
HIDE_LABEL |
static java.lang.String |
ID |
static java.lang.String |
INT_TYPE |
static java.lang.String |
INTERNAL |
static java.lang.String |
INVALID_BINDING |
static java.lang.String |
IS_NUMERIC |
static java.lang.String |
IS_PERSISTENT |
static java.lang.String |
KEY |
static java.lang.String |
LABEL |
static java.lang.String |
LABELFORMAT |
static java.lang.String |
LENGTH |
static java.lang.String |
LONGDESC_ATTRIBUTE_SUFFIX |
static java.lang.String |
OBJECT_NAME |
static int |
PRIORITY_DATATYPE |
static int |
PRIORITY_FLUSH |
static int |
PRIORITY_VALIDATION |
static java.lang.String |
QUERY |
static java.lang.String |
REMARKS |
static java.lang.String |
SCALE |
static java.lang.String |
SIZE |
static java.lang.String |
SYNCHRONOUS |
static java.lang.String |
TAKESVALUE |
static java.lang.String |
TITLE |
static java.lang.String |
TRUELENGTH |
static java.lang.String |
TYPEAHEADATTRS |
CLASSSPECVALUEATTRIBUTES, DYNAMICATTRIBUTE
CLICKABLE_OFF, CLICKABLE_ON, CONTAINER_ERROR, CONTAINER_ERROR_IMAGE, CONTAINER_WARNING, CONTAINER_WARNING_IMAGE, LOG_CATEGORY, NOT_CLICKABLE, popDefinition
EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST
Constructor and Description |
---|
BoundComponentInstance() |
Modifier and Type | Method and Description |
---|---|
void |
addAttributeError(ERMAttributeError attributeError)
Adds the ERMAttributeError to the BoundComponents error list if the BoundCOmponent does not have
another error.
|
void |
addSetValueError(SetValueError error)
Adds the SetValueError to the components error list and also bubbles the error
up thru the parent container controls.
|
int |
applink()
Handler for the applink event.
|
void |
cleanup() |
int |
clearClassification()
IJ04006:Can still clear classification when conditional UI sets the field CLASSSTRUCTURE_HIERARCHYPATH readonly,
clear Classification is one menu item of the menu CLASSIFICATION
|
void |
clearErrors()
Removes all SetValueErrors associated with this BoundComponent
|
void |
createChangedPropList()
Needed to override this method because restoring the title property to is default value needed to be handled
specially
|
boolean |
dataRestrictionCheck()
Returns true if there is a field level data restriction on the attribute
preventing the control from being visible.
|
int |
datelookup()
Prepares a collection of information before datepopup is called.
|
int |
decrement()
Called from front end when the field data type is DATE, TIME of DATETIME
This even can only be called when user presses DOWN_ARROW keys
on date fields.
|
int |
exceptionhandled() |
java.lang.String |
getApplink() |
boolean |
getBoolean()
Returns the component's value as a boolean.
|
SetValueError |
getCurrentError()
Returns the current SetValueError for this BoundComponent.
|
DataBean |
getDataBean()
Return the databean that is defined by the component's control's datasrc property.
|
int |
getDataType()
Return the max data type of the attribute the component is bound to.
|
java.lang.String |
getDataValueInError()
Used to get the invalid value entered into component
|
SetValueError |
getErrorForRow(int row)
Return the error level for the error assiciated with the passed in row.
|
java.lang.String |
getExcDialogIcon(int exceptionType)
Get tooltip dialog error icon
|
int |
getExceptionType()
Returns the exception type if any attached to this component.
|
com.ibm.json.java.JSONObject |
getFieldInfo()
Returns data type information about this attribute to be added as an attribute on a field
|
int |
getHighestErrorLevel()
validates all errors associated with the boundcomponent (there can be multiple if the component is
within a table) and returns the highest error level.
|
java.lang.String |
getInputMode()
Returns the value of the component's inputmode property.
|
java.lang.String |
getInputModeWithoutPasswordPrefix()
Returns the inputmode without the password prefix.
|
ComponentInstance |
getLinkBack()
Used to get the original component in a linkedcomponent scenario
|
java.lang.String |
getLongDescription()
Returns the long description value of this component.
|
java.lang.String |
getLookupName() |
java.lang.String |
getQbeNameWithPrepend() |
java.util.HashMap |
getReadonlyStateMap() |
java.lang.String |
getRenderIdForAutoFill()
Returns the renderid to be used by the autofill info.
|
java.lang.String |
getString()
Returns the component's value as a String.
|
java.util.List<MXException> |
getWarningList()
Returns the warning list
|
java.lang.String |
getWarningMessages()
Returns warning messages tied to this component if any
|
boolean |
hasChanged()
Returns true if there has been a change to the component's data, readonly, or required states.
|
boolean |
hasDataChanged()
Returns the value of the datachanged flag that was set by the a call to hasChanged().
|
boolean |
hasLongDescChanged()
Returns the value of the longDescChanged flag that was set by the a call to hasChanged().
|
boolean |
hasLongDescription()
Returns true if the component actually has a non-empty long description value.
|
boolean |
hasReadonlyChanged()
Returns the value of the readonlychanged flag that was set by the a call to hasChanged().
|
boolean |
hasRequiredChanged()
Returns the value of the requiredchanged flag that was set by the a call to hasChanged().
|
boolean |
hasWarnings()
Check if warning exists
|
int |
increment()
Called from front end when the field data type is DATE, TIME of DATETIME
This even can only be called when user presses UP_ARROW keys
on date fields.
|
void |
initialize()
Called when the app broadcasts an "initialize" event to all components.
|
void |
instantiatedatasrc()
A broadcast event method that binds the component to the component's databean.
|
boolean |
isDataValid() |
boolean |
isDefault()
Returns whether the component is a default field or not.
|
boolean |
isMasked()
Check the inputmode property along with the BoundComponents MboValueData to
see if the component is masked.
|
boolean |
isOnCurrentRow() |
boolean |
isPasswordField()
Check if the field is password field
Return true if this is a password field
|
boolean |
isQuery()
Returns whether the component is a query field or not.
|
boolean |
isReadOnly()
Returns true if this component (or linked component) is defined as readonly in the mbo, or if the inputmode is
readonly in the presentation xml.
|
boolean |
isRequired()
Returns true if this component is defined as required in the mbo, or if the inputmode is required in the
presentation xml.
|
boolean |
isRevert()
Check if Revert button is clicked
|
boolean |
isRowDeleted() |
boolean |
isSmartFillEnabled(MboValueData mvd)
Returns true if the BoundComponentInstance is smartfill enabled.
|
int |
popexception()
This event is called when use hovers the mouse over the error or warning icon.
|
int |
processAsyncYesNoCancel()
Handle the async error tool tip dialog yes/no/cancel button click event
|
int |
processEdit()
Handle the async error tool tip dialog "Edit My Value" button click event
|
int |
processIgnoreWarning()
Handle the async error tool tip dialog "Use My Value" button click event
|
int |
processProfile(java.lang.String profileName) |
int |
processRevert()
Handle the async error tool tip dialog "Go Back" button click event
|
void |
readOnlyCheck()
Throws an MXApplicationException("jspmessages", "fieldreadonly") if the
component (or the linked component) is read only.
|
void |
removeCurrentError() |
int |
render()
Needed to override this method to cache original values for data, readonly, required and applink
|
void |
resetIsRevert()
Reset the revertvalue
|
boolean |
retryErrorValues()
This method will loop thru all the errors set on the BoundComponent and try
setting the errored values again.
|
int |
selectvalue()
Handler for the selectvalue event
|
void |
setBoundAsRequired()
Deprecated.
This method is no longer needed as the boundAsRequired is not longer needed. Instead call
madeRequiredConditionally on the DataBean the component is bound to.
|
int |
setcurrentdate()
Called from front end when the field data type is DATE, TIME of DATETIME
This even can only be called when user presses SHIFT + 7 (for &) or SHIFT + UP ARROW
|
void |
setDataValid(boolean isDataValid)
For interaction with DataBean.setvalue()
|
void |
setDataValueInError(java.lang.String s)
Used to set/store an invalid value entered into component
|
void |
updateCachedDataValue(java.lang.String value) |
boolean |
useMaxLength()
used to determine whether we can limit the number of entered characters in a field
if there is a domain and it has more than the key used in the typeahead we cannot limit so that typeahead searching will work
|
click, dataChangedEvent, getProperty, hasAnyPropertyChanged, needsRender, resetAttribute, structureChangedEvent
action, broadcastEvent, canChangeRowFocus, clearChangedFlag, clearUIUpdates, controlPropertyChanged, fetchtooltip, findComponentByDescriptorId, findProperty, formatLabel, formatLabel, getChildrenDesignOnly, getClickState, getComponentContainerId, getControl, getCssClass, getCurrent, getCurrentUpdates, getDesignerSelected, getErrorInfo, getFocusRenderId, getId, getId, getIdWithoutRow, getLabelForRenderId, getLabelledByRenderId, getLinkedComponentInstance, getMenuType, getOriginalProperty, getRenderId, getUpdatedAttributes, getUpdatedStyles, hasChildren, hasComponents, hasLocalProperty, hasMaskedChanged, hasUnappliedUIUpdates, hiddenByProp, hiddenByProperty, isAsyncEnabled, isChild, isComponent, isDefaultRender, isDisabled, isHoversActive, isIncluded, isOnTableFilterRow, isOnTableRow, isOnTableTitleRow, isVisible, query, renderChildComponents, renderChildrenControls, rerendering, setChangedFlag, setChangedFlag, setComponentContainerId, setControl, setFocus, setIsHoversActive, setLabelFormat, showMenu, showMenubarMenu, signout, skipRender, updateAttribute, updateStyle, updateStyle
addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, handleEvent, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString
public static final java.lang.String ID
public static final java.lang.String CSS_CLASS
public static final java.lang.String DATA_ATTRIBUTE
public static final java.lang.String DOMAIN
public static final java.lang.String KEY
public static final java.lang.String TYPEAHEADATTRS
public static final java.lang.String REMARKS
public static final java.lang.String TITLE
public static final java.lang.String QUERY
public static final java.lang.String LENGTH
public static final java.lang.String TRUELENGTH
public static final java.lang.String SCALE
public static final java.lang.String IS_NUMERIC
public static final java.lang.String HAS_LONG_DESCRIPTION
public static final java.lang.String INT_TYPE
public static final java.lang.String IS_PERSISTENT
public static final java.lang.String ENTITY_NAME
public static final java.lang.String OBJECT_NAME
public static final java.lang.String ATTRIBUTE_NAME
public static final java.lang.String COLUMN_NAME
public static final java.lang.String BOUND_LABEL
public static final java.lang.String FIELD_LABEL
public static final java.lang.String HIDE_LABEL
public static final java.lang.String INTERNAL
public static final java.lang.String LABEL
public static final java.lang.String DEFAULT_LABEL
public static final java.lang.String SIZE
public static final java.lang.String LABELFORMAT
public static final java.lang.String INVALID_BINDING
public static final java.lang.String BAD_BINDING_CSS
public static final java.lang.String LONGDESC_ATTRIBUTE_SUFFIX
public static final java.lang.String EVENT_PRIORITY
public static final java.lang.String TAKESVALUE
public static final java.lang.String SYNCHRONOUS
public static final int PRIORITY_DATATYPE
public static final int PRIORITY_VALIDATION
public static final int PRIORITY_FLUSH
public boolean bound
public void updateCachedDataValue(java.lang.String value)
public boolean hasChanged()
hasChanged
in class DynamicAttributeComponent
hasChanged()
public boolean hasDataChanged()
public boolean hasLongDescChanged()
public boolean hasReadonlyChanged()
public boolean hasRequiredChanged()
public void setDataValid(boolean isDataValid)
public boolean isDataValid()
public java.lang.String getInputMode()
public java.lang.String getInputModeWithoutPasswordPrefix()
public void initialize()
initialize
in class DynamicAttributeComponent
public java.lang.String getString()
public boolean getBoolean()
public void readOnlyCheck() throws MXException
MXException
- if the component is readonlypublic boolean isReadOnly()
public boolean isRequired()
public java.lang.String getLongDescription()
public boolean hasLongDescription()
Note: this is different from the HAS_LONG_DESCRIPTION property which only indicates whether the component IS ALLOWED to have a long description.
public int applink() throws java.rmi.RemoteException, MXException
It is expected that only textbox components will be receiving this event. Only textbox.jsp checks for the flag set here
java.rmi.RemoteException
MXException
public int selectvalue() throws MXException
MXException
public boolean isOnCurrentRow()
public boolean isRowDeleted()
public java.lang.String getQbeNameWithPrepend()
public int processProfile(java.lang.String profileName)
public DataBean getDataBean()
ComponentInstance
getDataBean
in class ComponentInstance
public int exceptionhandled()
public int datelookup()
public java.lang.String getLookupName()
getLookupName
in class ComponentInstance
public java.lang.String getApplink()
getApplink
in class ComponentInstance
public boolean isDefault()
public boolean isQuery()
public void instantiatedatasrc()
public int getDataType()
public void cleanup()
cleanup
in class DynamicAttributeComponent
public boolean isMasked()
isMasked
in class ComponentInstance
ComponentInstance.isMasked()
public void createChangedPropList()
public int render() throws java.lang.NoSuchMethodException, java.lang.IllegalAccessException, java.lang.reflect.InvocationTargetException
render
in class DynamicAttributeComponent
java.lang.NoSuchMethodException
java.lang.IllegalAccessException
java.lang.reflect.InvocationTargetException
ComponentInstance.render()
public java.lang.String getDataValueInError()
comp
- public void setDataValueInError(java.lang.String s)
public ComponentInstance getLinkBack()
public boolean dataRestrictionCheck()
public int increment()
public int decrement() throws MXException
MXException
public int setcurrentdate() throws MXException
MXException
public void setBoundAsRequired()
public int popexception() throws java.io.IOException, MXException
java.io.IOException
MXException
public int getExceptionType()
public void removeCurrentError()
public java.lang.String getWarningMessages()
public int processAsyncYesNoCancel()
public int processRevert()
public int processIgnoreWarning()
public int processEdit()
public boolean isRevert()
public void resetIsRevert()
public boolean hasWarnings()
public SetValueError getCurrentError()
public void addAttributeError(ERMAttributeError attributeError)
public void addSetValueError(SetValueError error)
public java.util.List<MXException> getWarningList()
public int getHighestErrorLevel()
public void clearErrors()
public java.lang.String getExcDialogIcon(int exceptionType)
public boolean isPasswordField()
public boolean retryErrorValues()
public SetValueError getErrorForRow(int row)
public boolean isSmartFillEnabled(MboValueData mvd)
mvd
- The MboValueData to check to see if it has a lookup definedpublic com.ibm.json.java.JSONObject getFieldInfo()
public boolean useMaxLength()
public java.lang.String getRenderIdForAutoFill()
public int clearClassification() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public java.util.HashMap getReadonlyStateMap()