|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--oracle.cabo.ui.DeprecatedUINode
|
+--oracle.cabo.ui.BaseUINode
|
+--oracle.cabo.ui.BaseMutableUINode
|
+--oracle.cabo.ui.beans.BaseWebBean
|
+--oracle.cabo.ui.beans.MarlinBean
|
+--oracle.cabo.ui.beans.form.FormElementBean
|
+--oracle.cabo.ui.beans.form.TextInputBean
|
+--oracle.cabo.ui.beans.form.LovInputBean
This bean is not supported on the following agent types: pda.
The LOV Input is used as a text field for launching a List Of Values window. This element is designed to work in conjunction with the listOfValues element. See listOfValues for more information.
This element displays a textInput field, and a search icon. If the icon is clicked (or the text is changed in a partial page refresh environment), a sequence of callbacks and events is started leading to the validation of the text in the field and/or the raising of an LOV window. The validation portion of this sequence can be disabled completely by setting the unvalidated attribute to false.
First, the onLovInit callback will be executed. If the callback
returns true, a modal window will be opened displaying the page
designated in the lovInput element's destination attribute. The URL
to open this page will contain any parameters added/changed/updated
in the onLovInit callback. When opened, the destination page will
recieve an
When the LOV window opens, the user is presented with a table of prospective completions based on their originally entered text. The user may choose to cancel (in which case the lovInput's textInput field should remain unchanged), select one of the rows presented, navigate to other rows in the table, search on another category, or enter a new search string. See the listOfValues element for more details.
When the LOV window closes the onLovSelect callback will be executed if provided. Then, an lovClose event is generated.
When partial page rendering is enabled, the lovInput element is extended a bit.
First, the onLovValidate callback is executed if the user clicks the
search icon, or makes any change to the text in the input field
(although if the field ends up as completely whitespace, the
validateBlanks attribute controls validation). The client can use
this callback to gather any extra data from the page. The parameters
that will be sent back on an event URL are available for any
additions, updates and/or deletions. If the onLovValidate callback
returns false, validation processing stops. Otherwise if the
onLovValidate callback returns true, an
In the lovValidate handler, the client should check for valid input, or a unique match (e.g. if the user enters "san fran" and your data value is California cities, the only possible match is "San Francisco"). If the data is valid, the "showWindow" attribute should be set to false (and, in the partial but unique match case, the provider for the text field should be updated to provide the full value "San Francisco" in the example above). Otherwise "showWindow" should be set to true. The default for "showWindow" is false, so "showWindow" can be provided in an EventResult only when needed.
When the lovInput gets a partial refresh request, it will check the "showWindow" attribute. If "showWindow" is false, the text field will simply be re-rendered. If "showWindow" is true, the LOV window will be opened as above.
If the user clicks the lovInput seach icon when they have made no changes to the text in the input field, no validate event will be generated. The LOV window will be created directly.
This example shows two lovInput elements which have their LOV window definitions (presumably using listOfValues) in LOVdialogs.uix. When the window for lov1 is closed, the myCallBack function will be executed. The second example shows the partial page version with validation and a pre-validate callback.
<form name="form1">
<contents>
<script>
<contents>
function SelectCallBack(lovWin, field, event)
{
// This function will be called after the select button has been clicked.
// - lovWin points to the not-yet-closed LOV dialog window.
// - field points to the lovInput field that triggered this
// LOV dialog.
// - event is the window close event
//
var fldNam = field.name;
var val = field.value;
var str = "SelectCallback called\nfieldName: '" + fldNam
+ "'\nvalue: '" + val;
confirm(str);
// Now we could gather values from the LOV Window (using the lovwin
// object), and use them build a string to set into the original
// LovInput text field using: field.value = newValue;
return true;
}
function _printCallbackParams(params, CBName)
{
// This function just raises a confirm dialog listing
// key:value pairs in the params object
var str = CBName + ' called with:'
for (var key in params)
{
str += "\nparameter: '" + key +
"', value '" + params[key] + "'";
}
return confirm(str);
}
function InitCallBack(params)
{
// If passed as the onLovInit attribute, this function is called
// after the LOV icon is clicked, but before the LOV dialog window
// is launched. This gives the developer a change to change the
// parameters that are going to the dialog window.
// The params object contains all the parameters which will end up
// on the URL.
// Add our own parameter. This will end up as a parameter on the
// LOV dialog window URL.
// (http://...?...&myParam=foo)
params["myParam"] = "foo";
return _printCallbackParams(params, 'InitCallback');
// return true;
}
function ValidateCallBack(params)
{
// If passed as the onLovValidate attribute, this function is called
// before the lovValidate event is fired.
// This gives the developer a chance to add, subtract or change
// parameters that will be sent with the lovValidate event
return _printCallbackParams(params, 'pre-validate Callback');
}
</contents>
</script>
<stackLayout>
<contents>
<flowLayout>
<contents>
<styledText text="value 1: "/>
<lovInput name="lov1"
shortDesc="Click to select a predefined value"
onLovInit="initCallBack"
onLovSelect="selectCallBack"
destination="LOVwindows.uix"/>
</contents>
</flowLayout>
<flowLayout>
<contents>
<styledText text="value 2: "/>
<lovInput name="lov2"
id="Lov-target2"
data:showWindow="isNotValid@someEventResult"
shortDesc="Click to select a predefined value"
onLovInit="initCallBack"
onLovSelect="selectCallBack"
onLovValidate="validateCallBack"
destination="LOVwindows.uix"/>
</contents>
</flowLayout>
</contents>
</stackLayout>
</contents>
</form>
| Constructor Summary | |
|
LovInputBean()
Construct an instance of the LovInputBean. |
protected |
LovInputBean(boolean ignored,
java.lang.String localName)
Construct an instance of the LovInputBean. |
| Method Summary | |
java.lang.String |
getDestination()
Gets The path to the page that will populate the LOV window. |
static java.lang.String |
getDestination(MutableUINode bean)
Gets The path to the page that will populate the LOV window. |
java.lang.String |
getOnLovInit()
Gets The name of a JavaScript function that will be called before the LOV window is opened. |
static java.lang.String |
getOnLovInit(MutableUINode bean)
Gets The name of a JavaScript function that will be called before the LOV window is opened. |
java.lang.String |
getOnLovSelect()
Gets The name of a JavaScript function that will be called after the LOV window is closed. |
static java.lang.String |
getOnLovSelect(MutableUINode bean)
Gets The name of a JavaScript function that will be called after the LOV window is closed. |
java.lang.String |
getOnLovValidate()
Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. |
static java.lang.String |
getOnLovValidate(MutableUINode bean)
Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. |
java.lang.String |
getPartialRenderMode()
Gets |
static java.lang.String |
getPartialRenderMode(MutableUINode bean)
Gets |
java.lang.String[] |
getPartialTargets()
Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". |
static java.lang.String[] |
getPartialTargets(MutableUINode bean)
Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". |
boolean |
isShowWindow()
Gets The "showWindow" attribute is set to false if the value in the text field is considered valid. |
static boolean |
isShowWindow(MutableUINode bean)
Gets The "showWindow" attribute is set to false if the value in the text field is considered valid. |
boolean |
isUnvalidated()
Gets Setting this value to TRUE will inhibit the validation step. |
static boolean |
isUnvalidated(MutableUINode bean)
Gets Setting this value to TRUE will inhibit the validation step. |
boolean |
isValidateBlanks()
Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). |
static boolean |
isValidateBlanks(MutableUINode bean)
Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). |
static void |
setDestination(MutableUINode bean,
java.lang.String destination)
Sets The path to the page that will populate the LOV window. |
void |
setDestination(java.lang.String destination)
Sets The path to the page that will populate the LOV window. |
static void |
setOnLovInit(MutableUINode bean,
java.lang.String onLovInit)
Sets The name of a JavaScript function that will be called before the LOV window is opened. |
void |
setOnLovInit(java.lang.String onLovInit)
Sets The name of a JavaScript function that will be called before the LOV window is opened. |
static void |
setOnLovSelect(MutableUINode bean,
java.lang.String onLovSelect)
Sets The name of a JavaScript function that will be called after the LOV window is closed. |
void |
setOnLovSelect(java.lang.String onLovSelect)
Sets The name of a JavaScript function that will be called after the LOV window is closed. |
static void |
setOnLovValidate(MutableUINode bean,
java.lang.String onLovValidate)
Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. |
void |
setOnLovValidate(java.lang.String onLovValidate)
Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. |
static void |
setPartialRenderMode(MutableUINode bean,
java.lang.String partialRenderMode)
Sets |
void |
setPartialRenderMode(java.lang.String partialRenderMode)
Sets |
static void |
setPartialTargets(MutableUINode bean,
java.lang.String[] partialTargets)
Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". |
void |
setPartialTargets(java.lang.String[] partialTargets)
Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". |
void |
setShowWindow(boolean showWindow)
Sets The "showWindow" attribute is set to false if the value in the text field is considered valid. |
static void |
setShowWindow(MutableUINode bean,
boolean showWindow)
Sets The "showWindow" attribute is set to false if the value in the text field is considered valid. |
void |
setUnvalidated(boolean unvalidated)
Sets Setting this value to TRUE will inhibit the validation step. |
static void |
setUnvalidated(MutableUINode bean,
boolean unvalidated)
Sets Setting this value to TRUE will inhibit the validation step. |
void |
setValidateBlanks(boolean validateBlanks)
Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). |
static void |
setValidateBlanks(MutableUINode bean,
boolean validateBlanks)
Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). |
| Methods inherited from class oracle.cabo.ui.beans.form.FormElementBean |
getName, getName, getOnBlur, getOnBlur, getOnFocus, getOnFocus, isDisabled, isDisabled, isReadOnly, isReadOnly, setDisabled, setDisabled, setName, setName, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setOnBlur, setOnBlur, setOnFocus, setOnFocus, setReadOnly, setReadOnly |
| Methods inherited from class oracle.cabo.ui.beans.MarlinBean |
isEqualMarlinName |
| Methods inherited from class oracle.cabo.ui.BaseUINode |
getAttributeNames, getAttributeValue, getAttributeValueImpl, getChildArray, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getPreorderDescendentAttributeValue, getRawAttributeValue, getRenderedUINode, getRenderer, getRenderer, render, render, toString |
| Methods inherited from class oracle.cabo.ui.DeprecatedUINode |
getAttributeValue, getChildNames, getNamedChild |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface oracle.cabo.ui.UINode |
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render |
| Constructor Detail |
public LovInputBean()
protected LovInputBean(boolean ignored,
java.lang.String localName)
| Method Detail |
public final java.lang.String getDestination()
public final void setDestination(java.lang.String destination)
public final java.lang.String getOnLovInit()
function initCallBack(params)
public final void setOnLovInit(java.lang.String onLovInit)
function initCallBack(params)
public final java.lang.String getOnLovValidate()
function initCallBack(params)
public final void setOnLovValidate(java.lang.String onLovValidate)
function initCallBack(params)
public final java.lang.String getOnLovSelect()
function selectCallBack(Win, field, event)
public final void setOnLovSelect(java.lang.String onLovSelect)
function selectCallBack(Win, field, event)
public final boolean isShowWindow()
public final void setShowWindow(boolean showWindow)
public final boolean isUnvalidated()
public final void setUnvalidated(boolean unvalidated)
public final boolean isValidateBlanks()
public final void setValidateBlanks(boolean validateBlanks)
public final java.lang.String getPartialRenderMode()
The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.
In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.
public final void setPartialRenderMode(java.lang.String partialRenderMode)
The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.
In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.
public final java.lang.String[] getPartialTargets()
public final void setPartialTargets(java.lang.String[] partialTargets)
public static java.lang.String getDestination(MutableUINode bean)
public static void setDestination(MutableUINode bean,
java.lang.String destination)
public static java.lang.String getOnLovInit(MutableUINode bean)
function initCallBack(params)
public static void setOnLovInit(MutableUINode bean,
java.lang.String onLovInit)
function initCallBack(params)
public static java.lang.String getOnLovValidate(MutableUINode bean)
function initCallBack(params)
public static void setOnLovValidate(MutableUINode bean,
java.lang.String onLovValidate)
function initCallBack(params)
public static java.lang.String getOnLovSelect(MutableUINode bean)
function selectCallBack(Win, field, event)
public static void setOnLovSelect(MutableUINode bean,
java.lang.String onLovSelect)
function selectCallBack(Win, field, event)
public static boolean isShowWindow(MutableUINode bean)
public static void setShowWindow(MutableUINode bean,
boolean showWindow)
public static boolean isUnvalidated(MutableUINode bean)
public static void setUnvalidated(MutableUINode bean,
boolean unvalidated)
public static boolean isValidateBlanks(MutableUINode bean)
public static void setValidateBlanks(MutableUINode bean,
boolean validateBlanks)
public static java.lang.String getPartialRenderMode(MutableUINode bean)
The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.
In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.
public static void setPartialRenderMode(MutableUINode bean,
java.lang.String partialRenderMode)
The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.
In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.
public static java.lang.String[] getPartialTargets(MutableUINode bean)
public static void setPartialTargets(MutableUINode bean,
java.lang.String[] partialTargets)
|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||