You are on page 1of 297

OA Component Reference

Release 12.2.4
July 2014

Table of Contents
OA COMPONENT REFERENCE .......................................................................................................... 1
package ....................................................................................................................................... 1
page ............................................................................................................................................. 2
attributeSet .................................................................................................................................. 3
REGION STYLES ............................................................................................................................... 5
advancedSearch ......................................................................................................................... 5
advancedTable ............................................................................................................................ 7
bulletedList ................................................................................................................................ 24
cellFormat .................................................................................................................................. 28
contentContainer ....................................................................................................................... 32
contentFooter ............................................................................................................................ 35
defaultDoubleColumn................................................................................................................ 38
defaultFormStack ...................................................................................................................... 41
defaultSingleColumn ................................................................................................................. 44
defaultStack ............................................................................................................................... 47
flexibleContent........................................................................................................................... 50
flexibleLayout ............................................................................................................................ 54
flowLayout ................................................................................................................................. 58
footer.......................................................................................................................................... 62
Gantt .......................................................................................................................................... 65
graphTable ................................................................................................................................ 70
header ....................................................................................................................................... 76
HGrid ......................................................................................................................................... 80

iii

OA Extension Component Reference


hideShow ................................................................................................................................... 84
hideShowHeader ....................................................................................................................... 88
labeledFieldLayout .................................................................................................................... 92
listOfValues ............................................................................................................................... 96
menu .......................................................................................................................................... 99
messageComponentLayout .................................................................................................... 103
navigationBar .......................................................................................................................... 107
pageButtonBar ........................................................................................................................ 110
pageLayout .............................................................................................................................. 112
popUp ...................................................................................................................................... 118
query ........................................................................................................................................ 121
rowLayout ................................................................................................................................ 126
shuttle ...................................................................................................................................... 129
stackLayout ............................................................................................................................. 132
subTabLayout.......................................................................................................................... 136
switcher ................................................................................................................................... 140
table ......................................................................................................................................... 143
tableLayout .............................................................................................................................. 148
train .......................................................................................................................................... 151
tree........................................................................................................................................... 154
ITEM STYLES ................................................................................................................................ 161
attachmentImage..................................................................................................................... 161
attachmentLink ........................................................................................................................ 167
attachmentTable...................................................................................................................... 171

iv

Table of Contents
button ....................................................................................................................................... 177
exportButton ............................................................................................................................ 180
flex ........................................................................................................................................... 182
formParameter ........................................................................................................................ 185
formattedText .......................................................................................................................... 187
formValue ................................................................................................................................ 190
image ....................................................................................................................................... 192
link ........................................................................................................................................... 195
list ............................................................................................................................................ 198
messageCheckBox ................................................................................................................. 201
messageChoice....................................................................................................................... 205
messageDownload .................................................................................................................. 209
messageFileUpload ................................................................................................................ 213
messageInlineAttachment ....................................................................................................... 216
messageLovChoice ................................................................................................................. 221
messageLovInput .................................................................................................................... 225
messageRadioButton .............................................................................................................. 230
messageRadioGroup .............................................................................................................. 233
messageRatingBar .................................................................................................................. 237
messageRichTextEditor .......................................................................................................... 241
messageSpinBox .................................................................................................................... 245
messageStyledText ................................................................................................................. 250
messageTextInput ................................................................................................................... 254
rawText .................................................................................................................................... 258

OA Extension Component Reference


resetButton .............................................................................................................................. 260
richContainer ........................................................................................................................... 262
richTextEditor .......................................................................................................................... 265
selectionButton ........................................................................................................................ 269
separator ................................................................................................................................. 271
servletInclude .......................................................................................................................... 273
spacer ...................................................................................................................................... 275
staticStyledText ....................................................................................................................... 277
styledText ................................................................................................................................ 280
submitButton............................................................................................................................ 282
tip ............................................................................................................................................. 285
urlInclude ................................................................................................................................. 288

vi

OA Component Reference
package
Description
A package file contains attributeSets. AttributeSets are a collection of properties that can be reused in OA components.

Properties
Name

Description

Comments
Comments
Documentation Formatted text
Comment
for use with
Javadoc.
File Version
The version of
the file.
OA Extension The Oracle
Version
Applications
Extension
version with
which the file
was created or
updated.

Type
string
string

string

Default Personalizable Translatable


XML
Value
Attribute
null
null
from
null
template
file
null
null

jrad:version null

null

no
no

comment
not
applicable

no

fileversion
version

no

OA Extension Component Reference

page
Description
A top-level container that enables the user interface to your application.

Properties
Name
Attribute
Set

Description

Type

Default Personalizable Translatable XML


Value
Attribute
jrad:attributeSetRef null
null
no
use

The attribute
set for the
component.
Comments Comments.
string
File
The version of string
Version
the file.
OA
The Oracle
jrad:version
Extension Applications
Version
Extension
version with
which the file
was created
or updated.

null
null

null
null

no
no

null

null

no

comment
fileversion
version

OA Component Reference

attributeSet
Description
Attribute sets are named, reusable collections of properties (prompt, maximum display length,
data type and so on as appropriate for the attribute set type) that can be used by any type of OA
component, including regions, items, and other attribute sets. They are designed to facilitate the
reuse of these components throughout Oracle Applications, which yields a significant cost
savings to both Oracle and its customers.
In general terms, attribute sets are organized into OA component packages (individual XML
package files), where you have one package file per database table in your application.
Refer to the Attribute Sets section in the Oracle Applications Framework Developer's Guide,
included in the Help, for complete information on using attribute sets.

Properties
The list of properties that an attribute set can assume is not limited to those in the list below; it
includes the union of all properties available on all components.
Name

Description

Document The name of the


Name
component
Scope
The Base
Packages which
are allowed to
reuse this
component.

Type

Default Personalizable Translatable


XML
Value
Attribute
jrad:refName null
null
no
docName
jrad:scope

.
null
(public)

no

scope

OA Extension Component Reference

Region Styles
advancedSearch
Description
The advancedSearch region extends UIX's StackLayoutBean. This is a very complicated layout
used for rendering search pages which allow an end-user to specify a criteria for performing a
search.
Metadata for advancedSearch region implementation consists of three parts:

Static Text
Criteria Rows
Button Bar

The XML schema for advancedSearch defines three groupings: staticText, criteria, and
buttonBar. The staticText grouping contains a set of messageStyledText beans. The critera
grouping will contain criteriaRow elements. The buttonBar grouping will contain a set of submit
beans. The metadata for criteriaRow shows only two elements -- a messageStyledText element
for displaying the label, and an input (messageTextInput, messageLovInput, messageChoice)
element. Internally, the framework creates a messageChoice bean that gets rendered between
the label and the input element. So, the messageStyledText bean, the messageChoice bean,
and the input element form a critera row.
Corresponding web bean: OAAdvancedSearchBean

Properties
The advancedSearch region inherits all the attributes from stackLayout. No additional attributes
specific to this region style are required. See the section on stackLayout for a list of attributes
and child elements available for the stackLayout element.

Child Elements
In addition to inheriting the named children defined for the OA Extension, the extension will have
the following groupings:
Name

Description

Intermedia Indicates if the

Type

Default Personalizable Translatable XML Attribute


Value

boolean false

null

no

intermediaStyle
5

OA Extension Component Reference

Style

advanced search
will use intermedia
style queries.

Element Children
Name

Quantity

Description

buttonBar 0 through 1 This element contains a group of buttons that are rendered at the bottom
of the search region. A developer can add as many buttons inside this
container as he wishes.
criteria
1
This is a container for unbounded number of rowLayout elements.
staticText 0 through 1 Describes the text before the radioButtons.

Region Styles

advancedTable
Description
The advancedTable region style is used to display tabular data. It supports selection (both
single and multiple), sorting, record navigation, totaling and detail-disclosure. advancedTable
also provides declarative support for grouping of column headers. This includes support for
column formats, column header, column header data and column header formats.
Support for both column bean and column group beans is provided. These are container beans
with the ability to hold other regions and items. Support for formValue beans is also provided.
See the section on formValue for a list of attributes and child elements available on the
formValue element.
advancedTable supports column beans and columnGroup beans only as indexed children; the
mix of both is not supported.
Declarative specification is possible for the following advancedTable
features/components/attributes:

Number of rows to be displayed for the table


The header text for the individual table columns
Whether sorting is to be enabled on the table, and if the table is to be rendered with the
intial sorts on at most three columns
Whether a column can be totaled
Single selector and multiple selector named children
Detail disclosure named child
Row headers
Wrap settings
ColumnBean and ColumnGroupBean as indexed children
Any bean as an indexed child of the selector
Around the table insertion, whether the table should render the "Add Another Row";
whether row insertion should be auto-handled by the OA Framework and if so, the
number of rows to be inserted in one go
Table formats - tableBanding, bandingInterval
Column formats - columnDataFormat, cellNoWrapFormat, width, displayGrid,
bandingShade
Column header formats - cellNoWrapFormat
Row formats - displayGrid
Row header formats - cellNoWrapFormat
Whether a value will be submitted with a form - formValue

Advanced Table Accessibility Support


To support accessibility for screen readers, you must specify a column in an advanced table as
a row header. Every row in the table must refer to a column as the row header that uniquely
7

OA Extension Component Reference


identifies the row so the screen reader can read it. Screen reader users must also define their
Accessibility mode by setting the profile "Self Service Accessibility Features" to Screen Reader
Optimized.
The underlying UIX oracle.cabo.ui.beans.table.TableBean supports accessibility by
defaulting a table's first column as the row header. However, you can set a different column as
the row header, especially if a user is likely to personalize the table by turning off rendering of
the first column or if the first column can return no data.
To declaratively set a column as a row header, in the OA Extension Property Inspector, specify
a column ID (String) for the Row Header Column property (XML attribute: rowheadercol) of
the advanced table region.
To programmatically set a column as a row header, use the following API on
OAAdvancedTableBean:
setRowHeaderColumn(<columnName>);
As of Release 12.2, you may also personalize the Row Header Col property of an Advanced
Table to set a column as a Row Header for screen reader accessibility.
Corresponding web bean: OAAdvancedTableBean

Properties
Name
Additional
Text
Admin
Personaliz
ation

Description

Additional help
text.
Indicates if an
Administrator can
personalize this
component.
AM
The fully-qualified
Definition class name for the
application
module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set
Set
for the component.
Banding The number of
Interval
rows or columns to
group with the
same shade.
Banding The type of
8

Type

Default Personaliz Translat


Value
able
able

XML Attribute

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
unsignedInt
1

null

no

use

user

no

bandingInterval

ui:tableBandin noBan user

no

tableBanding

Region Styles

Type
Child View
Attribute
Comments
Controller
Class
Detail
View
Attribute

Dirty Row
Sort
Enabled
Disable
Client Side
Validation

banding on the
table.
The name of the
child view attribute.
Comments
The fully-qualified
class name for the
controller object.
The view attribute
that determines if
that particular row
is to be stamped
with the detail
child.
Indicates if middletier sort should be
performed on the
table.
Indicates if
validation should
not occur on the
web tier during a
form submit.
The name of the
component
Formatted text for
use with Javadoc.

Document
Name
Document
ation
Comment
Empty
The text to display
Table Text inside an empty
table.
Enable
Enable columns to
Column
be hidden/shown
Hide Show by end users.
Enable
Enable columns to
Column
be reordered by
Reorder
end users.
Enable
Enable columns to
Column
be resized by end
Resize
users.
Enable
Enable the table to
Detach
be detached and
maximized in the
browser.
Enable
Enable horizontal
Horizontal scroll bars.

gRule

ding

string

null

null

no

string
string

null
null

null
admin

no
no

childViewAttrNam
e
comment
controllerClass

string

null

null

no

detailViewAttr

boolean

false

null

no

dirtyRowSortEnabl
ed

boolean

false

null

no

unvalidated

null

no

docName

no

not applicable

string

from
null
templat
e file
null
null

no

alternateText

boolean

true

admin

no

columnHideShow
Enabled

boolean

true

admin

no

colReorderEnable
d

boolean

true

admin

no

colResizeEnabled

boolean

true

admin

no

detachEnabled

boolean

true

admin

no

horizontalScrollEn
abled

jrad:refName null
string

OA Extension Component Reference

Scroll
Extends

A reference to
another
component that
creates a different
instance of that
component at
runtime.
File
The version of the
Version
file.
Help
The target name
Target
for the page online
help.
Help
This application
Target
will be used to
Appl Short construct URI of
Name
the "help" icon in
the global menu of
the page.This
makes the help
pages from the
other applications
referenceable.
ID
The unique name
of this component.
OA
The Oracle
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label
ation Label used for
Personalization.
Post Initial Indicates if rows
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Record
Indicates if Record
History
History feature is
Enabled enabled.
Records The maximum
Displayed number of rows to
display.
Rendered Indicates if the
10

jrad:compone null
ntRef

null

no

extends

string

null

null

no

file-version

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSh
ortName

Name

null

null

no

id

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

false

admin

no

recordHistoryEnab
led

unsignedInt

10

admin

no

blockSize

boolean

true

user

no

rendered

Region Styles

Row
Header
Col
Row
Header
View
Attribute
Scope

component is
rendered.
Indicates if Scope string
attribute is to be
added to Table.
The view attribute string
for the row header.

The Base
Packages which
are allowed to
reuse this
component.
Security
Defines the
Mode
security mode
used to secure the
region. If set to
selfSecured it is
the developer's
responsibility to
handle security
validation. The
legal values are
standard, and self
Secured.
Standalon Indicates if this
e
region can be
rendered on its
own.
Text
The text label for
the component.
User
Indicates if a user
Personaliz can personalize
ation
this component.
View
The name of the
Instance view object
instance.
View Link The name of the
Instance View Link Instance
establishing
master-detail
relationship
between outer and
inner repeating
containers.
Width
Indicates the width

null

admin

no

rowheadercol

null

null

no

rowHeaderViewAtt
r

jrad:scope

null

no

scope

string

standar null
d

no

securityMode

boolean

false

null

no

standalone

string

null

admin

no

text

boolean

false

admin

no

userCustomizable

string

null

null

no

viewName

string

null

null

no

viewLinkName

string

null

null

no

width
11

OA Extension Component Reference

xml:lang

in pixels or as a
percentage (if the
% sign is
included).
Identifies the
language
contained within
this component.

optional

null

null

no

xml:lang

Element Children
Name

Quantity

Description

detail
footer
tableActions

0 through 1 Node to stamp below every row which is disclosed.


0 through 1 Node used to render the table footer.
0 through 1 Component used for performing table actions that are independent
of row selection.
tableSelection 0 through 1 SingleSelectionBean or MultipleSelectionBean to render with the
table.

columnGroup
Name

Descriptio
n

Type

Admin
Indicates if boolean
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
Document
The name jrad:refName
Name
of the
component
Extends
A reference jrad:component
to another Ref
component
that
12

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true
admin
no
adminCustomiza
ble

null

null

no

use

null
null

null
null

no
no

comment
docName

null

null

no

extends

Region Styles

creates a
different
instance of
that
component
at runtime.
Rendered
Indicates if
the
component
is
rendered.
Scope
The Base
Packages
which are
allowed to
reuse this
component
.
User
Indicates if
Personalizati a user can
on
personalize
this
component
. Valid only
when used
in table
region.
xml:lang
Identifies
the
language
contained
within this
component
.

boolean

null

user

no

rendered

jrad:scope

null

no

scope

boolean

false

admin

no

userCustomizabl
e

optional

null

null

no

xml:lang

Column
Name

Description

Admin
Indicates if an
Personaliz Administrator
ation
can
personalize this
component.
Alignment columnDataFor
mat
Attribute
The attribute

Type
boolean

Default Personaliz Translat XML Attribute


Value
able
able
true
admin
no
adminCustomi
zable

ui:tableColumnData textFor user


Format
mat
jrad:attributeSetRef null
null

no
no

columnDataFo
rmat
use
13

OA Extension Component Reference

Set
Banding
Shade

Comments
Document
Name
Extends

Grid
Displayed

No Wrap

Rendered

Scope

Total Value

User
Personaliz
14

set for the


component.
The shade of string
banding used
for the column.
The legal
values are
none, dark, and
light.
Comments
string
The name of
jrad:refName
the component
A reference to jrad:componentRef
another
component that
creates a
different
instance of that
component at
runtime.
Indicates if a
boolean
gridline before
the column
should appear.
Indicates if cell boolean
contents
should be
wrapped. Valid
only when used
in table region.
Indicates if the boolean
component is
rendered.
The Base
jrad:scope
Packages
which are
allowed to
reuse this
component.
Indicates if an boolean
additional field
should be
displayed to
show the total
of this column.
Indicates if a
boolean
user can

none

user

no

bandingShade

null
null

null
null

no
no

comment
docName

null

null

no

extends

true

user

no

displayGrid

false

user

no

cellNoWrapFo
rmat

null

user

no

rendered

null

no

scope

false

user

no

totalValue

false

admin

no

userCustomiz
able

Region Styles

ation

Width
xml:lang

personalize this
component.
Valid only
when used in
table region.
column width. string
Identifies the
optional
language
contained
within this
component.

null
null

user
null

no
no

width
xml:lang

sortableHeader
Name

Description

Abbreviati The value for this property


on
acts as an abbreviation
for the column header
text, and is read
whenever a value for the
column is read out. Use
this property to avoid long
table headings being read
repetitively by a screen
reader.
Additional Additional help text.
Text
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
Attribute The attribute set for the
Set
component.
Comments Comments
CSS Class Overrides the default CSS
class.
Document The name of the
Name
component
Extends
A reference to another
component that creates a
different instance of that
component at runtime.
Initial Sort Indicates the initial sort

Type

Defa Personaliz Translat


ult
able
able
Valu
e

XML
Attribute

string

null

null

no

abbreviation

string

null

admin

yes

shortDesc

boolean

true admin

no

adminCustom
izable

jrad:attribute null
SetRef
string
null
string
null

null

no

use

null
admin

no
no

comment
styleClass

jrad:refName null

null

no

docName

jrad:compone null
ntRef

null

no

extends

none null

no

initSortSeq

string

15

OA Extension Component Reference

Sequence sequence for each


search. The legal values
are
none, first, second, and th
ird.
No Wrap Indicates if cell contents boolean
should be wrapped. Valid
only when used in table
region.
Prompt
The text label for the
string
component.
Rendered Indicates if the component boolean
is rendered.
Required Indicates if the required
ui:required
Indicator indicator is shown on the
column header. Valid
values are "no," "uiOnly,"
"validaterOnly" and "yes."
Scope
The Base Packages
jrad:scope
which are allowed to
reuse this component.
Sort
Indicates if the user can string
Allowed
sort this column. Valid
only when used in table
region. The legal values
are
yes, no, ascending, and d
escending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting. Valid only
when used in table region.
User
Indicates if a user can
boolean
Personaliz personalize this
ation
component. Valid only
when used in table region.
xml:lang Identifies the language
optional
contained within this
component.

false null

no

cellNoWrapF
ormat

null

admin

yes

prompt

null

user

no

rendered

no

admin

no

required

null

no

scope

no

admin

no

sortState

null

user

no

sortByViewAtt
r

false admin

no

userCustomiz
able

null

no

xml:lang

null

tableFooter
Name

Admin
16

Description

Indicates if an

Type

boolean

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
true

admin

no

adminCustomi

Region Styles

Personaliza Administrator can


tion
personalize this
component.
Attribute
The attribute set for jrad:attributeS null
null
Set
the component.
etRef
Comments Comments
string
null
null
Controller The fully-qualified
string
null
admin
Class
class name for the
controller object.
Document The name of the
jrad:refName null
null
Name
component
Extends
A reference to
jrad:componen null
null
another component tRef
that creates a
different instance of
that component at
runtime.
Personaliza The region label
string
null
null
tion Label used for
Personalization.
Post Initial Indicates if rows
boolean
false null
Values
which are made dirty
only by the
defaulting of Initial
Values are to be
posted.
Rendered Indicates if the
boolean
null
user
component is
rendered.
Scope
The Base Packages jrad:scope
.
null
which are allowed to
reuse this
component.
Security
Defines the security string
standa null
Mode
mode used to
rd
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfSe
cured.
xml:lang
Identifies the
optional
null
null
language contained
within this

zable

no

use

no
no

comment
controllerClass

no

docName

no

extends

no

regionName

no

postDefault

no

rendered

no

scope

no

securityMode

no

xml:lang

17

OA Extension Component Reference

component.

addTableRow
Name

Add Rows
Label

Descriptio
n

Type

Overrides string
the default
text of the
Add Rows
button.
Additional
Additional string
Text
help text.
Admin
Indicates if boolean
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
Document
The name jrad:refName
Name
of the
component
Extends
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
Insert Rows Indicates if boolean
Automatically rows will be
added
automatical
ly when the
Add Rows
18

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
null
admin
true
text

null

admin

yes

shortDesc

true

admin

no

adminCustomiza
ble

null

null

no

use

null
null

null
null

no
no

comment
docName

null

null

no

extends

true

null

no

autoInsertion

Region Styles

button is
pressed, or
if the
developer
must
respond to
the event.
Rendered
Indicates if boolean
the
component
is
rendered.
Rows to Add The
unsignedInt
number of
rows to add
when the
button is
pressed.
Scope
The Base jrad:scope
Packages
which are
allowed to
reuse this
component
.
xml:lang
Identifies optional
the
language
contained
within this
component
.

null

user

no

rendered

null

admin

no

rows

null

no

scope

null

null

no

xml:lang

totalRow
Name

Additional
Text
Admin
Personalizati
on

Descriptio
n

Type

Additional string
help text.
Indicates if boolean
an
Administrat
or can
personalize
this
component
.

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
null

admin

yes

shortDesc

true

admin

no

adminCustomiza
ble

19

OA Extension Component Reference

Attribute Set The


jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
Disable Total Indicates if boolean
Recalculation the button
used to
update
totals
should not
be
rendered.
Document
The name jrad:refName
Name
of the
component
Extends
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
Recalculate Overrides string
Totals Label the default
text of the
Update
Totals
button.
Rendered
Indicates if boolean
the
component
is
rendered.
Scope
The Base jrad:scope
Packages
which are
allowed to
reuse this
component
.
xml:lang
Identifies optional
the
language
20

null

null

no

use

null
false

null
admin

no
no

comment
readOnly

null

null

no

docName

null

null

no

extends

null

admin

true

text

true

user

no

rendered

null

no

scope

null

null

no

xml:lang

Region Styles

contained
within this
component
.

lovActionButton
Name

Additional
Text
Admin
Personalizati
on

Descriptio
n

Type

Additional string
help text.
Indicates if boolean
an
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
CSS Class Overrides string
the default
CSS class.
Document
The name jrad:refName
Name
of the
component
Extends
A
jrad:component
reference Ref
to another
component
that
creates a
different
instance of
that
component
at runtime.
External LOV The name jrad:component
of the
Ref
external
List of

Defau Personaliza Translatab


lt
ble
le
Value

XML Attribute

null

admin

yes

shortDesc

true

admin

no

adminCustomizab
le

null

null

no

use

null
null

null
admin

no
no

comment
styleClass

null

null

no

docName

null

null

no

extends

null

null

no

externalListOfVal
ues

21

OA Extension Component Reference

Prompt

Rendered

Scope

xml:lang

Values
region.
The text
label for
the
component
.
Indicates if
the
component
is
rendered.
The Base
Packages
which are
allowed to
reuse this
component
.
Identifies
the
language
contained
within this
component
.

string

null

admin

true

prompt

boolean

null

user

no

rendered

jrad:scope

null

no

scope

optional

null

null

no

xml:lang

lovActionMap
Name
Additional
Text
Attribute
Set

Description

Additional help
text.
The attribute
set for the
component.
LOV
The name of
Region
the item in the
Item
List Of Values
region.
Rendered Indicates if the
component is
rendered.
Return
The name of
Item
the item in the
base page
that receives
22

Type
string

Default Personalizable Translatable


XML
Value
Attribute
null
admin
yes
shortDesc

jrad:attributeSetRef null

null

no

use

jrad:localRefString null

null

no

lovItem

boolean

null

user

no

rendered

jrad:localRef

null

null

no

resultTo

Region Styles

the result from


the LOV
Region Item.

23

OA Extension Component Reference

bulletedList

Description
The bulletedList region ouputs each visible indexed child in a list with a bullet next to it. A visible
indexed child is a child whose RENDERED_ATTR has not been set to false.
The list can be split into columns. This is done by setting the Height attribute. This is the multiple
of indexed children at which to add another column.
For example, if the Height attribute is set to 6, and there are 1-6 visible indexed children, there
would be one column. If there are 7 to 12 visible indexed children there would be 2 columns,
and if there are 13+ visible indexed children, they would be shown in 3 columns.
The maximum number of columns is 3, so if there are 100 visible indexed children, there will still
be only 3 columns. The default split is set to 10. The split is based solely on the number of
visible indexed children and not on their size.
The bulletedList region extends the UIX counterpart <uix:bulletedList> and inherits all the
attributes and the named children. The only child that <uix:bulletedList> supports is the standard
contents element for the indexed children.
Corresponding web bean: OABulletedListBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
24

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

Region Styles

Name

Attribute
Set
Child View
Attribute
Child View
Instance

Description

module.
The attribute set for
the component.
The name of the
child view attribute.
Renders an
instance of the
object for each row
in the View
Instance.
Comments
The fully-qualified
class name for the
controller object.
Overrides the
default CSS class.
The name of the
component
Formatted text for
use with Javadoc.

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

null

no

docName

from null
templ
ate
file
Extends
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
null
Version
file.
Height
The display height string
null
null
in characters.
Help
The target name for string
null
null
Target
the page online
help.
Help
This application will string
null
null
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other

no

not applicable

no

extends

no

file-version

no

height

no

helpTarget

no

helpTargetAppSho
rtName

Comments
Controller
Class
CSS Class
Document
Name
Document
ation
Comment

jrad:refName null
string

25

OA Extension Component Reference

Name

ID
OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Rendered

Scope

Security
Mode

Standalon
e
View Link
Instance

26

Description

Type

applications
referenceable.
The unique name of Name
this component.
The Oracle
jrad:version
Applications
Extension version
with which the file
was created or
updated.
The region label
string
used for
Personalization.
Indicates if rows
boolean
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if the
boolean
component is
rendered.
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Defines the security string
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Indicates if this
boolean
region can be
rendered on its own.
The name of the
string
View Link Instance
establishing masterdetail relationship

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

null

null

no

id

null

null

no

version

null

null

no

regionName

false null

no

postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

false null

no

standalone

null

no

viewLinkName

null

Region Styles

Name

xml:lang

Description

Type

between outer and


inner repeating
containers.
Identifies the
optional
language contained
within this
component.

Defau Personaliz Translat


lt
able
able
Value

null

null

no

XML Attribute

xml:lang

27

OA Extension Component Reference

cellFormat

Description
The cellFormat region is used to format cells in a Row Layout region. The UIX UINode element
<uix:cellFormat> defines attributes such as columnSpan, rowSpan, hAlign, vAlign, height, width,
etc. cellFormat is a container of other layout elements which allow its contents to take additional
formatting such as width, colspan, or vertical alignment.
cellFormat extends the UIX counterpart <uix:cellFormat> and inherits all the attributes and the
named children. The only named child that <uix:cellFormat> supports is the standard contents
element for the indexed children.
Corresponding web bean: OACellFormatBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance
of an application
module.
Attribute
The attribute set for
Set
the component.
Child View The name of the
Attribute
child view attribute.
Child View Renders an instance
Instance
of the object for each
row in the View
Instance.
28

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomiz
able

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

no

childViewAttrNa
me
childViewUsage
Name

null

Region Styles

Name

Column
Span
Comments
Controller
Class
CSS Class
Document
Name
Document
ation
Comment
Extends

File
Version
Height
Horizontal
Alignment

ID
OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Description

The number of
columns spanned by
the cell.
Comments
The fully-qualified
class name for the
controller object.
Overrides the default
CSS class.
The name of the
component
Formatted text for
use with Javadoc.

A reference to
another component
that creates a
different instance of
that component at
runtime.
The version of the
file.
The display height in
pixels.
Horizontal alignment.
Acceptable values
are "center", "left",
"right", "start", and
"end".
The unique name of
this component.
The Oracle
Applications
Extension version
with which the file
was created or
updated.
The region label
used for
Personalization.
Indicates if rows
which are made dirty

Type

string

Defau Personaliz Translat XML Attribute


lt
able
able
Value
(if not null
no
columnSpan
set): 1

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

null

no

docName

from null
templ
ate
file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

null

null

no

file-version

string

null

null

no

height

string

null

null

no

hAlign

Name

null

null

no

id

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

jrad:refName null
string

29

OA Extension Component Reference

Name

Description

Type

only by the defaulting


of Initial Values are
to be posted.
Rendered Indicates if the
boolean
component is
rendered.
Row Span The number of rows string
spanned by the cell.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Vertical
Vertical aligmnet.
string
Alignment Acceptable values
are "middle", "top",
and "bottom".
View Link The name of the
string
Instance
View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
Width
Indicates the width in string
pixels or as a
percentage (if % sign
included).
xml:lang
Identifies the
optional
language contained
within this
component.

30

Defau Personaliz Translat XML Attribute


lt
able
able
Value

true

user

no

rendered

(if not null


set): 1
.
null

no

rowSpan

no

scope

stand null
ard

no

securityMode

null

null

no

vAlign

null

null

no

viewLinkName

null

null

no

width

null

null

no

xml:lang

Region Styles

31

OA Extension Component Reference

contentContainer

Description
The contentContainer region is used to place ancillary information on a page, offset by a certain
color.
contentContainer extends <uix:contentContainer> and inherits all the attributes and the named
children from it.
Corresponding web bean: OAContentContainerBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance
of an application
module.
Attribute
The attribute set for
Set
the component.
Backgroun The background
d Shade
shade of the content
container. It should
be one of "light",
"medium", "dark", or
"transparent".
Child View The name of the
Attribute
child view attribute.
32

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomiz
able

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
ui:background null
Type

null

no

use

null

no

background

string

null

no

childViewAttrNa
me

null

Region Styles

Name

Description

Child View Renders an instance


Instance
of the object for each
row in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the default
CSS class.
Document The name of the
Name
component
Document Formatted text for
ation
use with Javadoc.
Comment
Extends

File
Version
Icon URI
ID
OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Rendered

Type

string

Defau Personaliz Translat XML Attribute


lt
able
able
Value
null
null
no
childViewUsage
Name

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

null

no

docName

from null
templ
ate
file
jrad:compone null
null
ntRef

no

not applicable

no

extends

jrad:refName null
string

A reference to
another component
that creates a
different instance of
that component at
runtime.
The version of the
string
file.
the URI for the icon anyURI
file.
The unique name of Name
this component.
The Oracle
jrad:version
Applications
Extension version
with which the file
was created or
updated.
The region label
string
used for
Personalization.
Indicates if rows
boolean
which are made dirty
only by the defaulting
of Initial Values are
to be posted.
Indicates if the
boolean

null

null

no

file-version

null

admin

no

icon

null

null

no

id

null

null

no

version

null

null

no

regionName

false

null

no

postDefault

true

user

no

rendered
33

OA Extension Component Reference

Name

Scope

Security
Mode

Text
View Link
Instance

Width

xml:lang

34

Description

component is
rendered.
The Base Packages
which are allowed to
reuse this
component.
Defines the security
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
The text label for the
component.
The name of the
View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
Indicates the width in
pixels or as a
percentage (if % sign
included).
Identifies the
language contained
within this
component.

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

jrad:scope

null

no

scope

string

stand null
ard

no

securityMode

string

null

admin

no

text

string

null

null

no

viewLinkName

string

null

null

no

width

optional

null

null

no

xml:lang

Region Styles

contentFooter
Description
The contentFooter region is used to create a horizontal separator with a curved corner to
distinguish page level action/navigation buttons from the page content.
This component is always embedded directly inside the top level pageLayout component.
contentFooter extends <uix:contentFooter> and inherits all the attributes and the named
children from it.
Corresponding web bean: OAContentFooterBean
Note: contentFooter is deprecated as a style. You should use page buttons instead.

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance
of an application
module.
Attribute
The attribute set for
Set
the component.
Child View The name of the
Attribute
child view attribute.
Child View Renders an instance
Instance
of the object for each
row in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the default

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

boolean

true

admin

no

adminCustomiz
able

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNa
me
childViewUsage
Name

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass
35

OA Extension Component Reference

Name

Description

CSS class.
Document The name of the
Name
component
Document Formatted text for
ation
use with Javadoc.
Comment
Extends

File
Version
ID
OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Rendered

Scope

Security
Mode

36

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

jrad:refName null

null

no

docName

from null
templ
ate
file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

A reference to
another component
that creates a
different instance of
that component at
runtime.
The version of the
string
file.
The unique name of Name
this component.
The Oracle
jrad:version
Applications
Extension version
with which the file
was created or
updated.
The region label
string
used for
Personalization.
Indicates if rows
boolean
which are made dirty
only by the defaulting
of Initial Values are
to be posted.
Indicates if the
boolean
component is
rendered.
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Defines the security string
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to

null

null

no

file-version

null

null

no

id

null

null

no

version

null

null

no

regionName

false

null

no

postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

Region Styles

Name

Description

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value

handle security
validation. The legal
values are
standard, and selfS
ecured.
View Link
Instance

xml:lang

The name of the


string
View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
Identifies the
optional
language contained
within this
component.

null

null

no

viewLinkName

null

null

no

xml:lang

37

OA Extension Component Reference

defaultDoubleColumn
Description
The defaultDoubleColumn region lays out region items in two columns, first across then down.
The labels are aligned to the end and the input fields are aligned to the start. This is similar but
not identical to UIX's labeledFieldLayout. Since OADefaultDoubleColumnBean extends
OAHeaderBean, the defaultDoubleColumn element extends the header element.
defaultDoubleColumn extends header and inherits all the attributes and named children. See
the section on header for a list of attributes and child elements available on the header element.
Corresponding web bean: OADefaultDoubleColumnBean
Note: defaultDoubleColumn is deprecated as a style. You should use
messageComponentLayout instead.

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set for
Set
the component.
Child View The name of the
Attribute child view attribute.
Child View Renders an
Instance instance of the
object for each row
in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
38

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

Region Styles

Name

Description

CSS Class Overrides the


default CSS class.
Extends
A reference to
another component
that creates a
different instance of
that component at
runtime.
Help
The target name for
Target
the page online
help.
Help
This application will
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
Hide
Indicates if the
Header
region header is
rendered.
Icon URI the URI for the icon
file.
Personaliz The region label
ation Label used for
Personalization.
Post Initial Indicates if rows
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Record
Indicates if Record
History
History feature is
Enabled
enabled.
Rendered Indicates if the
component is
rendered.
Security
Defines the security
Mode
mode used to
secure the region. If

Type

string

Defau Personaliz Translat XML Attribute


lt
able
able
Value
null
admin
no
styleClass

jrad:compone null
ntRef

null

no

extends

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSho
rtName

boolean

false null

no

headerDisabled

anyURI

null

admin

no

icon

string

null

null

no

regionName

boolean

false null

no

postDefault

boolean

false admin

no

recordHistoryEnab
led

boolean

null

no

rendered

string

stand null
ard

no

securityMode

user

39

OA Extension Component Reference

Name

Description

Type

set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
Text
The text label for the string
component.
View Link The name of the
string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.

40

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

false null

no

standalone

null

admin

yes

text

null

null

no

viewLinkName

Region Styles

defaultFormStack
Description
The defaultFormStack region extends header and inherits all the attributes and named children.
See the section on header for a list of attributes and child elements available on the header
element.
Since OADefaultFormStackBean extends OAHeaderBean, defaultFormStack element extends
the header element.
Corresponding web bean: OADefaultFormStackBean
Note: defaultFormStack is deprecated as a style. You should use messageComponentLayout
instead.

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute
The attribute set for
Set
the component.
Child View The name of the
Attribute
child view attribute.
Child View Renders an
Instance instance of the
object for each row
in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true admin
no
adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

childViewAttrName

string

null

null

no

childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

41

OA Extension Component Reference

Name

CSS Class
Extends

Help
Target
Help
Target
Appl Short
Name

Icon URI
Personaliz
ation Label
Post Initial
Values

Record
History
Enabled
Rendered

Security
Mode

42

Description

controller object.
Overrides the
default CSS class.
A reference to
another component
that creates a
different instance of
that component at
runtime.
The target name for
the page online
help.
This application will
be used to
construct URI of
the "help" icon in
the global menu of
the page.This
makes the help
pages from the
other applications
referenceable.
the URI for the icon
file.
The region label
used for
Personalization.
Indicates if rows
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if Record
History feature is
enabled.
Indicates if the
component is
rendered.
Defines the security
mode used to
secure the region.
If set to
selfSecured it is the

Type

string

Defau Personaliz Translat


lt
able
able
Value
null

XML Attribute

admin

no

styleClass

jrad:compone null
ntRef

null

no

extends

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSho
rtName

anyURI

null

admin

no

icon

string

null

null

no

regionName

boolean

false null

no

postDefault

boolean

false admin

no

recordHistoryEnab
led

boolean

true

no

rendered

string

stand null
ard

no

securityMode

user

Region Styles

Name

Description

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

developer's
responsibility to
handle security
validation. The
legal values are
standard, and self
Secure.
Standalon Indicates if this
boolean
e
region can be
rendered on its
own.
Text
The text label for
string
the component.
View Link The name of the
string
Instance View Link Instance
establishing
master-detail
relationship
between outer and
inner repeating
containers.

false null

no

standalone

null

admin

yes

text

null

null

no

viewLinkName

43

OA Extension Component Reference

defaultSingleColumn
Description
The defaultSingleColumn region lays out region items in one column. The labels are aligned to
the end and the input fields are aligned to the start. This is similar, but not identical, to UIX's
labeledFieldLayout.
defaultSingleColumn extends header and inherits all the attributes and named children. See the
section on header for a list of attributes and child elements available on the header element.
Corresponding web bean: OADefaultSingleColumnBean

Note: defaultSingleColumn is deprecated as a style. You should use messageComponentLayout


instead.

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set for
Set
the component.
Child View The name of the
Attribute child view attribute.
Child View Renders an
Instance instance of the
object for each row
in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
44

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true admin
no
adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

Region Styles

Name

Extends

Help
Target
Help
Target
Appl Short
Name

Hide
Header
Icon URI
Personaliz
ation Label
Post Initial
Values

Record
History
Enabled
Rendered

Security
Mode

Description

default CSS class.


A reference to
another component
that creates a
different instance of
that component at
runtime.
The target name for
the page online
help.
This application will
be used to construct
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
Indicates if the
region header is
rendered.
The URI for the icon
file.
The region label
used for
Personalization.
Indicates if rows
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if Record
History feature is
enabled.
Indicates if the
component is
rendered.
Defines the security
mode used to
secure the region. If
set to selfSecured it

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

jrad:compone null
ntRef

null

no

extends

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSho
rtName

boolean

false null

no

headerDisabled

string

null

admin

no

icon

string

null

null

no

regionName

boolean

false null

no

postDefault

boolean

false admin

no

recordHistoryEnab
led

boolean

true

no

rendered

string

stand null
ard

no

securityMode

user

45

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
Text
The text label for the string
component.
View Link The name of the
string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.

46

false null

no

standalone

null

admin

yes

text

null

null

no

viewLinkName

Region Styles

defaultStack
Description
The defaultStack region extends header and inherits all the attributes and named children. See
the section on header for a list of attributes and child elements available on the header element.
Corresponding web bean: OADefaultStackLayoutBean

Note: defaultStack is deprecated as a style. You should use messageComponentLayout instead.

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set for
Set
the component.
Child View The name of the
Attribute child view attribute.
Child View Renders an
Instance instance of the
object for each row
in the View
Instance.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Document Formatted text for
ation
use with Javadoc.
Comment

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

string

from null
templ
ate
file

no

not applicable

47

OA Extension Component Reference

Name

Extends

Help
Target
Help
Target
Appl Short
Name

Icon URI
Personaliz
ation Label
Post Initial
Values

Record
History
Enabled
Rendered

Security
Mode

48

Description

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value
A reference to
jrad:compone null
null
no
extends
another component ntRef
that creates a
different instance of
that component at
runtime.
The target name for string
null
null
no
helpTarget
the page online
help.
This application will string
null
null
no
helpTargetAppSho
be used to construct
rtName
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
The URI for the icon string
null
admin
no
icon
file.
The region label
string
null
null
no
regionName
used for
Personalization.
Indicates if rows
boolean
false null
no
postDefault
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if Record boolean
false admin
no
recordHistoryEnab
History feature is
led
enabled.
Indicates if the
boolean
true user
no
rendered
component is
rendered.
Defines the security string
stand null
no
securityMode
mode used to
ard
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are

Region Styles

Name

Description

Type

standard, and selfS


ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
Text
The text label for the string
component.
View Link The name of the
string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

false null

no

standalone

null

admin

yes

text

null

null

no

viewLinkName

49

OA Extension Component Reference

flexibleContent
Description
The flexibleContent region is used to identify content that can be placed in a flexibleLayout
region. The content can also be specified by referring to it. It represents available content which
may or may not be made use of; and thus acts as a resource to the page designer.
Corresponding web bean: OAFlexibleContentBean

Properties
Name

Description

Type

Admin
Indicates the
string
Operations personalization
operations an
administrator
can perform on
the component
if Admin
Personalization
is set to True.
The legal values
are: null and
remove. If set to
remove, an
Administrator
can remove
flexibleContent
so that it does
not render on
the page, when
personalizing
the page. If set
to null, no
flexibleContent
can be
removed.
Admin
Indicates if an boolean
Personalizat Administrator
ion
can personalize
this component.
AM
The fullystring
Definition
qualified class
name for the
50

Defaul Personaliza Translata XML Attribute


t
ble
ble
Value
remov null
e

no

adminOperation
s

true

null

no

adminCustomiza
ble

null

null

no

amDefName

Region Styles

application
module.
AM Instance The instance
string
name of an
application
module.
Attribute Set The attribute set jrad:attributeSe
for the
tRef
component.
Comments Comments
string
Description A short
string
description of
the items
contained in the
element. This
attribute is
translatable and
will be
listed/used in
Resource
Catalog. A
search based
on description
may be
performed by
the user.
Disclosed The initial
boolean
disclosure state.
When notdisclosed, only
an outline of the
component is
shown along
with an icon to
restore to the
disclosed state.
Document The name of the jrad:refName
Name
component
Documentat Formatted text string
ion
for use with
Comment Javadoc.
Extends
A reference to jrad:component
another
Ref
component that
creates a
different
instance of that
component at

null

null

no

amUsageName

null

null

no

use

null
null

null
admin

no
true

comment
description

true

null

no

disclosed

null

null

no

docName

from null
templa
te file
null
null

no

not applicable

no

extends

51

OA Extension Component Reference

Flexible
Layout
Reference

ID

Rendered

Show
Border

Show
Header
Title

52

runtime.
A reference to
the
oa:flexibleLayou
t that the
flexibleContent
will be rendered
in. No value
indicates that
the
flexibleContent
will not be
rendered
anywhere in the
page even if
rendered="true"
is set. The
difference
between
rendered="false
" and
flexibleLayoutR
ef="" is that
flexibleContent(
s) with
flexibleLayoutR
ef="" will only
be listed in the
catalog as
content that can
be added.
Inherited from
<uix:base>. The
page-wide
unique client ID
of this node.
Whether the
flexibleContent
is rendered.
Whether the
border around
the layout is
shown.
Whether the
header of this
layout is shown.
The title to
display above
the flexible

string

null

null

no

flexibleLayoutRe
f

Name

null

null

no

id

boolean

true

admin

no

rendered

boolean

false

null

no

showBorder

boolean

true

null

no

showHeader

string

null

null

no

title

Region Styles

content.
User
Indicates the
string
Operations personalization
operations a
user can
perform on the
component, if
User
Personalization
is set to True.
The legal values
are: (Default)
and disclose. If
set to (Default),
the
collapse/disclos
e operation
cannot be
performed by
the user on this
flexibleContent.
If set to
disclose, the
user can either
disclose or
collapse the
flexibleContent
region in the
rendered page.
User
Indicates if a
boolean
Personalizat user can
ion
personalize this
component.
View
Specifies ID of string
Source
the region
Region ID (within the
flexibleContent)
on which
personalization
views have
been defined.
View Target Specifies ID of string
Region ID the region on
which the
personalization
view should be
applied.

null

user

no

userOperations

true

user

no

userCustomizabl
e

null

null

no

viewSourceRegi
onId

null

null

no

viewTargetRegi
onId

53

OA Extension Component Reference

flexibleLayout
Description
The flexibleLayout region is used to define a customizable layout, separate from content, where
content will be placed. flexibleLayout regions can be nested to form a customizable layout and
can be positioned anywhere in the page. A page can have a number of 'top-level'
flexibleLayouts; they do not have to be nested.
Corresponding web bean: OAFlexibleLayoutBean

Properties
Name

Description

Type

Admin
Indicates the
string
Operations personalization
operations an
administrator can
perform on the
component if
Admin
Personalization is
set to True. The
legal values
are: null and add.
If set to add, an
Administrator can
add predefined
flexibleContent to
the flexibleLayout
region when
personalizing the
page. If set to
null, no flexible
content can be
added to this
flexible
layout during
personalization.
Admin
Indicates if an
boolean
Personalizat Administrator can
ion
personalize this
component.
54

Defaul Personaliza Translata XML Attribute


t
ble
ble
Value
add

null

no

adminOperatio
ns

true

null

no

adminCustomiz
able

Region Styles

AM
Definition

The fully-qualified string


class name for
the application
module.
AM
The instance
string
Instance
name of an
application
module.
Attribute Set The attribute set jrad:attributeSe
for the
tRef
component.
Columns
The number of
string
columns the
flexibleLayout will
have. Use
layoutStyle=horiz
ontal to
horizontally
layout the
contents.
Comments Comments
string
Disclosed The initial
boolean
disclosure state.
When notdisclosed, only
an outline of the
component is
shown along with
an icon to restore
to the disclosed
state.
Document The name of the jrad:refName
Name
component
Documentat Formatted text for string
ion
use with
Comment Javadoc.
Extends
A reference to
jrad:component
another
Ref
component that
creates a
different instance
of that
component at
runtime.
Height
The pixels or
string
percentage 'hint'
to the browser for
the

null

null

no

amDefName

null

null

no

amUsageName

null

null

no

use

null

no

columns

null
true

null
null

no
no

comment
disclosed

null

null

no

docName

from null
templa
te file
null
null

no

not applicable

no

extends

null

no

height

null

55

OA Extension Component Reference

flexibleLayout.
ID
Inherited from
Name
<uix:base>. The
page-wide unique
client ID of this
node.
Layout Style The Content
string
layout style. The
legal values are
vertical, and
horizontal. If
vertical, contents
will be laid out
vertically. If
"horizontal"
contents will be
laid out
horizontally.
Rendered Whether the
boolean
flexibleLayout is
rendered.
Rows
The number of
string
rows the
flexibleLayout will
have. Use
layoutStyle=vertic
al to vertically lay
out the contents.
Show
Whether the
boolean
Border
border around
the layout is
shown.
Show
Whether the
boolean
Header
header of this
layout is shown.
Title
The title to
string
display above the
flexible layout.
User
Indicates the
string
Operations personalization
operations a
user can perform
on the
component, if
User
Personalization is
set to True. The
legal values
56

null

null

no

id

vertica null
l

no

layoutStyle

true

admin

no

rendered

null

no

rows

false

null

no

showBorder

false

null

no

showHeader

null

null

no

title

null

user

no

userOperations

Region Styles

are: (Default) and


disclose. If set to
(Default), the
collapse/disclose
operation cannot
be performed by
the user on this
flexible layout. If
set to disclose,
the user can
either disclose or
collapse the
flexibleLayout
region in the
rendered page.
User
Indicates if a user boolean
Personalizat can personalize
ion
this component.
Width
Provides a width string
hint to the
browser.

true

user

no

userCustomiza
ble

null

admin

no

width

57

OA Extension Component Reference

flowLayout
Description
The flowLayout region lays out its indexed children horizontally, wrapping as needed. Each pair
of adjacent children will be separated by an optional separator child.
When a flowLayout region is created under a footer named child of a messageComponent
region, the flowLayout region can only include button and spacer items.
Corresponding web bean: OAFlowLayoutBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added to
this UI node tree.
Admin
Indicates if an
Personali Administrator can
zation
personalize this
component.
AM
The fully-qualified class
Definition name for the application
module.
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Child
The name of the child
View
view attribute. Valid only
Attribute when used in table
region.
Child
Renders an instance of
View
the object for each row in
Instance the View Instance. Valid
only when used in table
region.
Comment Comments
58

Type

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomiza
ble

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attribute null
SetRef
string
null

null

no

use

null

no

childViewAttrNa
me

string

null

null

no

childViewUsage
Name

string

null

null

no

comment

Region Styles

Name

Description

s
Controller The fully-qualified class
Class
name for the controller
object.
CSS
Overrides the default
Class
CSS class.
Document The name of the
Name
component
Document Formatted text for use
ation
with Javadoc.
Comment
Extends

File
Version
Help
Target
Help
Target
Appl
Short
Name

ID
Initial Sort
Sequence

No Wrap

OA
Extension
Version

Type

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e

string

null

admin

no

controllerClass

string

null

admin

no

styleClass

jrad:refNam null null


e
string
from null
templ
ate
file
A reference to another
jrad:compon null null
component that creates a entRef
different instance of that
component at runtime.
The version of the file.
string
null null

no

docName

no

not applicable

no

extends

no

file-version

The target name for the


page online help.
This application will be
used to construct URI of
the "help" icon in the
global menu of the
page.This makes the help
pages from the other
applications
referenceable.
The unique name of this
component.
Indicates the initial sort
sequence for each
search. The legal values
are
none, first, second, and
third.
Indicates if cell contents
should be wrapped. Valid
only when used in table
region.
The Oracle Applications
Extension version with
which the file was created

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppS
hortName

Name

null

null

no

id

string

none null

no

initSortSeq

boolean

false null

no

cellNoWrapForm
at

no

version

jrad:version null

null

59

OA Extension Component Reference

Name

Description

Type

or updated.
Personali The region label used for string
zation
Personalization.
Label
Post
Indicates if rows which
boolean
Initial
are made dirty only by the
Values
defaulting of Initial Values
are to be posted.
Prompt
The text label for the
string
component.
Rendered Indicates if the
boolean
component is rendered.
Scope
The Base Packages
jrad:scope
which are allowed to
reuse this component.
Security Defines the security mode string
Mode
used to secure the region.
If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecur
ed.
Sort
Allowed

Indicates if the user can string


sort this column. Valid
only when used in table
region. The legal values
are
yes, no, ascending, and
descending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting. Valid only
when used in table
region.
Standalon Indicates if this region can boolean
e
be rendered on its own.
User
Indicates if a user can
boolean
Personali personalize this
zation
component. Valid only
when used in table
region.
60

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
null

null

no

regionName

false null

no

postDefault

null

admin

true

prompt

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

no

admin

no

sortState

null

user

no

sortByViewAttr

false null

no

standalone

false admin

no

userCustomizabl
e

Region Styles

Name

xml:lang

Description

Identifies the language


contained within this
component.

Type

optional

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
null

null

no

xml:lang

61

OA Extension Component Reference

footer
Description
The footer region is designed to contain the copyright, privacy information, and any other
content that should be at the bottom of the page.
footer extends <uix:footer> and inherits all the attributes and the named children defined for it.
This element is embedded directly in a pageLayout element.
Corresponding web bean: OAFooterBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name of
Instance
an application
module.
Attribute
The attribute set for
Set
the component.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the default
CSS class.
Document The name of the
Name
component
Documenta Formatted text for
tion
use with Javadoc.
Comment
Extends
A reference to
another component
that creates a
different instance of
that component at
62

Type

boolean

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
true admin
no
adminCustomi
zable

string

null

null

no

amDefName

string

null

null

no

amUsageNam
e

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

jrad:refName

null

null

no

docName

from null
templ
ate file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

Region Styles

Name

Description

runtime.
File
The version of the
Version
file.
ID
The unique name of
this component.
OA
The Oracle
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label used
ation Label for Personalization.
Post Initial Indicates if rows
Values
which are made dirty
only by the defaulting
of Initial Values are to
be posted.
Rendered Indicates if the
component is
rendered.
Scope
The Base Packages
which are allowed to
reuse this
component.
Security
Defines the security
Mode
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
xml:lang
Identifies the
language contained
within this
component.

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value

string

null

null

no

file-version

Name

null

null

no

id

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

stand null
ard

no

securityMode

optional

null

no

xml:lang

null

Element Children

63

OA Extension Component Reference

Name
copyright
privacy

64

Quantity
0 through 1
0 through 1

Description
Node to use as a copyright statement.
Node to use as a privacy statement.

Region Styles

Gantt
Description
The Gantt region can be used to create a Gantt chart that retrieves data from BC4J objects.
Gantt charts are used for visualizing project planning and scheduling information; The Gantt
style is used for rendering Gantt charts within a web application.
oa:gantt extends oa:hGrid and inherits all the properties from it; note that the Width property in
HGrid cannot be set in Gantt. Please refer to the HGrid section for more information on all HGrid
properties.
Corresponding web bean: OAGanttBean

Properties

Name

Actual
End
Date
View
Attribute
Actual
Start
Date
View
Attribute
Addition
al Text
Admin
Personal
ization
AM
Definitio
n
AM
Instance
Attribute
Set

Description

Type

Defa Personal Transla XML Attribute


ult
izable
table
Valu
e

The view attribute for the actual string


end date of the task for the
Variance bar Type.

null

null

no

actualFinishVie
wAttr

The view attribute for the actual string


start date of the task for the
Variance bar Type.

null

null

no

actualStartView
Attr

Additional help text.

string

null

admin

yes

shortDesc

Indicates if an Administrator
can personalize this
component.
The fully-qualified class name
for the application module.

boolean

true admin

no

adminCustomiz
able

string

null

null

no

amDefName

The instance name of an


application module.
The attribute set for the
component.

string

null

null

no

amUsageName

jrad:attribut null
eSetRef

null

no

use
65

OA Extension Component Reference

Auto
Scale

Indicates if the Gantt chart will


scale the axis units depending
on the time-period specified.
Axis End The view attribute for the end
Date
date of the Gantt chart
View
horizontal axis.
Attribute
Axis
The major unit of time for the
Major
Gantt chart horizontal axis. The
Scale
legal values are
years, halfyears, quarters, mont
hs, weeks, and days.
Axis
The minor unit of time for the
Minor
Gantt chart horizontal axis. The
Scale
legal values are
years, halfyears, quarters, mont
hs, weeks, and days.
Axis
The view attribute for the start
Start
date of the Gantt chart
Date
horizontal axis.
View
Attribute
Bar Type The view attribute indicating the
View
bar type.
Attribute
Baseline The view attribute for the
End
baseline end date of the task
Date
for the Variance Bar Type.
View
Attribute
Baseline The view attribute for the
Start
baseline start date of the task
Date
for the Variance bar Type.
View
Attribute
Commen Comments
ts
Complet The view attribute for the
ed
current 'completed through'
Through date of the task.
View
Attribute
Controlle The fully-qualified class name
r Class for the controller object.
CSS
Overrides the default CSS
Class
class.
Disable Indicates if validation should
66

boolean

true user

no

autoScale

string

null

no

endTimeViewAtt
r

string

mont user
hs

no

majorScale

string

week user
s

no

minorScale

string

null

null

no

startTimeViewAt
tr

string

null

null

no

barTypeViewAtt
r

string

null

null

no

baseFinishView
Attr

string

null

null

no

baseStartViewA
ttr

string

null

null

no

comment

string

null

null

no

completedThrou
ghViewAttr

string

null

admin

no

controllerClass

string

null

admin

no

styleClass

boolean

false null

no

unvalidated

null

Region Styles

Client
not occur on the web tier during
Side
a form submit.
Validatio
n
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Help
The target name for the page
Target online help.
Help
This application will be used to
Target construct URI of the "help" icon
Appl
in the global menu of the
Short
page.This makes the help
Name
pages from the other
applications referenceable.
Left Text The view attribute for the text
View
label to the left of the task.
Attribute
Percent The view attribute for the
Complet completion percentage of the
e View task.
Attrbute
Personal The region label used for
ization Personalization.
Label
Post
Indicates if rows which are
Initial
made dirty only by the
Values defaulting of Initial Values are
to be posted.
Predece Accessor Name for the
ssor
predecessor's rowset for the
Accessor current task.
Predece View Attribute Name for the
ssor
predecessor task ID.
View
Attribute
Record The maximum number of
Set Size records that can be displayed
under each node.
Render Indicates if the description
Descripti columns should always be
on
rendered.
Columns
Rendere Indicates if the component is
d
rendered.
Right
The view attribute for the text

jrad:compo null
nentRef

null

no

extends

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppS
hortName

string

null

null

no

leftTextViewAttr

string

null

null

no

percentComplet
eViewAttr

string

null

null

no

regionName

boolean

false null

no

postDefault

string

null

null

no

predecessorAcc
essor

string

null

null

no

predecessorVie
wAttr

string

null

null

no

childBlockSize

boolean

true user

no

descChildrenVis

boolean

true user

no

rendered

string

null

no

rightTextViewAtt

null

67

OA Extension Component Reference

Text
View
Attribute
Search
Controlle
r Class

label to the right of the task.

The fully-qualified class name


for the controller object
associated with the search
results table.
The view usage to be used for
running queries on the hGrid.

Search
View
Usage
Security Defines the security mode used
Mode
to secure the region. If set to
selfSecured it is the developer's
responsibility to handle security
validation. The legal values are
standard, and selfSecured.
Show
Indicates if Bubble Text will be
Bubble shown for the task.
Text
Show
Indicates if a line is drawn to
Current indicate the current date.
Date
Show
Indicates if dependency lines
Depende are visible.
ncy
Lines
Standalo Indicates if this region can be
ne
rendered on its own.
Task
The view attribute for the end
End
date of the task.
Date
View
Attribute
Task ID View Attribute Name for the
View
unique task ID.
Attribute
Task
The view attribute for the start
Start
date of the task.
Date
View
Attribute
User
Indicates if a user can
Personal personalize this component.
ization
View
The name of the view object
Instance instance.
Name
68

string

null

admin

no

searchControlle
rClass

string

null

null

no

searchViewNam
e

string

stan null
dard

no

securityMode

boolean

true user

no

showTooltip

boolean

true user

no

showCurrentDat
e

boolean

false user

no

showDependen
cyLines

boolean

false null

no

standalone

string

null

null

no

barFinishViewAt
tr

string

null

null

no

taskIdViewAttr

string

null

null

no

barStartViewAttr

boolean

false admin

no

userCustomizab
le

string

null

no

viewName

null

Region Styles

Element Children
Name

Quantity

Description

descriptionColumns 0 through 1 Description columns.


tableActions
0 through 1 Component used for performing table actions that are
independent of row selection.
tableSelection
0 through 1 SingleSelectionBean or MultipleSelectionBean to render with
the table.
viewInHierarchy
0 through 1 Column stamp for the 'View In Hierarchy' column in the search
results table.

69

OA Extension Component Reference

graphTable
Description
The graphTable region is used to layout graphs that are essentially BI Beans and a UIX table by
extending tableLayout. So, graphTable inherits all the attributes and children from tableLayout.
See the section on tableLayout for a list of attributes and child elements available on the
tableLayout element.
graphTable contains two grouping elements called graphs and tabularFormat. The graphs
grouping contains one or more graph elements. The tabularFormat grouping contains a table.
Corresponding web bean: OAGraphTableBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Comments
Controller
Class
CSS Class

70

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name
of an application
module.
The attribute set for
the component.
Comments
The fully-qualified
class name for the
controller object.
Overrides the
default CSS class.

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true null
no
addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

admin

no

styleClass

null

Region Styles

Extends

Graph
Render
Style

Graphs
per Row
Help
Target
Help
Target
Appl Short
Name

Personaliz
ation Label
Post Initial
Values

Rendered

Security
Mode

A reference to
another component
that creates a
different instance of
that component at
runtime.
Indicates which
components of the
graph are rendered.
The legal values are
both, and graph.
Number of graphs to
be displayed on
each row.
The target name for
the page online
help.
This application will
be used to construct
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
The region label
used for
Personalization.
Indicates if rows
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if the
component is
rendered.
Defines the security
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are

jrad:compone null
ntRef

null

no

extends

string

graph null

no

renderStyle

unsignedInt

null

null

no

graphsPerRow

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSho
rtName

string

null

null

no

regionName

boolean

false null

no

postDefault

boolean

true

no

rendered

string

stand null
ard

no

securityMode

user

71

OA Extension Component Reference

standard, and selfS


ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
View Link The name of the
string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.

false null

no

standalone

null

no

viewLinkName

null

Element Children
Name
graphs
tabularFormat

Quantity
1
0 through 1

Description
Graphs based on the table.
Table for graphs are to be rendered.

graph
Name

Description

Aggrega The aggregate function to


te
apply to the data. The legal
Function values are
sum, avg, max, min, and no
ne.
Allow
Indicates if a combination
Combin graph is allowed.
ation
Graph
AM
The fully-qualified class
Definitio name for the application
n
module.
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Comme Comments
nts
CSS
Overrides the default CSS
72

Type

Defau Personali Translat


lt
zable
able
Value

XML
Attribute

string

none admin

no

aggregateFun
ction

boolean

false user

no

combo

string

null

null

no

amDefName

string

null

null

no

jrad:attribute null
SetRef
string
null

null

no

amUsageNam
e
use

null

no

comment

string

admin

no

styleClass

null

Region Styles

Class
class.
Data
The Data Axis label for the
Axis
graph.
Label
Data
Determines whether the
Axis
lower limit for Data Axis is
scale
zero or the lowest data
from
value.
zero
Destinati The Destination URI.
on URI
Display Indicates if Bubble Text is
Data
displayed for the Data
Bubble Points.
Text
Display Indicates if the data markers
Data
should be plotted.
Markers
Display Indicates if this graph has a
Second secondary Y-axis.
ary YAxis
Docume The name of the component
nt Name
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Graph The type of the graph. The
Type
legal values are absolute
area, absolute line,
horizontal clustered bar,
horizontal percent bar,
horizontal stacked bar,
percent area, percent line,
pie, point, scatter, stacked
area, stacked line, vertical
clustered bar, vertical highlow-close stock, vertical
percent bar, and vertical
stacked bar.
Height Graph's height in pixels,
applicable only if
size="custom".
Rendere Indicates if the component
d
is rendered.
Scope The Base Packages which

string

null

admin

true

yAxisLabel

boolean

true

admin

no

yAxisScaleFro
mZero

string

null

null

no

drillDownUrl

boolean

true

null

no

displayBubble
Text

boolean

false admin

no

displayDataM
arkers

boolean

false user

no

dualYAxis

jrad:refName null

null

no

docName

jrad:compon null
entRef

null

no

extends

string

vertic admin
al
cluste
red
bar

no

graphType

string

null

null

no

height

boolean

true

user

no

rendered

jrad:scope

null

no

scope
73

OA Extension Component Reference

are allowed to reuse this


component.
Second The label for the secondary string
ary Data data axis.
Axis
Label
Size
The size of the graph. The string
legal values are verysmall, small, medium, large,
and custom.
Title
The title of the graph.
string
Width
Graph's width in pixels,
string
applicable only if
size="custom".
X-Axis The X-Axis label for the
string
Label
graph.
xml:lang Identifies the language
optional
contained within this
component.

null

user

true

secYAxisLabe
l

small user

no

size

null
null

admin
null

true
no

title
width

null

admin

true

xAxisLabel

null

null

no

xml:lang

Element Children
Name
dataMap

Quantity
1

Description
Lists a bunch of graphData elements.

graphData
Name

Attribute
Set
Combina
tion
Graph
Type
Commen
ts
Prompt

Description

The attribute set for the


component.
The type of graph for a
combination graph. The
legal values are
bar, line, area, and none.
Comments.

Prompt to be used in
legend label. Used only
when style='data'.
Purpose Specifies the purpose of
in Graph the graph data element.
The legal values are
74

Type

Defa Personaliz Translat


ult
able
able
Valu
e

XML
Attribute

jrad:attributeS null null


etRef
string
none null

no

use

no

comboGraph
Type

string

null

null

no

comment

string

null

admin

true

prompt

string

data null

no

graphAs

Region Styles

data, groupLabels, and seri


esLabels.
Seconda Indicates if this graphData
ry Axis is plotted on the secondary
axis.
Stock
The Stock Type Value to
Value
use for the graph. The
Type
legal values are
high, low, close, and none.
View
The name of the view
Attribute attribute.
View
The name of the view
Instance object instance.

boolean

false user

no

assignedToY
2

string

none null

no

stockValue

string

null

null

no

viewAttr

string

null

null

no

viewName

75

OA Extension Component Reference

header
Description
The header region places a label and optional icon at the top of a section. This control can be
used to provide important messaging information. The types of messages are: Error,
Information, Warning, and Confirmation.
header extends <uix:header> and inherits all the attributes and named children defined for it.
This element does not support the "styleClass" attribute.
Corresponding web bean: OAHeaderBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Child View
Attribute
Child View
Instance

Comments
Controller
76

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name
of an application
module.
The attribute set for
the component.
The name of the
child view attribute.
Renders an
instance of the
object for each row
in the View
Instance.
Comments
The fully-qualified

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

Region Styles

Name

Description

class name for the


controller object.
CSS Class Overrides the
default CSS class.
Document The name of the
Name
component
Document Formatted text for
ation
use with Javadoc.
Comment

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

Class

Extends

File
Version
Help
Target
Help
Target
Appl Short
Name

Icon URI
ID
OA
Extension
Version

Personaliz
ation Label

string

null

jrad:refName null
string

admin

no

styleClass

null

no

docName

no

not applicable

no

extends

no

file-version

no

helpTarget

no

helpTargetAppSho
rtName

no

icon

no

id

no

version

no

regionName

from null
templ
ate
file
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
The version of the string
null
null
file.
The target name for string
null
null
the page online
help.
This application will string
null
null
be used to construct
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
The URI for the icon string
null
admin
file.
The unique name of Name
null
null
this component.
The Oracle
jrad:version null
null
Applications
Extension version
with which the file
was created or
updated.
The region label
string
null
null
used for
Personalization.

77

OA Extension Component Reference

Name

Description

Type

Post Initial Indicates if rows


boolean
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Record
Indicates if Record boolean
History
History feature is
Enabled
enabled.
Rendered Indicates if the
boolean
component is
rendered.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Standalon Indicates if this
e
region can be
rendered on its own.
Text
The text label for the
component.
View Link The name of the
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
xml:lang Identifies the
language contained
within this
component.

78

Defau Personaliz Translat XML Attribute


lt
able
able
Value
false null
no
postDefault

false admin

no

recordHistoryEnab
led

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

boolean

false null

no

standalone

string

null

admin

yes

text

string

null

null

no

viewLinkName

optional

null

null

no

xml:lang

Region Styles

79

OA Extension Component Reference

HGrid
Description
The HGrid region can be used to display tree structured data, in a format similar to a table
element. Unlike the TreeBean, the HGridBean is suitable for use with massive trees, since it
supports focusing in and out of subtrees.
The HGrid region is used to display objects in a hierarchical format, much like the Tree region.
HGrid renders like a Table; each row corresponds to a tree node. It has two special columns:
the focus column and the object hierarchy column. The object hierarchy column identifies the
current tree node and allows the user to expand (view the children of) or collapse (hide the
children of) this node. The focus column is used to select a new root for the tree. This allows
users to zoom into subtrees of a massive tree. The HGrid element renders bread crumbs to
allow the user to focus out (or zoom out) of the current subtree. HGrid also renders links to allow
the user to quickly expand or collapse all the nodes under the current focus root.
Corresponding web bean: OAHGridBean

Properties
Name

Additional
Text
Admin
Personaliz
ation

Description

Additional help text. string

Indicates if an
Administrator can
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set for
Set
the component.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Disable
Indicates if
80

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value
null
admin
yes
shortDesc

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

boolean

false null

no

unvalidated

Region Styles

Client Side validation should not


Validation occur on the web
tier during a form
submit.
Document The name of the
jrad:refName null
Name
component
Document Formatted text for
string
from
ation
use with Javadoc.
templ
Comment
ate
file
Enable
Enable columns to boolean
true
Column
be hidden/shown by
Hide Show end users.
Enable
Enable columns to boolean
true
Column
be reordered by end
Reorder
users.
Enable
Enable columns to boolean
true
Column
be resized by end
Resize
users.
Enable
Enable horizontal
boolean
true
Horizontal scroll bars.
Scroll
Extends
A reference to
jrad:compone null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
Version
file.
Help
The target name for string
null
Target
the page online
help.
Help
This application will string
null
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
ID
Maps to the Item
Name
null
Name property of
the nested region
that points to the

null

no

docName

null

no

not applicable

admin

no

columnHideShow
Enabled

admin

no

colReorderEnable
d

admin

no

colResizeEnabled

admin

no

horizontalScrollEn
abled

null

no

extends

null

no

file-version

null

no

helpTarget

null

no

helpTargetAppSho
rtName

null

no

id

81

OA Extension Component Reference

OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Record
Set Size

Rendered

Scope

Search
Controller
Class

Search
View
Usage
Security
Mode

82

HGrid region.
The Oracle
jrad:version
Applications
Extension version
with which the file
was created or
updated.
The region label
string
used for
Personalization.
Indicates if rows
boolean
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
The maximum
string
number of records
that can be
displayed under
each node.
Indicates if the
boolean
component is
rendered.
The Base Packages jrad:scope
which are allowed to
reuse this
component.
The fully-qualified
string
class name for the
controller object
associated with the
search results table.
The view usage to string
be used for running
queries on the
hGrid.
Defines the security string
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.

null

null

no

version

null

null

no

regionName

false null

no

postDefault

null

null

no

childBlockSize

true

user

no

rendered

null

no

scope

null

admin

no

searchControllerCl
ass

null

null

no

searchViewName

stand null
ard

no

securityMode

Region Styles

Standalon Indicates if this


e
region can be
rendered on its own.
User
Indicates if a user
Personaliz can personalize this
ation
component.
Width
Indicates the width
in pixels or as a
percentage (if %
sign included).
xml:lang Identifies the
language contained
within this
component.

boolean

false null

no

standalone

boolean

false admin

no

userCustomizable

string

null

null

no

width

optional

null

null

no

xml:lang

Element Children
Name

Quantity

Description

tableActions

0 through 1 Component used for performing table actions that are independent
of row selection.
tableSelection 0 through 1 SingleSelectionBean or MultipleSelectionBean to render with the
table.
viewInHierarchy 0 through 1 Column stamp for the 'View In Hierarchy' column in the search
results table.

83

OA Extension Component Reference

hideShow
Description
The hideShow region provides a means of toggling a group of UINodes between being
disclosed or undisclosed. A hideShow element should be used to:

hide or show an entire section or a part of a section of information within the contents of
a page such as:
o show more information/hide more information,
o show details/hide details,
o show "section name"/hide "section name",
o show graph/hide graph, etc.
hide or show functionality such as simple/advance search
hide or show details of a table row

hideShow extends <uix:hideShow> and inherits all the attributes and children.
Corresponding web bean: OADefaultHideShowBean

Properties
Name

Add
Indexed
Children

Description

Type

Indicates if indexed
boolean
children will be
automatically added to
this UI node tree.
Additional Additional help text. Note: string
Text
If a hideShow region is
created under
advancedTable then the
Additional Text property is
not displayed.
Admin
Indicates if an
boolean
Personali Administrator can
zation
personalize this
component.
AM
The fully-qualified class string
Definition name for the application
module.
AM
The instance name of an string
84

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
true

null

no

addChildren

null

admin

yes

shortDesc

true

admin

no

adminCustomiza
ble

null

null

no

amDefName

null

null

no

amUsageName

Region Styles

Name

Instance
Attribute
Set
Comment
s
Controller
Class

Description

application module.
The attribute set for the
component.
Comments

File
Version
Help
Target
Help
Target
Appl
Short
Name

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e

jrad:attribute null
SetRef
string
null

null

no

use

null

no

comment

string

null

admin

no

controllerClass

string

null

admin

no

styleClass

boolean

false null

no

unvalidated

boolean

false null

no

serverUnvalidate
d

string

null

no

disclosedText

boolean

false user

no

disclosed

jrad:refNam null null


e
string
from null
templ
ate
file
A reference to another
jrad:compon null null
component that creates a entRef
different instance of that
component at runtime.
The version of the file.
string
null null

no

docName

no

not applicable

no

extends

no

file-version

The target name for the string


page online help.
This application will be
string
used to construct URI of
the "help" icon in the
global menu of the
page.This makes the help
pages from the other

The fully-qualified class


name for the controller
object.
CSS
Overrides the default
Class
CSS class.
Disable Indicates if validation
Client
should not occur on the
Side
web tier during a form
Validation submit.
Disable Indicates if validation
Server
should not occur on the
Side
business tier during a
Validation form submit.
Disclosed The text to display when
Text
the children are shown.
Disclosed The initial disclosure
state.
Document The name of the
Name
component
Document Formatted text for use
ation
with Javadoc.
Comment
Extends

Type

admin

null

null

no

helpTarget

null

null

no

helpTargetAppS
hortName

85

OA Extension Component Reference

Name

ID
Initial Sort
Sequence

OA
Extension
Version

Description

applications
referenceable.
The unique name of this
component.
Indicates the initial sort
sequence for each
search. The legal values
are
none, first, second, and
third.
The Oracle Applications
Extension version with
which the file was created
or updated.
The region label used for
Personalization.

Type

Name

null

null

no

id

string

none null

no

initSortSeq

null

no

version

null

no

regionName

false null

no

postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

no

admin

no

sortState

null

null

no

sortByViewAttr

jrad:version null

Personali
string
zation
Label
Post
Indicates if rows which
boolean
Initial
are made dirty only by the
Values
defaulting of Initial Values
are to be posted.
Rendered Indicates if the
boolean
component is rendered.
Scope
The Base Packages
jrad:scope
which are allowed to
reuse this component.
Security Defines the security mode string
Mode
used to secure the region.
If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecur
ed.
Sort
Indicates if the user can boolean
Allowed sort this column. The
legal values are
yes, no, ascending, and
descending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting.
86

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e

null

Region Styles

Name

Standalon
e
Undisclos
ed Text
User
Personali
zation
View
Attribute
View
Instance
xml:lang

Description

Type

Indicates if this region can boolean


be rendered on its own.
The text to display when string
the children are hidden.
Indicates if a user can
boolean
personalize this
component.
The name of the view
string
attribute.
The name of the view
string
object instance.
Identifies the language
optional
contained within this
component.

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
false null

no

standalone

null

admin

no

undisclosedText

false admin

no

userCustomizabl
e

null

null

no

viewAttr

null

null

no

viewName

null

null

no

xml:lang

87

OA Extension Component Reference

hideShowHeader
Description
The hideShowHeader region provides a means of toggling the contents under a header
between being disclosed (shown) or undisclosed (hidden).
hideShowHeader extends <uix:hideShowHeader> and inherits all the attributes and children.
Corresponding web bean: OAHideShowHeaderBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Comments
Controller
Class
CSS Class
Disable
Client Side
Validation
88

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name
of an application
module.
The attribute set for
the component.
Comments
The fully-qualified
class name for the
controller object.
Overrides the
default CSS class.
Indicates if
validation should not
occur on the web

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true null
no
addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

boolean

false null

no

unvalidated

Region Styles

Name

Disable
Server
Side
Validation
Disclosed
Document
Name
Document
ation
Comment

Description

tier during a form


submit.
Indicates if
validation should not
occur on the
business tier during
a form submit.
The initial disclosed
state.
The name of the
component
Formatted text for
use with Javadoc.

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

false null

no

serverUnvalidated

boolean

false user

no

disclosed

no

docName

no

not applicable

no

extends

no

file-version

no

helpTarget

no

helpTargetAppSho
rtName

no

icon

no

id

no

version

jrad:refName null
string

null

from null
templ
ate
file
Extends
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
null
Version
file.
Help
The target name for string
null
null
Target
the page online
help.
Help
This application will string
null
null
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
Icon URI The URI for the icon string
null
admin
file.
ID
The unique name of Name
null
null
this component.
OA
The Oracle
jrad:version null
null
Extension Applications
Version
Extension version
with which the file

89

OA Extension Component Reference

Name

Personaliz
ation Label
Post Initial
Values

Rendered

Scope

Security
Mode

Description

was created or
updated.
The region label
string
used for
Personalization.
Indicates if rows
boolean
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if the
boolean
component is
rendered.
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Defines the security string
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.

Standalon Indicates if this


e
region can be
rendered on its own.
Text
The text label for the
component.
View
The name of the
Attribute view attribute.
View
The name of the
Instance view object
instance.
xml:lang Identifies the
language contained
within this
component.

90

Type

Defau Personaliz Translat


lt
able
able
Value

null

XML Attribute

null

no

regionName

false null

no

postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

boolean

false null

no

standalone

string

null

admin

yes

text

string

null

null

no

viewAttr

string

null

null

no

viewName

optional

null

null

no

xml:lang

Region Styles

91

OA Extension Component Reference

labeledFieldLayout
Description
The labeledFieldLayout region lays out its indexed children in a series of columns, one set for
the "labels" and the other set for the "fields", with a gap in between. The children are laid out
across and down, with the first child in each row in the "label" position and the second in the
"field" position. The contents of each row are centered in the available space, with the "labels"
right aligned, and the "fields" left aligned. With multiple columns, the children continue to be
layed out across and down. For example, with two columns, the third child will be used as the
label for the first row and second column.
Although designed for labeled text fields, this layout can be used with any UINodes. It also has
special support for all of the inline messaging beans. Each inline messaging bean will
automatically occupy both a "label" and "field" position.
Corresponding web bean: OALabeledFieldLayoutBean
Note: The labeledFieldLayout component has been deprecated; use the
messageComponentLayout component instead. Please refer to the messageComponentLayout
section for information about messageComponentLayout.

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute The attribute set for
Set
the component.
Child View The name of the
92

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true null
no
addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

childViewAttrNam

Region Styles

Name

Description

Attribute child view attribute.


Child View Renders an
Instance instance of the
object for each row
in the View
Instance.
Columns The number of
columns to display
in the layout.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Document The name of the
Name
component
Document Formatted text for
ation
use with Javadoc.
Comment

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

string

null

null

no

e
childViewUsageNa
me

unsignedInt

null

no

columns

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

null

no

docName

from null
templ
ate
file
Extends
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
null
Version
file.
Help
The target name for string
null
null
Target
the page online
help.
Help
This application will string
null
null
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
ID
The unique name of Name
null
null
this component.

no

not applicable

no

extends

no

file-version

no

helpTarget

no

helpTargetAppSho
rtName

no

id

jrad:refName null
string

93

OA Extension Component Reference

Name

Description

Type

Item Width Indicates the width string


of the item in pixels
or as a percentage
(if % sign included).
OA
The Oracle
jrad:version
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label
string
ation Label used for
Personalization.
Post Initial Indicates if rows
boolean
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Prompt
Indicates the width string
Width
of the prompt in
pixels or as a
percentage (if %
sign included).
Rendered Indicates if the
boolean
component is
rendered.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
94

Defau Personaliz Translat XML Attribute


lt
able
able
Value
null
null
no
fieldWidth

null

null

no

version

null

null

no

regionName

false null

no

postDefault

null

null

no

labelWidth

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

false null

no

standalone

Region Styles

Name

Description

Type

View Link The name of the


string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
Width
Indicates the width string
in pixels or as a
percentage (if %
sign included).
xml:lang Identifies the
optional
language contained
within this
component.

Defau Personaliz Translat XML Attribute


lt
able
able
Value
null
null
no
viewLinkName

null

null

no

width

null

null

no

xml:lang

95

OA Extension Component Reference

listOfValues
Description
A listOfValues region is rendered in a separate modal dialog containing a complex list of
possible values that can be selected as a valid value for an entry field on a transaction page or
a field within a table. Refer to the messageLovInput section for information on the properties of
messageLovInput.
Corresponding web bean: OAListOfValuesBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
Advanced Indicates if the
Search
Advanced Search
Allowed
region is Enabled for
the List Of Values.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute
The attribute set for
Set
the component.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Document The name of the
Name
component
Document Formatted text for
ation
use with Javadoc.
Comment
Extends
96

A reference to

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true admin
no
adminCustomizab
le

boolean

false admin

no

advancedSearch
Allowed

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

admin

no

styleClass

null

no

docName

from null
templ
ate
file
jrad:compone null
null

no

not applicable

no

extends

null

jrad:refName null
string

Region Styles

Name

File
Version
OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Rendered

Scope

Security
Mode

xml:lang

Description

another component
that creates a
different instance of
that component at
runtime.
The version of the
file.
The Oracle
Applications
Extension version
with which the file
was created or
updated.
The region label
used for
Personalization.
Indicates if rows
which are made dirty
only by the
defaulting of Initial
Values are to be
posted.
Indicates if the
component is
rendered.
The Base Packages
which are allowed to
reuse this
component.
Defines the security
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

ntRef

string

null

null

no

file-version

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

stand null
ard

no

securityMode

null

no

xml:lang

Identifies the
optional
language contained
within this
component.

null

97

OA Extension Component Reference

Element Children
Name
Quantity
Description
searchInstructions 0 through 1 Short instructional text which will display in the search block of
the LOV window.

98

Region Styles

menu
Description
A menu region is rendered on a supported page item to allow end-users to choose one or more
client-side actions to perform on an item. Currently, you can enable a menu region on a link,
image or button item. The menu appears as a pop-up when you select the menu-enabled item
and supports two modes of operation depending on its implementation:

Selection Disabled - allows you to choose only one option from the menu list and fires
the action associated with that chosen option.
Selection Enabled - allows you to choose multiple menu options and sequentially fires
the actions associated with those chosen options.

All the options under a menu region are added as menu items and are indexed children of the
menu. You can also enable reordering of the menu items on a menu.
Corresponding web bean: OAMenuBean

Properties
Name

Description

Type

Default Personali Translat


Value
zable
able

XML
Attribute

Additional Additional help text.


Text

string

null

admin

yes

shortDesc

Admin
Indicates if an
Personali Administrator can
zation
personalize this
component.

boolean

true

admin

no

adminCusto
mizable

null

no

use

Attribute
Set

The attribute set for the jrad:attribute null


component.
SetRef

Comment Comments
s

string

null

null

no

comment

Controller The fully-qualified class string


Class
name for the controller
object.

null

admin

no

controllerCla
ss

CSS
Class

null

admin

no

styleClass

no

dataType

Overrides the default


CSS class.

string

Data Type The type of data. The


string
legal values are
VARCHAR2, DATE, D
ATETIME,
BIGDECIMAL,
NUMBER, BOOLEAN,

VARCH null
AR2

99

OA Extension Component Reference

Name

Description

Type

Default Personali Translat


Value
zable
able

XML
Attribute

and CLOB.
Enable
Reorder

Reorder is Enabled or
Disabled on menu.

boolean

true

admin

no

reorderEnabl
ed

Enable
Selection

Selection is Enabled or boolean


Disabled on menu.

true

admin

no

selectionEna
bled

Extends

A reference to another jrad:compon null


component that creates entRef
a different instance of
that component at
runtime.

null

no

extends

ID

The unique name of


this component.

Name

null

null

no

id

Personali The region label used


zation
for Personalization.
Label

string

null

null

no

regionName

Post Initial Indicates if rows which


Values
are made dirty only by
the defaulting of Initial
Values are to be
posted.

boolean

false

null

no

postDefault

Rendered Indicates if the


boolean
component is rendered.

true

user

no

rendered

Security
Mode

Defines the security


string
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSec
ured.

standar null
d

no

securityMod
e

View
Attribute

The name of the view


attribute.

string

null

null

no

viewAttr

View
Instance

The name of the view


object instance.

string

null

null

no

viewName

xml:lang

Identifies the language optional


contained within this
component.

null

null

no

xml:lang

100

Region Styles

menuItem
Name

Description

Type

Default Personali Translat


Value
zable
able

XML
Attribute

Access
Key

The character used for string


quick keyboard
navigation or
activation.

null

admin

no

accessKey

Additional
Text

Additional help text.

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCusto
mizable

null

no

use

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
Attribute
Set

The attribute set for the jrad:attribute null


component.
SetRef

Comments Comments

string

null

null

no

comment

CSS Class Overrides the default


CSS class.

string

null

admin

no

styleClass

no

dataType

null

no

destination

Data Type The type of data. The string


legal values are
VARCHAR2, DATE, D
ATETIME,
BIGDECIMAL,
NUMBER, BOOLEAN,
and CLOB.
Destinatio The destination URI.
n URI

VARCH null
AR2

uriReference null

disabled

Indicates if the element boolean


is disabled.

false

null

no

disabled

Disable
Server
Side
Validation

Indicates if validation
boolean
should not occur on the
business tier during a
form submit.

false

null

no

serverUnvali
dated

Enable
Selection

Enable/disable only
selection on this item.

boolean

true

admin

no

selectionEna
bled

Extends

A reference to another
component that
creates a different
instance of that
component at runtime.

jrad:compon null
entRef

null

no

extends

ID

The unique name of


this component.

Name

null

no

id

null

101

OA Extension Component Reference

Name
No Wrap

Description

boolean

Default Personali Translat


Value
zable
able

XML
Attribute

false

null

no

cellNoWrapF
ormat

onReorder The action to invoke


string
Down
upon selecting Reorder
Down.

null

null

no

onReorderD
own

onReorder The action to invoke


string
Up
upon selecting Reorder
Up.

null

null

no

onReorderU
p

onSelect

The action to invoke


string
upon selection of menu
item.

null

null

no

onSelect

Rendered

Indicates if the
component is
rendered.

boolean

true

user

no

rendered

Selected
State

Selection state of
menu item.

string

disable
d

null

no

selectedStat
e

Target
Frame

The name of the target string


frame for the link.

null

admin

no

targetFrame

Text

The text label for the


component.

string

null

admin

yes

text

User
Indicates if a user can
Personaliz personalize this
ation
component.

boolean

false

admin

no

userCustomi
zable

View
Attribute

The name of the view


attribute.

string

null

null

no

viewAttr

View
Instance

The name of the view


object instance.

string

null

null

no

viewName

xml:lang

Identifies the language optional


contained within this
component.

null

null

no

xml:lang

102

Indicates if cell
contents should be
wrapped.

Type

Region Styles

messageComponentLayout
Description
The messageComponentLayout region lays out components in multiple columns. The prompts
of the components line up, and right align; and the associated data entry areas of each of the
components also line up, left aligning with one another within a column. The children of this
bean are restricted to message components.
Corresponding web bean: OAMessageComponentLayoutBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added to this
UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified class
Definition name for the application
module.
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Columns The number of columns to
display in the layout.
Comment Comments
s
Controller The fully-qualified class
Class
name for the controller
object.
CSS
Overrides the default CSS
Class
class.
Document The name of the
Name
component
Document Formatted text for use with

Type

Defa Personali Translat


ult
zable
able
Value

XML
Attribute

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCusto
mizable

string

null

null

no

amDefName

string

null

null

no

jrad:attribute null
SetRef
unsignedInt null

null

no

amUsageNa
me
use

null

no

columns

string

null

null

no

comment

string

null

admin

no

controllerClas
s

string

null

admin

no

styleClass

null

no

docName

from null

no

not

jrad:refName null
string

103

OA Extension Component Reference

ation
Javadoc.
Comment
Extends

Field
Width

File
Version
ID
Initial Sort
Sequence

OA
Extension
Version

A reference to another
component that creates a
different instance of that
component at runtime.
Overrides the preferred
string
width of the fields in pixels
or as a percentage (if %
sign included).
The version of the file.
string
The unique name of this
component.
Indicates the initial sort
sequence for each search.
The legal values are
none, first, second, and t
hird.
The Oracle Applications
Extension version with
which the file was created
or updated.
The region label used for
Personalization.

Personaliz
ation
Label
Post Initial Indicates if rows which are
Values
made dirty only by the
defaulting of Initial Values
are to be posted.
Prompt
Indicates the width of the
Width
prompt in pixels or as a
percentage (if % sign
included).
Rendered Indicates if the component
is rendered.
Scope
The Base Packages which
are allowed to reuse this
component.
Search
Indicates if this component
Region
is used as a search region.
Setting this to True
overrides settings for the
Width, Prompt Width and
Field Width.
Security Defines the security mode
104

templ
ate
file
jrad:compon null null
entRef

applicable

no

extends

null

admin

no

fieldWidth

null

null

no

file-version

Name

null

null

no

id

string

none null

no

initSortSeq

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false null

no

postDefault

string

null

null

no

labelWidth

boolean

true

user

no

rendered

jrad:scope

null

no

scope

boolean

false null

no

searchRegio
n

string

stand null

no

securityMode

Region Styles

Mode

Sort
Allowed

Sort By
View
Attribute
Width

xml:lang

used to secure the region.


If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecured.
Indicates if the user can
boolean
sort this column. The legal
values are
yes, no, ascending, and d
escending.

ard

no

admin

no

sortState

The alternate view attribute string


name for use when sorting.

null

null

no

sortByViewAt
tr

Indicates the width in


pixels or as a percentage
(if % sign included).
Identifies the language
contained within this
component.

string

null

null

no

width

optional

null

null

no

xml:lang

messageLayout
Name

Descriptio
n

Admin
Indicates if
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
attribute
set for the
component
.
Comments Comments
Prompt
The text
label for
the
component
.
Rendered
Indicates if

Type

boolean

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true

admin

no

adminCustomiza
ble

jrad:attributeSet null
Ref

null

no

use

string
string

null
null

null
admin

no
yes

comment
prompt

boolean

true

user

no

rendered
105

OA Extension Component Reference

the
component
is
rendered.

106

Region Styles

navigationBar
Description
The navigationBar style implements a locator element. It can be used for both step-by-step
navigation and record navigation.
Corresponding web bean: OANavigationBarBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Comments
Controller
Class
CSS Class
Disable
Client Side
Validation
Disable
Server
Side

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name of
an application
module.
The attribute set for
the component.
Comments
The fully-qualified
class name for the
controller object.
Overrides the default
CSS class.
Indicates if validation
should not occur on
the web tier during a
form submit.
Indicates if validation
should not occur on
the business tier

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomi
zable

string

null

null

no

amDefName

string

null

null

no

amUsageNam
e

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

boolean

false

null

no

unvalidated

boolean

false

null

no

serverUnvalida
ted

107

OA Extension Component Reference

Name

Validation
Document
Name
Documenta
tion
Comment
Extends

Description

during a form submit.


The name of the
jrad:refName
component
Formatted text for
string
use with Javadoc.

A reference to
another component
that creates a
different instance of
that component at
runtime.
File
The version of the
Version
file.
First Step The number of the
first step in a multistep navigation.
Last Step The number of the
last step in a multistep navigation.
OA
The Oracle
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label used
ation Label for Personalization.
Post Initial Indicates if rows
Values
which are made dirty
only by the defaulting
of Initial Values are to
be posted.
Records
The maximum
Displayed number of rows to
display.
Rendered Indicates if the
component is
rendered.
Scope
The Base Packages
which are allowed to
reuse this
component.
108

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
null

null

no

docName

from null
templ
ate file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

null

null

no

file-version

unsignedInt

null

no

minValue

unsignedInt

-1

null

no

maxValue

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

admin

no

postDefault

unsignedInt

-1

user

no

blockSize

boolean

true

user

no

rendered

jrad:scope

null

no

scope

Region Styles

Name

Show All

Security
Mode

xml:lang

Description

Type

Indicates if the user string


can view any
attachment for the
current object,
regardless of
category.
Defines the security string
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Identifies the
optional
language contained
within this
component.

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
no
null
no
showAll

stand null
ard

no

securityMode

null

no

xml:lang

null

109

OA Extension Component Reference

pageButtonBar
Description
The pageButtonBar style lays out a set of buttons that operate over the scope of the entire
page.
Corresponding web bean: OAPageButtonBarBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
Attribute
Set
Comments
Controller
Class
CSS Class

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The attribute set for
the component.
Comments
The fully-qualified
class name for the
controller object.
Overrides the default
CSS class.
The name of the
component
Formatted text for
use with Javadoc.

Document
Name
Documenta
tion
Comment
Extends
A reference to
another component
that creates a
different instance of
that component at
runtime.
110

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomi
zable

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

jrad:refName

null

null

no

docName

from null
templ
ate file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

Region Styles

Name

Description

The version of the


file.
The Oracle
Applications
Extension version
with which the file
was created or
updated.
Personaliz The region label used
ation Label for Personalization.
Post Initial Indicates if rows
Values
which are made dirty
only by the defaulting
of Initial Values are to
be posted.
Rendered Indicates if the
component is
rendered.
Scope
The Base Packages
which are allowed to
reuse this
component.
Security
Defines the security
Mode
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.

string

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
null
null
no
file-version

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

stand null
ard

no

securityMode

xml:lang

optional

null

no

xml:lang

File
Version
OA
Extension
Version

Identifies the
language contained
within this
component.

Type

null

111

OA Extension Component Reference

pageLayout
Description
The pageLayout region is a high-level layout element that is a template for the entire page. It
supports several navigation and content areas for the creation of pages.
Page-level components like corporate branding, gesture maps, global buttons, global headers,
and privacy and copyright statements are contained under the OAPageLayoutBean.
Corresponding web bean: OAPageLayoutBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM State Indicates if an error
Required will be displayed
when navigating to
the page and an
Application Module
is not found.
Application The menu to render
Menu
with the page.
Attribute The attribute set for
Set
the component.
Auto
Indicates if standard
Footer
copyright and
privacy named
children are added
automatically.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
112

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true admin
no
adminCustomizabl
e

string

null

null

no

amDefName

boolean

false null

no

amStateRequired

string

null

null

no

appMenu

jrad:attributeS null
etRef
boolean
true

null

no

use

null

no

autoFooter

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

Region Styles

Name

Document
Name
Document
ation
Comment

Description

The name of the


component
Formatted text for
use with Javadoc.

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value
jrad:refName null
null
no
docName
string

from null
templ
ate
file
Extends
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
null
Version
file.
Form
Indicates if all child boolean
true null
elements are
embedded inside an
HTML form element.
Function The function that
string
null
null
Name
secures the region.
Global
The name of the
string
null
null
Menu
Global Menu.
Help
The target name for string
null
admin
Target
the page online
help.
Help
This application will string
null
admin
Target
be used to construct
Appl Short URI of the "help"
Name
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
ID
The unique name of Name
null
null
this component.
OA
The Oracle
jrad:version null
null
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Page
The menu name for string
null
null

no

not applicable

no

extends

no

file-version

no

addForm

no

function

no

globalMenu

no

helpTarget

no

helpTargetAppSho
rtName

no

id

no

version

no

pageMenu
113

OA Extension Component Reference

Name

Description

Type

Menu
the page.
Personaliz The region label
string
ation Label used for
Personalization.
Post Initial Indicates if rows
boolean
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Rendered Indicates if the
boolean
component is
rendered.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Show
Indicates if Quick
boolean
Quick
Links within the
Links
page are rendered
automatically.
Title
The title of the
string
region.
Warn
Warns the user if
boolean
About
there are pending
Changes changes that will be
lost, and allows
them to cancel the
current action or
discard the changes
and continue with
the current action.
Window
The title of the
string
114

Defau Personaliz Translat


lt
able
able
Value
null

XML Attribute

null

no

regionName

false null

no

postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

false null

no

quickLinksShown

null

null

no

title

false null

no

warnAboutChange
s

null

true

windowTitle

admin

Region Styles

Name

Title
xml:lang

Description

Type

window.
Identifies the
optional
language contained
within this
component.

Defau Personaliz Translat


lt
able
able
Value
null

null

no

XML Attribute

xml:lang

Element Children
Name
contentFooter
copyright
corporateBranding

Quantity
Description
0 through 1 The content footer region of the page.
0 through 1 Node to use as a copyright statement.
0 through 1 The corporate branding region of the page. This section typically
contains a medium size image of the logo of the company
owning the page.
flexibleContents 0 through 1 Flexible contents.
footnote
0 through 1 The footnote region. This region provides a location for pagelevel status that is ancillary to the user's task.
gestureMap
0 through 1 Contains the gesture maps associated with the page.
inContextBranding 0 through 1 The inContext branding region of the page. This section typically
contains formatted text indicating that one context exists
between the persistent tabs.
location
0 through 1 The locator region of the page.
pageStatus
0 through 1 The page-level status and/or key notation region. This region
provides a location for page-level status that is important to the
user's task.
privacy
0 through 1 Node to use as a privacy statement.
productBranding 0 through 1 The product branding region of the page. This section typically
contains an image of the product logo.
quickSearch
0 through 1 The quick search region of the page.
returnNavigation 0 through 1 The "return to" link at the bottom of the page.
userInfo
0 through 1 The user information region.

gestureMap
Name
binding
nodeID

Description Type
binding
string
nodeID
string

Default Value Personalizable Translatable XML Attribute


null
null
no
binding
null
null
no
nodeID

115

OA Extension Component Reference

refID
refType
rendered
transient

refID
refType
rendered
transient

string
string
boolean
boolean

null
null
true
false

null
null
null
null

no
no
no
no

refID
refType
rendered
transient

gesture
Name

Attribute
Set

Descriptio
n

Type

The
jrad:attributeSetR
attribute
ef
set for the
component
.
binding
binding
string
Comment Comments string
s
Gesture The name string
Name
of gesture
to be
associated.
ID
The unique Name
name of
this
component
.
nodeID
nodeID
string
refID
refID
string
refType refType
string
rendered rendered boolean
Target
The
string
Bean
Attribute of
Attribute the target
bean which
holds the
event
definition to
be
triggered.
Target
Id of the
string
Bean Id target bean
present on
the page,
whose
116

Defaul Personalizabl Translatabl


t
e
e
Value

XML Attribute

null

null

no

use

null
null

null
null

no
no

binding
comment

null

null

no

gestureName

null

null

no

id

null
null
null
true
null

null
null
null
null
null

no
no
no
no
no

nodeID
refID
refType
rendered
targetBeanAttribu
te

null

null

null

targetBeanId

Region Styles

attribute
needs to
be
associated
with the
selected
gesture.
transient transient
boolean

false

null

no

transient

117

OA Extension Component Reference

popUp

Description
The popUp region style is used to create a small window that allows a user to display and
update contextual information. A pop-up window can render any OA Framework region. There
are two types of pop-ups:

Embedded pop-up - The pop-up is embedded within the base page web bean hierarchy.
It is an extension of the base page, sharing the same page state. Its contents are prefetched as part of the base page request.
Parameterized pop-up - The pop-up is a separate standalone region that is not
embedded within the base page. Its contents are fetched and rendered on demand.

Pop-ups are available on the following OA components:

messageStyledText
image
link
button

popUp extends flowlayout and inherits all the attributes from it. See the section on flowlayout for
a list of attributes available on the flowlayout element.
Corresponding web bean: OAPopupBean

Properties
Name

Descripti
Type
Default
on
Value
Additional Additional string
null
Text
help text.
Admin
Indicates boolean
true
Personalizat if an
ion
Administra
tor can
personaliz
e this
componen
t.
Attribute Set The
jrad:attributeSe null
attribute tRef
118

Personaliza Translata XML Attribute


ble
ble
admin
yes
shortDesc
admin

no

adminCustomiz
able

null

no

use

Region Styles

Name

Descripti
on

Type

set for the


componen
t.
Comments Comment string
s
Height
The
string
display
height in
pixels.
ID
The
Name
unique
name of
this
componen
t.
Modal
Indicates boolean
Enabled
whether
the popup
should be
a modal
dialog or a
non-modal
dialog.
Parameters The
string
parameter
s of the
pop-up.
Read Only Indicates boolean
if the
value can
be
changed.
Region
Indicates string
the region
where the
pop-up
occurs.
Title
Indicates string
the title for
the popup
Type
Indicates string
the popup type.
View
The name string

Default
Value

Personaliza Translata XML Attribute


ble
ble

null

null

no

comment

null

admin

no

height

null

null

no

id

false

admin

no

isModal

null

admin

no

popupParamet
ers

false

admin

no

readOnly

null

admin

no

popupRegion

null

admin

no

popupTitle

EmbeddedPo admin
pup

no

popupType

null

no

viewName

null

119

OA Extension Component Reference

Name
Instance

Width

120

Descripti
on

Type

of the
view
object
instance.
Indicates string
the width
in pixels
or as a
percentag
e (if %
sign
included).

Default
Value

null

Personaliza Translata XML Attribute


ble
ble

admin

no

width

Region Styles

query
Description
The query region extends UIX's StackLayoutBean. A query region is an extension of the
stackLayout region. A query region can contain a simple search panel, an advanced search
panel, a results table, and other elements as indexed children. The simple search panel is
represented as an optional named child that can contan any of the default renderers -defaultSingleColumn, defaultDoubleColumn, defaultStack, and defaultFormStack elements.
Similarly, the advanced search panel is represented in the metadata as an optional named child
that can contain an advancedSearch element. The results of a query are rendered using either
a HGrid or a table. The table or HGrid elements are added as indexed children of the query
region.
For a query region, there are three types of search panels that can be displayed. They are:

Simple
Advanced
Customize

Query region runs in three modes: Default mode, Results Based Search (RBS) mode, and Auto
Customization Criteria (ACC) mode.
In the default mode, the developer is responsible for defining the search panels and binding the
results of the search to the results table/HGrid.
In the RBS mode, the search panel is created dynamically using the queryable property of the
region items inside the nested table or HGrid indexed children.
In the ACC mode, you have the flexibility of defining your own UI for the search panels, but the
binding is powered by the framework as long as items on the panels are mapped to items in the
results table/HGrid.
If you want to support user-personalizable searches which are surfaced in a Views panel, you
must set the User Personalization property of the table/hgrid region (under the query region) to
True. See the OA Framework Developer's Guide for more information.
Corresponding web bean: OAQueryBean

Properties
Query inherits all the attributes from stackLayout. See the section on stackLayout for a list of
attributes and child elements available on the stackLayout element.
Name

Description

Type

Defau Person Transl XML Attribute


lt
alizable atable
Value
121

OA Extension Component Reference

Admin Indicates if an Administrator can


Persona personalize this component.
lization
Advanc Overrides the default text for the
ed
button that navigates to the
Button advanced search panel.
Label
Advanc Overrides the default text for the
ed
advanced search panel
Panel instruction text.
Instructi
ons
AM
The fully-qualified class name
Definitio for the application module.
n
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Comme Comments
nts
Constru Indicates the level of automatic
ction
panel and search construction.
Mode
'autoCustomizationCriteria' is
the most automatic level;
'resultsBasedSearch' is a semiautomatic level, and 'none'
implies manual construction.
The legal values are
none, resultsBasedSearch, and
autoCustomizationCriteria.
Controll The fully-qualified class name
er Class for the controller object.
CSS
Overrides the default CSS
Class
class.
Data
The type of data. Valid only
Type
when used in table region. The
legal values are
VARCHAR2, DATE, DATETIME
, NUMBER,
BIGDECIMAL, BOOLEAN, and
CLOB.
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Help
The target name for the page
122

boolean

true

admin

no

adminCustomiza
ble

string

null

null

true

advSearchPanel
ButtonLabel

string

null

null

true

advancedSearch
InstrTexts

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attribu null
teSetRef
string
null

null

no

use

null

no

comment

string

none

null

no

mode

string

null

admin

no

controllerClass

string

null

admin

no

styleClass

string

VARC null
HAR2

no

dataType

jrad:comp null
onentRef

null

no

extends

string

null

no

helpTarget

null

Region Styles

Target
Help
Target
Appl
Short
Name

online help.
This application will be used to string
construct URI of the "help" icon
in the global menu of the
page.This makes the help
pages from the other
applications referenceable.
Hide
Indicates if the Personalize
boolean
Persona button is hidden.
lize
Hide
Indicates if the Save Search
boolean
Save
button is hidden.
Search
Include Indicates if the advanced search boolean
Advanc panel is available to the user.
ed
Panel
Include Indicates if the simple search
boolean
Simple panel is available to the user.
Panel
Include Indicates if the Views panel is
boolean
Views available to the user.
Panel
Initial
The initial panel to render. The string
Panel legal values are
simple, advanced, and customiz
ed.
Initial
Indicates the initial sort
string
Sort
sequence for each search. The
Sequen legal values are
ce
none, first, second, and third.
No
Indicates if cell contents should boolean
Wrap
be wrapped. Valid only when
used in table region.
Persona The region label used for
string
lization Personalization.
Label
Post
Indicates if rows which are
boolean
Initial
made dirty only by the defaulting
Values of Initial Values are to be
posted.
Render Indicates if the component is
boolean
ed
rendered.
Save
Overrides the default text for the string
Search Save Search button.
Button
Text

null

admin

no

helpTargetAppS
hortName

false

admin

no

hidePersonalize

false

admin

no

hideSaveSearch

false

null

no

dispAdvanced

false

null

no

dispSimple

false

null

no

dispCustomized

simple user

no

defaultPanel

none

null

no

initSortSeq

false

null

no

cellNoWrapForm
at

null

null

no

regionName

false

null

no

postDefault

true

user

no

rendered

null

null

true

saveSearchButto
nText

123

OA Extension Component Reference

Security Defines the security mode used


Mode
to secure the region. If set to
selfSecured it is the developer's
responsibility to handle security
validation. The legal values are
standard, and selfSecured.
Show
Indicates if the Views Panel
Views controls will be displayed.
Panel
Controls
Simple Overrides the default text for the
Button button that navigates to the
Label
simple search panel.
Simple Overrides the default text for the
Panel Simple Search Panel instruction
Instructi text.
ons
Sort
Indicates if the user can sort this
Allowed column. Valid only when used in
table region. The legal values
are
yes, no, ascending, and descen
ding.
Sort By The alternate view attribute
View
name for use when sorting.
Attribute Valid only when used in table
region.
Standal Indicates if this region can be
one
rendered on its own.
Store
Indicates if the views are stored
Views on the shared region.
on
Shared
Region
User
Indicates if a user can
Persona personalize this component.
lization Valid only when used in table
region.
View
The name of the view object
Instance instance. Valid only when used
in table region.
Views Overrides the default text for the
Button button that navigates to the
Label
Views panel.
Views Overrides the default text for the
Panel Views panel instruction text.
Instructi
124

string

standa null
rd

no

securityMode

boolean

true

null

no

showCustomizeP
anelControls

string

null

null

true

simpleSearchPa
nelButtonLabel

string

null

null

true

simpleSearchInst
rTexts

string

no

admin

no

sortState

string

null

user

no

sortByViewAttr

boolean

false

null

no

standalone

boolean

false

null

no

storeViewsOnSh
aredRegion

boolean

false

admin

no

userCustomizabl
e

string

null

null

no

viewName

string

null

null

true

viewConfPanelB
uttonLabel

string

null

null

true

customizeInstrTe
xts

Region Styles

ons
Views
Panel
Title

Overrides the default text for the string


Views panel title.

null

null

true

customizePanelT
itle

Element Children
Name
Quantity
Description
advancedSearchMappings 0 through 1 Contains mappings between criteria items on dvanced
search panel and result tables(or hGrids).
advancedSearchPanel
0 through 1 Named child for holding an advanced search panel.
simpleSearchMappings
0 through 1 Contains mappings between criteria items on simple
search panel and result tables(or hGrids).
simpleSearchPanel
0 through 1 Named child for holding a simple search panel.

queryCriteriaMap
Name
Attribute
Set

Description

The attribute
set for the
component.
Comments Comments.
Results
The ID of the
Item
item in the
results table
or hGrid.
Search
The ID of the
Item
item in the
search
panel.

Type

Default Personalizable Translatable


XML
Value
Attribute

jrad:attributeSetRef null

null

no

use

string
null
jrad:componentRef null

null
null

no
no

comment
resultsItem

jrad:componentRef null

null

no

criteriaItem

In addition to inheriting the named children from stackLayout, query has three more named
children associated with it. They are simpleSearchPanel, advancedSearchPanel, and results.

125

OA Extension Component Reference

rowLayout
Description
The rowLayout region can be used on its own, or to define a row of a tableLayout. It can contain
arbitrary content, one item per cell, but clients that need formatting beyond just a simple <td>
element must wrap the child nodes in cellFormat objects.
Corresponding web bean: OARowLayoutBean

Properties
Name

Add
Indexed
Children

Description

Type

Indicates if indexed
boolean
children will be
automatically added to this
UI node tree.
Admin
Indicates if an
boolean
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified class
string
Definition name for the application
module.
AM
The instance name of an string
Instance application module.
Attribute The attribute set for the
jrad:attribute
Set
component.
SetRef
Child
The name of the child view string
View
attribute. Valid only when
Attribute used in table region.
Child
Renders an instance of
string
View
the object for each row in
Instance the View Instance. Valid
only when used in table
region.
Comment Comments
string
s
Controller The fully-qualified class
string
126

Defa Personali Translat XML Attribute


ult
zable
able
Value
true null
no
addChildren

true

admin

no

adminCustomi
zable

null

null

no

amDefName

null

null

no

null

null

no

amUsageNam
e
use

null

null

no

childViewAttrN
ame

null

null

no

childViewUsag
eName

null

null

no

comment

null

admin

no

controllerClass

Region Styles

Name

Description

Type

name for the controller


object.
CSS
Overrides the default CSS string
Class
class.
Document The name of the
jrad:refName
Name
component
Document Formatted text for use with string
ation
Javadoc.
Comment

Defa Personali Translat XML Attribute


ult
zable
able
Value

Class

Extends

null

admin

no

styleClass

null

null

no

docName

from null
templ
ate
file
A reference to another
jrad:compon null null
component that creates a entRef
different instance of that
component at runtime.
The version of the file.
string
null null

no

not applicable

no

extends

no

file-version

File
Version
Horizontal Horizontal alignment.
string
Alignment Acceptable values are
"center", "left", "right",
"start", and "end".
ID
The unique name of this Name
component.
Initial Sort Indicates the initial sort
string
Sequence sequence for each search.
The legal values are
none, first, second, and t
hird.
No Wrap

Indicates if cell contents


should be wrapped. Valid
only when used in table
region.
OA
The Oracle Applications
Extension Extension version with
Version
which the file was created
or updated.
Personaliz The region label used for
ation
Personalization.
Label
Post Initial Indicates if rows which are
Values
made dirty only by the
defaulting of Initial Values
are to be posted.
Prompt
The text label for the

null

null

no

hAlign

null

null

no

id

none null

no

initSortSeq

boolean

false null

no

cellNoWrapFor
mat

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false null

no

postDefault

string

null

true

prompt

admin

127

OA Extension Component Reference

Name

Description

Type

component.
Rendered Indicates if the component boolean
is rendered.
Scope
The Base Packages which jrad:scope
are allowed to reuse this
component.
Security Defines the security mode string
Mode
used to secure the region.
If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecure
d.
Sort
Indicates if the user can
string
Allowed sort this column. Valid only
when used in table region.
The legal values are
yes, no, ascending, and
descending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting. Valid only
when used in table region.
User
Indicates if a user can
boolean
Personaliz personalize this
ation
component. Valid only
when used in table region.
Vertical
Vertical alignment.
string
Alignment Acceptable values are
"middle", "top", and
"bottom".
Width
Indicates the width in
string
pixels or as a percentage
(if % sign included).
xml:lang Identifies the language
optional
contained within this
component.

128

Defa Personali Translat XML Attribute


ult
zable
able
Value
true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

no

admin

no

sortState

null

user

no

sortByViewAttr

false admin

no

userCustomiza
ble

null

null

no

vAlign

null

null

no

width

null

null

no

xml:lang

Region Styles

shuttle
Description
The shuttle region provides a mechanism for moving items between two lists and reordering one
of these lists. Often the shuttle will be used to select items from one list by placing them in the
other. However, the shuttle can be used to operate on lists in other ways as well.
Corresponding web bean: OAShuttleBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Available
Header
Comments
Controller
Class
CSS Class
Document
Name
Document
ation

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name
of an application
module.
The attribute set for
the component.
The header for the
available (first) list.
Comments
The fully-qualified
class name for the
controller object.
Overrides the
default CSS class.
The name of the
component
Formatted text for
use with Javadoc.

Type

boolean

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true null
no
addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

leadingHeader

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

null

no

docName

from null
templ

no

not applicable

jrad:refName null
string

129

OA Extension Component Reference

Name

Comment
Extends

File
Version
Help
Target
Help
Target
Appl Short
Name

ID
OA
Extension
Version

Ordering
Allowed

Personaliz
ation Label
Post Initial
Values

130

Description

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value
ate
file
A reference to
jrad:compone null
null
no
extends
another component ntRef
that creates a
different instance of
that component at
runtime.
The version of the string
null
null
no
file-version
file.
The target name for string
null
null
no
helpTarget
the page online
help.
This application will string
null
null
no
helpTargetAppSho
be used to construct
rtName
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
The unique name of Name
null
null
no
id
this component.
The Oracle
jrad:version null
null
no
version
Applications
Extension version
with which the file
was created or
updated.
Indicates if the
boolean
true null
no
reorderable
contents of the
selected (second)
list can be ordered.
The region label
string
null
null
no
regionName
used for
Personalization.
Indicates if rows
boolean
false null
no
postDefault
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.

Region Styles

Name

Description

Type

Rendered Indicates if the


boolean
component is
rendered.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Selected
Header

The header for the string


selected (second)
list.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
xml:lang Identifies the
optional
language contained
within this
component.

Defau Personaliz Translat XML Attribute


lt
able
able
Value
true user
no
rendered

null

no

scope

stand null
ard

no

securityMode

null

null

no

trailingHeader

false null

no

standalone

null

no

xml:lang

null

Element Children
Name
leading
leadingFooter
trailing
trailingFooter

Quantity
0 through 1
0 through 1
0 through 1
0 through 1

Description
The leading list of the shuttle.
The footer of buttons/images under the leading list.
The trailing list of the shuttle.
The footer of buttons/images under the trailing list.

131

OA Extension Component Reference

stackLayout
Description
The stackLayout region is a layout element that lays out each of its children vertically.
Corresponding web bean: OAStackLayoutBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added to
this UI node tree.
Admin
Indicates if an
Personali Administrator can
zation
personalize this
component.
AM
The fully-qualified class
Definition name for the application
module.
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Child
The name of the child
View
view attribute. Valid only
Attribute when used in table
region.
Child
Renders an instance of
View
the object for each row in
Instance the View Instance. Valid
only when used in table
region.
Comment Comments
s
Controller The fully-qualified class
Class
name for the controller
object.
132

Type

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomiza
ble

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attribute null
SetRef
string
null

null

no

use

null

no

childViewAttrNa
me

string

null

null

no

childViewUsage
Name

string

null

null

no

comment

string

null

admin

no

controllerClass

Region Styles

Name

Description

CSS
Overrides the default
Class
CSS class.
Document The name of the
Name
component
Document Formatted text for use
ation
with Javadoc.
Comment
Extends

File
Version
Help
Target
Help
Target
Appl
Short
Name

Type

string

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
null

admin

jrad:refNam null null


e
string
from null
templ
ate
file
A reference to another
jrad:compon null null
component that creates a entRef
different instance of that
component at runtime.
The version of the file.
string
null null

The target name for the


page online help.
This application will be
used to construct URI of
the "help" icon in the
global menu of the
page.This makes the help
pages from the other
applications
referenceable.
ID
The unique name of this
component.
Initial Sort Indicates the initial sort
Sequence sequence for each
search. The legal values
are
none, first, second, and
third.

no

styleClass

no

docName

no

not applicable

no

extends

no

file-version

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppS
hortName

Name

null

null

no

id

string

none null

no

initSortSeq

No Wrap Indicates if cell contents boolean


false null
should be wrapped. Valid
only when used in table
region.
OA
The Oracle Applications jrad:version null null
Extension Extension version with
Version which the file was created
or updated.
Personali The region label used for string
null null
zation
Personalization.
Label

no

cellNoWrapForm
at

no

version

no

regionName

133

OA Extension Component Reference

Name

Post
Initial
Values

Description

Type

Indicates if rows which


boolean
are made dirty only by the
defaulting of Initial Values
are to be posted.
Prompt
The text label for the
string
component.
Rendered Indicates if the
boolean
component is rendered.
Scope
The Base Packages
jrad:scope
which are allowed to
reuse this component.
Security Defines the security mode string
Mode
used to secure the region.
If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecur
ed.
Sort
Indicates if the user can string
Allowed sort this column. Valid
only when used in table
region. The legal values
are
yes, no, ascending, and
descending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting. Valid only
when used in table
region.
Standalon Indicates if this region can boolean
e
be rendered on its own.
User
Indicates if a user can
boolean
Personali personalize this
zation
component. Valid only
when used in table
region.
xml:lang Identifies the language
optional
contained within this
component.

134

Defa Personali Translat XML Attribute


ult
zable
able
Valu
e
false null

no

postDefault

null

admin

true

prompt

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

no

admin

no

sortState

null

user

no

sortByViewAttr

false null

no

standalone

false admin

no

userCustomizabl
e

null

no

xml:lang

null

Region Styles

135

OA Extension Component Reference

subTabLayout
Description
The subTabLayout region has a named child called "subTabs" that takes a subTabBar bean.
subTabBar contains link elements as its indexed children. subTabBar is rendered once on top
and once on the bottom. The indexed children of the subTabLayout are rendered in between.
The number of indexed children of subTabBar, which are the link elements, should be equal to
the number of indexed children of the parent subTabLayout. The link elements are used to
switch between the indexed children of the subTabLayout.
subTabLayout extends the UIX counterpart <uix:subTabLayout> and inherits all the attributes
and the children.
Corresponding web bean: OASubTabLayoutBean

Properties
Name

Add
Indexed
Children

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance
of an application
module.
Attribute
The attribute set for
Set
the component.
Child View The name of the
Attribute
child view attribute.
Child View Renders an
Instance
instance of the
object for each row
in the View
Instance.
136

Type

boolean

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
true null
no
addChildren

boolean

true

admin

no

adminCustomiz
able

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

no

childViewAttrNa
me
childViewUsage
Name

null

Region Styles

Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Document The name of the
Name
component
Documenta Formatted text for
tion
use with Javadoc.
Comment

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

jrad:refName

null

null

no

docName

no

not applicable

no

extends

no

file-version

no

id

no

selectedIndex

no

version

no

regionName

no

postDefault

no

rendered

no

scope

string

from null
templ
ate
file
Extends
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
File
The version of the string
null
null
Version
file.
ID
The unique name of Name
null
null
this component.
Initial
The initially selected nonNegativeIn 0
null
Subtab
subtab.
teger
OA
The Oracle
jrad:version
null
null
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label
string
null
null
ation Label used for
Personalization.
Post Initial Indicates if rows
boolean
false null
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Rendered Indicates if the
boolean
true user
component is
rendered.
Scope
The Base Packages jrad:scope
.
null
which are allowed
to reuse this
component.

137

OA Extension Component Reference

Security
Mode

xml:lang

Defines the security string


mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Identifies the
optional
language contained
within this
component.

stand null
ard

no

securityMode

null

no

xml:lang

null

Element Children
Name Quantity
Description
subTabs 0 through 1 Rendered twice per bean render, once before indexed children and once
after.

subTabBar
Name

Additional
Text
Admin
Personalizati
on

Descriptio
n

Additional
help text.
Indicates if
an
Administrat
or can
personalize
this
component
.
Attribute Set The
attribute
set for the
component
.
Comments Comments
CSS Class Overrides
the default
CSS class.
138

Type

Defau Personalizab Translatab XML Attribute


lt
le
le
Value

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomiza
ble

jrad:attributeSet null
Ref

null

no

use

string
string

null
admin

no
no

comment
styleClass

null
null

Region Styles

Document
Name
Extends

Rendered

Scope

xml:lang

The name jrad:refName


of the
component
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
Indicates if boolean
the
component
is
rendered.
The Base jrad:scope
Packages
which are
allowed to
reuse this
component
.
Identifies optional
the
language
contained
within this
component
.

null

null

no

docName

null

null

no

extends

null

user

no

rendered

null

no

scope

null

null

no

xml:lang

139

OA Extension Component Reference

switcher
Description
The switcher region is used to dynamically decide which UINode subtree needs to be rendered.
It has a property, "childName", that is used to render the named child under this name. Indexed
children of this bean are not rendered at all. The "childName" is bound as an attribute to a VO.
So, you never set it declaratively. Instead, you specify the viewName and viewAttr attributes on
a switcher.
Corresponding web bean: OASwitcherBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified class
Definition name for the application
module.
AM
The instance name of an
Instance application module.
Attribute The attribute set for the
Set
component.
Comment Comments
s
Controller The fully-qualified class
Class
name for the controller
object.
CSS
Overrides the default CSS
Class
class.
Data Type The type of data. Valid
only when used in table
region. The legal values
are VARCHAR2, DATE,
DATETIME,
BIGDECIMAL, NUMBER,
BOOLEAN, and CLOB.
Document The name of the
Name
component
140

Type

Default Personali Translat


Value
zable
able

XML
Attribute

boolean

true

admin

no

adminCusto
mizable

string

null

null

no

amDefName

string

null

null

no

jrad:attribute null
SetRef
string
null

null

no

amUsageNa
me
use

null

no

comment

string

null

admin

no

controllerCla
ss

string

null

admin

no

styleClass

string

VARCH null
AR2

no

dataType

no

docName

jrad:refName null

null

Region Styles

Name
Document
ation
Comment
Export
View
Attribute
Extends

File
Version
ID

Description

Type

Formatted text for use


with Javadoc.

string

The alternate view


attribute for use when
exporting. Valid only when
used in table region.
A reference to another
component that creates a
different instance of that
component at runtime.
The version of the file.

string

Default Personali Translat


Value
zable
able
from
null
templat
e file
null
admin

XML
Attribute

no

not
applicable

no

exportByVie
wAttr

jrad:compon null
entRef

null

no

extends

string

null

null

no

file-version

null

null

no

id

none

null

no

initSortSeq

false

null

no

cellNoWrapF
ormat

null

null

no

version

null

null

no

regionName

false

null

no

postDefault

null

admin

true

prompt

true

user

no

rendered

null

no

scope

standar null
d

no

securityMode

The unique name of this Name


component.
Initial Sort Indicates the initial sort
string
Sequence sequence for each search.
The legal values are
none, first, second, and t
hird.
No Wrap Indicates if cell contents boolean
should be wrapped. Valid
only when used in table
region.
OA
The Oracle Applications jrad:version
Extension Extension version with
Version
which the file was created
or updated.
Personaliz The region label used for string
ation
Personalization.
Label
Post Initial Indicates if rows which are boolean
Values
made dirty only by the
defaulting of Initial Values
are to be posted.
Prompt
The text label for the
string
component.
Rendered Indicates if the component boolean
is rendered.
Scope
The Base Packages which jrad:scope
are allowed to reuse this
component.
Security Defines the security mode string
Mode
used to secure the region.

141

OA Extension Component Reference

Name

Description

Type

If set to selfSecured it is
the developer's
responsibility to handle
security validation. The
legal values are
standard, and selfSecure
d.
Sort
Indicates if the user can string
Allowed sort this column. Valid
only when used in table
region. The legal values
are
yes, no, ascending, and
descending.
Sort By
The alternate view
string
View
attribute name for use
Attribute when sorting. Valid only
when used in table region.
User
Indicates if a user can
boolean
Personaliz personalize this
ation
component. Valid only
when used in table region.
View
The name of the view
string
Attribute attribute.
View
The name of the view
string
Instance object instance. Valid only
when used in table region.
xml:lang Identifies the language
optional
contained within this
component.

Default Personali Translat


Value
zable
able

XML
Attribute

no

admin

no

sortState

null

user

no

sortByViewAt
tr

false

admin

no

userCustomi
zable

null

null

no

viewAttr

null

null

no

viewName

null

null

no

xml:lang

Element Children
Name Quantity
case

142

Description

1 or more Used with the SwitcherBean to decide which child must be rendered.

Region Styles

table
Description
The table region is used to display tabular data. It also supports selection (both single and
multiple), sorting, record navigation, totalling and detail-disclosure.
Note that totalling can be enabled for any column except for the first column in a table.
Classic Table Accessibility Support
To support accessibility for screen readers, you must identify a column in a classic table as a
row header. Every row in the table must refer to a column as the row header that uniquely
identifies the row so the screen reader can read it. Screen reader users must also define their
Accessibility mode by setting the profile "Self Service Accessibility Features" to Screen Reader
Optimized.
The underlying UIX oracle.cabo.ui.beans.table.TableBean supports accessibility by
defaulting a table's first column as the row header. However, you can set a different column as
the row header, especially if a user is likely to personalize the table by turning off rendering of
the first column or if the first column can return no data. Note that for a classic table, you may
only set an immediate child under the table as a row header column, and not a recursive child
item under an immediate child.
To declaratively set a column as a row header, in the OA Extension Property Inspector, specify
a column ID (String) for the Row Header Column property (XML attribute: rowheadercol) of
the classic table region.
To programmatically set a column as a row header, use the following API on OATableBean:
setRowHeaderColumn(<columnName>);
As of Release 12.2, you may also personalize the Row Header Col property of a Classic
Table to identify a column as the Row Header for screen reader accessibility.
Corresponding web bean: OATableBean

Properties
Name

Description

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

143

OA Extension Component Reference

Additional
Text
Admin
Personaliz
ation

Additional help text. string

Indicates if an
boolean
Administrator can
personalize this
component.
AM
The fully-qualified string
Definition class name for the
application module.
AM
The instance name string
Instance of an application
module.
Attribute
The attribute set for jrad:attributeS
Set
the component.
etRef
Child View The name of the
string
Attribute
child view attribute.
Comments Comments
string
Controller The fully-qualified string
Class
class name for the
controller object.
CSS Class Overrides the
string
default CSS class.
Detail View The view attribute string
Attribute
that determines if
that particular row
is to be stamped
with the detail child.
Disable
Indicates if
boolean
Client Side validation should
Validation not occur on the
web tier during a
form submit.
Disable
Indicates if
boolean
Server
validation should
Side
not occur on the
Validation business tier during
a form submit.
Document The name of the
jrad:refName
Name
component
Document Formatted text for string
ation
use with Javadoc.
Comment
Enable
Enable columns to boolean
Column
be hidden/shown
Hide Show by end users.
144

null

admin

yes

shortDesc

true

admin

no

adminCustomizabl
e

null

null

no

amDefName

null

null

no

amUsageName

null

null

no

use

null

null

no

childViewAttrName

null
null

null
admin

no
no

comment
controllerClass

null

admin

no

styleClass

null

null

no

detailViewAttr

false null

no

unvalidated

false null

no

serverUnvalidated

null

no

docName

no

not applicable

no

columnHideShowE
nabled

null

from null
templ
ate
file
true admin

Region Styles

Enable
Column
Reorder
Enable
Column
Resize
Enable
Detach

Enable columns to
be reordered by
end users.
Enable columns to
be resized by end
users.
Enable the table to
be detached and
maximized in the
browser.
Enable
Enable horizontal
Horizontal scroll bars.
Scroll
Extends
A reference to
another component
that creates a
different instance of
that component at
runtime.
File
The version of the
Version
file.
Help
The target name
Target
for the page online
help.
Help
This application will
Target
be used to
Appl Short construct URI of
Name
the "help" icon in
the global menu of
the page.This
makes the help
pages from the
other applications
referenceable.
ID
The unique name
of this component.
Message The application
Appl Short short name that
Name
owns the message.
Message The name of the
Name
message.
OA
The Oracle
Extension Applications
Version
Extension version
with which the file
was created or
updated.

boolean

true

admin

no

colReorderEnable
d

boolean

true

admin

no

colResizeEnabled

boolean

true

admin

no

detachEnabled

boolean

true

admin

no

horizontalScrollEn
abled

jrad:compone null
ntRef

null

no

extends

string

null

null

no

file-version

string

null

null

no

helpTarget

string

null

null

no

helpTargetAppSho
rtName

Name

null

null

no

id

string

null

admin

no

messageAppShort
Name

string

null

admin

no

messageName

jrad:version

null

null

no

version

145

OA Extension Component Reference

Personaliz The region label


string
ation Label used for
Personalization.
Post Initial Indicates if rows
boolean
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Record
Indicates if Record boolean
History
History feature is
Enabled
enabled.
Records
The maximum
unsignedInt
Displayed number of rows to
display.
Rendered Indicates if the
boolean
component is
rendered.
Row
Indicates if Scope unsignedInt
Header
attribute is to be
Col
added to Table.
Row
The view attribute string
Header
for the row header.
View
Attribute
Scope
The Base
jrad:scope
Packages which
are allowed to
reuse this
component.
Security
Defines the
string
Mode
security mode used
to secure the
region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The
legal values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its
own.
Text
The text label for
string
146

null

null

no

regionName

false null

no

postDefault

false admin

no

recordHistoryEnabl
ed

10

user

no

blockSize

true

user

no

rendered

null

admin

no

rowheadercol

null

null

no

rowHeaderViewAtt
r

null

no

scope

stand null
ard

no

securityMode

false null

no

standalone

null

no

text

admin

Region Styles

the component.
User
Indicates if a user boolean
Personaliz can personalize
ation
this component.
View Link The name of the
string
Instance View Link Instance
establishing
master-detail
relationship
between outer and
inner repeating
containers.
Width
Indicates the width string
in pixels or as a
percentage (if %
sign included).
xml:lang
Identifies the
optional
language contained
within this
component.

false admin

no

userCustomizable

null

null

no

viewLinkName

null

null

no

width

null

null

no

xml:lang

Element Children
Name
detail
tableActions

Quantity
Description
0 through 1 Node to stamp below every row which is disclosed.
0 through 1 Component used for performing table actions that are independent
of row selection.
tableSelection 0 through 1 SingleSelectionBean or MultipleSelectionBean to render with the
table.

147

OA Extension Component Reference

tableLayout
Description
The tableLayout region is a thin wrapper around the HTML's table element. It contains a series
of rowLayout elements.
Corresponding web bean: OATableLayoutBean

Properties
Name

Add
Indexed
Children
Admin
Personaliz
ation
AM
Definition
AM
Instance
Attribute
Set
Child View
Attribute
Child View
Instance

Comments
Controller
Class
CSS Class

148

Description

Indicates if indexed
children will be
automatically added
to this UI node tree.
Indicates if an
Administrator can
personalize this
component.
The fully-qualified
class name for the
application module.
The instance name
of an application
module.
The attribute set for
the component.
The name of the
child view attribute.
Renders an
instance of the
object for each row
in the View
Instance.
Comments
The fully-qualified
class name for the
controller object.
Overrides the
default CSS class.

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

null

no

addChildren

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null

null

no

use

null

no

string

null

null

no

childViewAttrNam
e
childViewUsageNa
me

string
string

null
null

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

Region Styles

Name

Document
Name
Document
ation
Comment
Extends

File
Version
Help
Target
Help
Target
Appl Short
Name

Horizontal
Alignment

ID
OA
Extension
Version

Personaliz
ation Label

Description

The name of the


component
Formatted text for
use with Javadoc.

Type

Defau Personaliz Translat XML Attribute


lt
able
able
Value
jrad:refName null
null
no
docName
string

from null
templ
ate
file
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
The version of the string
null
null
file.
The target name for string
null
null
the page online
help.
This application will string
null
null
be used to construct
URI of the "help"
icon in the global
menu of the
page.This makes
the help pages from
the other
applications
referenceable.
Horizontal
string
center null
alignment. The
acceptable values
are "center", "left",
"right", "start", and
"end".
The unique name of Name
null
null
this component.
The Oracle
jrad:version null
null
Applications
Extension version
with which the file
was created or
updated.
The region label
string
null
null
used for
Personalization.

no

not applicable

no

extends

no

file-version

no

helpTarget

no

helpTargetAppSho
rtName

no

hAlign

no

id

no

version

no

regionName

149

OA Extension Component Reference

Name

Description

Type

Post Initial Indicates if rows


boolean
Values
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Rendered Indicates if the
boolean
component is
rendered.
Scope
The Base Packages jrad:scope
which are allowed to
reuse this
component.
Security
Defines the security string
Mode
mode used to
secure the region. If
set to selfSecured it
is the developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its own.
View Link The name of the
string
Instance View Link Instance
establishing masterdetail relationship
between outer and
inner repeating
containers.
Width
Indicates the width string
in pixels or as a
percentage (if %
sign included).
xml:lang Identifies the
optional
language contained
within this
component.

150

Defau Personaliz Translat XML Attribute


lt
able
able
Value
false null
no
postDefault

true

user

no

rendered

null

no

scope

stand null
ard

no

securityMode

false null

no

standalone

null

null

no

viewLinkName

null

null

no

width

null

null

no

xml:lang

Region Styles

train
Description
The train region is used to indicate the current page of a multi-page process. The highlighted
"step" indicates the currently active page. The train has one property, "selectedIndex", which is
the index of the selected "step".
Corresponding web bean: OATrainBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
Allow
Indicates if each train
Interaction stop should be
rendered as a link.
Attribute
The attribute set for
Set
the component.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the default
CSS class.
Disable
Indicates if validation
Client Side should not occur on
Validation the web tier during a
form submit.
Document The name of the
Name
component
Documenta Formatted text for
tion
use with Javadoc.
Comment
Extends
A reference to
another component
that creates a
different instance of

Type

boolean

boolean

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
true admin
no
adminCustomi
zable

null

no

formSubmitted

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

boolean

false

null

no

unvalidated

jrad:refName

null

null

no

docName

from null
templ
ate file
jrad:compone null
null
ntRef

no

not applicable

no

extends

string

false

151

OA Extension Component Reference

Name

Description

that component at
runtime.
File
The version of the
Version
file.
ID
The unique name of
this component.
OA
The Oracle
Extension Applications
Version
Extension version
with which the file
was created or
updated.
Personaliz The region label used
ation Label for Personalization.
Post Initial Indicates if rows
Values
which are made dirty
only by the defaulting
of Initial Values are to
be posted.
Rendered Indicates if the
component is
rendered.
Scope
The Base Packages
which are allowed to
reuse this
component.
Security
Defines the security
Mode
mode used to secure
the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Sub Train Indicates if images
are rendered before
and after the train to
indicate that this train
is part of a subprocess.
xml:lang
Identifies the
152

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value

string

null

null

no

file-version

Name

null

null

no

id

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

stand null
ard

no

securityMode

boolean

false

null

no

subTrain

optional

null

null

no

xml:lang

Region Styles

Name

Description

Type

Defau Personaliz Translata XML Attribute


lt
able
ble
Value

language contained
within this
component.

153

OA Extension Component Reference

tree
Description
The tree region is used to display objects in a hierarchical format. It factors data into child/leaf
nodes and parent nodes which are either expanded or collapsed. The purpose of the tree
control is to allow users to quickly browse through complex sets of hierarchical objects and
access detailed information for a record by highlighting it in the tree. The visual representation
of the hierarchy using the tree is also intended to show the relationship between a set of objects
with respect to one another.
Corresponding web bean: OATreeBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
AM
The fully-qualified
Definition class name for the
application module.
AM
The instance name
Instance of an application
module.
Attribute
The attribute set for
Set
the component.
Comments Comments
Controller The fully-qualified
Class
class name for the
controller object.
CSS Class Overrides the
default CSS class.
Disable
Indicates if
Client Side validation should
Validation not occur on the
web tier during a
form submit.
Document The name of the
Name
component
154

Type

Defau Personaliz Translat


lt
able
able
Value

XML Attribute

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
controllerClass

string

null

admin

no

styleClass

boolean

null

null

no

unvalidated

jrad:refName null

null

no

docName

Region Styles

Document Formatted text for


ation
use with Javadoc.
Comment
Extends

File
Version
Help
Target
Help
Target
Appl Short
Name

ID

OA
Extension
Version

Personaliz
ation Label
Post Initial
Values

Rendered

string

from null
templ
ate
file
A reference to
jrad:compone null
null
another component ntRef
that creates a
different instance of
that component at
runtime.
The version of the string
null
null
file.
The target name
string
null
null
for the page online
help.
This application will string
null
null
be used to
construct URI of
the "help" icon in
the global menu of
the page.This
makes the help
pages from the
other applications
referenceable.
Maps to the Item
Name
null
null
Name property of
the Default Tree
region-item.
The Oracle
jrad:version null
null
Applications
Extension version
with which the file
was created or
updated.
The region label
string
null
null
used for
Personalization.
Indicates if rows
boolean
false null
which are made
dirty only by the
defaulting of Initial
Values are to be
posted.
Indicates if the
boolean
true user
component is
rendered.

no

not applicable

no

extends

no

file-version

no

helpTarget

no

helpTargetAppSho
rtName

no

id

no

version

no

regionName

no

postDefault

no

rendered

155

OA Extension Component Reference

Scope

The Base
jrad:scope
Packages which
are allowed to
reuse this
component.
Security
Defines the
string
Mode
security mode used
to secure the
region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The
legal values are
standard, and selfS
ecured.
Standalon Indicates if this
boolean
e
region can be
rendered on its
own.
Text
The text label for
string
the component.
xml:lang
Identifies the
optional
language contained
within this
component.

null

no

scope

stand null
ard

no

securityMode

false null

no

standalone

null

admin

true

text

null

null

no

xml:lang

Element Children
Name
members

Quantity
1

Description
Grouping used for specifying tree's members

nodeDef
Name

Action
Type

Description

The action type to fire for


the component. It should
be either "fireAction" or
"none."
Admin Indicates if an
Persona Administrator can
lization personalize this
component.
156

Type

Defaul Persona Transl


XML
t
lizable atable Attribute
Value

string

none

null

no

primaryCli
entAction

boolean

true

admin

no

adminCust
omizable

Region Styles

Attribute
Set
Child
Object
Type

The attribute set for the


component.
Object Type of child
nodes, used when
displaying record set
navigation controls.
Comme Comments
nts
CSS
Overrides the default CSS
Class
class.
Data
The type of data. The legal
Type
values are
VARCHAR2, DATE, DATE
TIME, BIGDECIMAL,
NUMBER, BOOLEAN, and
CLOB.
Destinat The function to invoke.
ion
Function
Destinat The Destination URI.
ion URI
Disable Indicates if validation
Client
should not occur on the
Side
web tier during a form
Validatio submit.
n
Disable Indicates if validation
Server should not occur on the
Side
business tier during a form
Validatio submit.
n
Docume The name of the
nt Name component
Event
Name of the event.
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Icon
the URI for the icon file.
URI
Paramet A list of parameter names
ers
and values to be submitted
by the action.
Record The maximum number of
Set Size records that can be
displayed under each

jrad:attributeSetRef

null

null

no

use

string

null

null

true

childTypeT
ext

string

null

null

no

comment

string

null

admin

no

styleClass

string

VARC null
HAR2

no

dataType

string

null

admin

no

invokeFun
c

anyURI

null

admin

no

destination

boolean

null

null

no

unvalidate
d

boolean

false

null

no

serverUnv
alidated

jrad:refName

null

null

no

docName

string
jrad:componentRef

null
null

null
null

no
no

event
extends

anyURI

null

admin

no

icon

name-value pair

null

null

no

parameter
s

ui:nonNegativeIntege null
rExpressionType

null

no

childBlock
Size

157

OA Extension Component Reference

node.
Rendere Indicates if the component
d
is rendered.
Scope The Base Packages which
are allowed to reuse this
component.
Submit Indicates if the action will
cause a form submit
Target The name of the target
Frame frame for the link.
View
The name of the view
Attribute attribute.
View
The name of the view
Instance object instance.
Warn
Warns the user if there are
About
pending changes that will
Change be lost, and allows them to
s
cancel the current action
or discard the changes
and continue with the
current action.
xml:lang Identifies the language
contained within this
component.

boolean

null

user

no

rendered

jrad:scope

null

no

scope

boolean

null

null

no

string

null

null

no

string

null

null

no

formSubmi
tted
targetFram
e
viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAbout
Changes

optional

null

null

no

xml:lang

childNode
Name

Additional
Text
Admin
Personalizat
ion

Description

Additional
help text.
Indicates if an
Administrator
can
personalize
this
component.
AM
The fullyDefinition
qualified
class name
for the
application
module.
AM Instance The instance
name of an
158

Type

string

Defa Personaliza Translata XML Attribute


ult
ble
ble
Value
null admin
yes
shortDesc

boolean

true

admin

no

adminCustomizabl
e

string

null

null

no

amDefName

string

null

null

no

amUsageName

Region Styles

application
module.
Ancestor
Optionally set
Node
only on the
leaf level
&lt;childNode
&gt; element
to recursively
point to one
of the
ancestor
nodes.
Attribute Set The attribute
set for the
component.
Comments Comments
CSS Class Overrides the
default CSS
class.
Document The name of
Name
the
component
Extends
A reference
to another
component
that creates a
different
instance of
that
component at
runtime.
Personalizat The region
ion Label
label used for
Personalizati
on.
Rendered Indicates if
the
component is
rendered.
Scope
The Base
Packages
which are
allowed to
reuse this
component.
View Link
The name of
Accessor
the View Link

jrad:localRef

null

null

no

ancestorNode

jrad:attributeSe null
tRef

null

no

use

string
string

null
null

null
admin

no
no

comment
styleClass

jrad:refName

null

null

no

docName

jrad:component null
Ref

null

no

extends

string

null

null

no

regionName

boolean

null

user

no

rendered

jrad:scope

null

no

scope

string

null

null

no

viewLinkAccessorN
ame
159

OA Extension Component Reference

View Link
Instance

xml:lang

Accessor for
the child data.
The name of string
the View Link
Instance for
the child data.
Identifies the optional
language
contained
within this
component.

null

null

no

viewLink

null

null

no

xml:lang

Element Children
Name
members

160

Quantity
0 through 1

Description
Grouping used for specifying tree's members.

Item Styles
attachmentImage
Description
An attachmentImage item style is used to display multi-row attachments that are represented as
icons. An attachment image uses a Switcher bean internally to switch between one of two
image beans.
attachmentImage is an extension of <ui:base>. All attributes supported by <ui:base> are
inherited by attachmentImage.
Corresponding web bean: OAAttachmentImageBean

Properties
Name

Descripti
Type
on
Admin
Indicates boolean
Personalizat if an
ion
Administra
tor can
personaliz
e this
componen
t.
Attribute Set The
jrad:attributeSe
attribute tRef
set for the
componen
t.
Automatic Indicates boolean
Save
if
automatic
save is
enabled.
Comments Comment string
s
CSS Class Overrides string
the default
CSS
class.

Default Personaliza Translata


XML Attribute
Value
ble
ble
true
admin
no
adminCustomizable

null

null

no

use

false

null

no

autoCommitEnable
d

null

null

no

comment

null

admin

no

styleClass

161

OA Extension Component Reference

Document
Name

The name
of the
componen
t
Disable
Indicates
Client Side if
Validation validation
should not
occur on
the web
tier during
a form
submit.
Disable
Indicates
Server Side if
Validation validation
should not
occur on
the
business
tier during
a form
submit.
Enable
Indicates
Document if the
Catalog
Document
Catalog is
enabled
for the
componen
t.
Export View The
Attribute
alternate
view
attribute
for use
when
exporting.
Extends
A
reference
to another
componen
t that
creates a
different
instance
of that
componen
t at
162

jrad:refName

null

null

no

docName

boolean

true

null

no

unvalidated

boolean

true

null

no

serverUnvalidated

boolean

true

admin

no

enableDocumentCa
talog

string

null

admin

no

exportByViewAttr

null

no

extends

jrad:component null
Ref

Item Styles

runtime.
Inline
Indicates boolean
Attachment whether
Enabled
inline
attachmen
t capability
is enabled
or not.
No Wrap
Indicates boolean
if cell
contents
should be
wrapped.
Prompt
The text string
label for
the
componen
t.
Render
Indicates boolean
Search
if the
Region
search
region is
rendered.
Rendered Indicates boolean
if the
componen
t is
rendered.
Scope
The Base jrad:scope
Packages
which are
allowed to
reuse this
componen
t.
User
Indicates boolean
Personalizat if a user
ion
can
personaliz
e this
componen
t.
View
The name string
Instance
of the
view
object
instance.
Virus Scan Indicates boolean

(Default) admin

no

inlineAttachmentEn
abled

false

no

cellNoWrapFormat

Attachme admin
nts

true

prompt

true

null

no

searchRegionRend
ered

true

user

no

rendered

null

no

scope

false

admin

no

userCustomizable

null

null

no

viewName

false

admin

no

virusScanEnabled

null

163

OA Extension Component Reference

Enabled

xml:lang

if Virus
Scan is
enabled
on file
attachmen
ts.
Identifies optional
the
language
contained
within this
componen
t.

null

null

no

xml:lang

Element Children
Name
entityMappings

Quantity
1

Description
Defines the entity and item relationships.

entityMap
Name
Attribute
Set

Description

Type

Defaul Personalizabl Translatabl


t Value
e
e

The attribute jrad:attributeSetRe null


set for the
f
component.
Comment Comments. string
null
s
Delete
Indicates if boolean
true
Allowed the user can
delete
attachments
from the
current
object.
Entity
The name of string
null
the
attachment
entity which
defines the
primary key
relationships
.
Insert
Indicates if boolean
true
Allowed new
attachments
164

XML
Attribute

null

no

use

null

no

comment

null

no

deleteAllowed

null

no

entityId

null

no

insertAllowed

Item Styles

Show All

Update
Allowed

can be
created for
this entity.
Indicates if boolean
the user can
view any
attachment
for the
current
object,
regardless
of category.
Indicates if boolean
the user can
edit the
attachment
content.

false

null

no

showAll

true

null

no

updateAllowe
d

Element Children
Name
categoryMappings
primaryKeys

Quantity
0 through 1
0 through 1

Description
Defines the entity and category relationships.
Defines the primary keys.

categoryMap
Name

Descriptio
n
Attribute The
Set
attribute set
for the
component.
Category The
attachment
category
name.
Comment Comments.
s
Secured Indicates if
the object is
secured by
grants
model.

Type

Defaul Personalizabl Translatabl


XML
t Value
e
e
Attribute
jrad:attributeSetRe null
null
no
use
f

string

null

null

no

categoryNam
e

string

null

null

no

comment

boolean

false

admin

no

secured

primaryKey
165

OA Extension Component Reference

Name
Attribute
Set

Description

Type

Default Personalizable Translatable XML


Value
Attribute

The attribute jrad:attributeSetRef null


set for the
component.
Comments Comments. string
null
View
The name of string
null
Attribute the view
attribute.

166

null

no

use

null
null

no
no

comment
viewAttr

Item Styles

attachmentLink
Description
An attachmentLink item style is used to display single-row attachments.
attachmentLink is an extension of messageStyledText. All attributes supported by
messageStyledText are inherited by attachmentLink. See the section on messageStyledText for
a list of attributes available on the messageStyledText element.
Corresponding web bean: OAMessageAttachmentLinkBean

Properties
Name

Description

Admin
Indicates if an Administrator
Personali can personalize this
zation
component.
Attribute The attribute set for the
Set
component.
Automati Indicates if automatic save
c Save is enabled.
Commen Comments
ts
CSS
Overrides the default CSS
Class
class.
Docume The name of the component
nt Name
Disable Indicates if validation should
Client
not occur on the web tier
Side
during a form submit.
Validatio
n
Disable Indicates if validation should
Server not occur on the business
Side
tier during a form submit.
Validatio
n
Enable Indicates if the Document
Docume Catalog is enabled for the
nt
component.
Catalog

Type
boolean

Default Personal Transla XML Attribute


Value izable
table
true

admin

no

adminCustomiz
able

jrad:attribut null
eSetRef
boolean
false

null

no

use

null

no

string

null

null

no

autoCommitEna
bled
comment

string

null

admin

no

styleClass

jrad:refNam null
e
boolean
true

null

no

docName

null

no

unvalidated

boolean

true

null

no

serverUnvalidat
ed

boolean

true

admin

no

enableDocumen
tCatalog

167

OA Extension Component Reference

Extends A reference to another


component that creates a
different instance of that
component at runtime.
Inline
Indicates whether inline
Attachm attachment capability is
ent
enabled or not.
Enabled
Link Text The Text for the attachment
link.
Long Tip The fully-qualified reference
Region to the long tip region.
Prompt The Prompt for the
attachment link.
Render Indicates if the search
Search region is rendered.
Region
Rendere Indicates if the component is
d
rendered.
Scope
The Base Packages which
are allowed to reuse this
component.
Tip
The application short name
Message that owns the tip message.
Appl
Short
Name
Tip
The name of the tip
Message message.
Name
Tip Type The type of tip. The legal
values are
dateFormat, longMessage, s
hortTip, and none.
View
The name of the view object
Instance instance.
Virus
Indicates if Virus Scan is
Scan
enabled on file attachments.
Enabled
xml:lang Identifies the language
contained within this
component.

Element Children

168

jrad:compo null
nentRef

null

no

extends

boolean

(Defaul admin
t)

no

inlineAttachmen
tEnabled

string

View

true

text

jrad:refNam null
admin
e
string
Attach user
ments
boolean
true
null

no

longTipRegion

true

prompt

no

searchRegionR
endered

boolean

user

no

rendered

jrad:scope .

null

no

scope

string

null

admin

no

tipMessageApp
ShortName

string

null

admin

no

tipMessageNam
e

string

none

admin

no

tipType

string

null

null

no

viewName

boolean

false

admin

no

virusScanEnabl
ed

optional

null

null

no

xml:lang

true

null

Item Styles

Name
entityMappings

Quantity
1

Description
Defines the entity and item relationships.

entityMap
Name

Description

Type

Defaul Personalizabl Translatabl


XML
t Value
e
e
Attribute
Attribute The attribute jrad:attributeSetRe null
null
no
use
Set
set for the
f
component.
Comment Comments. string
null
null
no
comment
s
Delete
Indicates if boolean
true
null
no
deleteAllowed
Allowed the user can
delete
attachments
from the
current
object.
Entity
The name of string
null
null
no
entityId
the
attachment
entity which
defines the
primary key
relationships
.
Insert
Indicates if boolean
true
null
no
insertAllowed
Allowed new
attachments
can be
created for
this entity.
Show All Indicates if boolean
false null
no
showAll
the user can
view any
attachment
for the
current
object,
regardless
of category.
Update
Indicates if boolean
true
null
no
updateAllowe
Allowed the user can
d
edit the
attachment
content.
169

OA Extension Component Reference

Element Children
Name
categoryMappings
primaryKeys

Quantity
0 through 1
0 through 1

Description
Defines the entity and category relationships.
Defines the primary keys.

categoryMap
Name

Descriptio
n

Attribute
Set

The
attribute set
for the
component.
Category The
attachment
category
name.
Comment Comments.
s
Secured Indicates if
the object is
secured by
grants
model.

Type

Defaul Personalizabl Translatabl


t Value
e
e

XML
Attribute

jrad:attributeSetRe null
f

null

no

use

string

null

null

no

categoryNam
e

string

null

null

no

comment

boolean

false

admin

no

secured

primaryKey
Name

Default Personalizable Translatable XML


Value
Attribute
Attribute The attribute jrad:attributeSetRef null
null
no
use
Set
set for the
component.
Comments Comments. string
null
null
no
comment
View
The name of string
null
null
no
viewAttr
Attribute the view
attribute.

170

Description

Type

Item Styles

attachmentTable
Description
An attachmentTable item style is used to display attachments in regions that typically show just
one row in a view, such as header and flow layout.
attachmentTable is an extension of header. All attributes supported by header are inherited by
attachmentTable. See header for additional information about the header element.
Corresponding web bean: OAAttachmentTableBean

Properties
Name

Description

Admin
Indicates if
Personaliza an
tion
Administrato
r can
personalize
this
component.
Attribute
The attribute
Set
set for the
component.
Automatic Indicates if
Save
automatic
save is
enabled.
Comments Comments
Copy
Indicates if
Attachment Copying is
Enabled
enabled on
file
attachments
.
CSS Class Overrides
the default
CSS class.
Disable
Indicates if
Client Side validation
Validation should not

Type

boolean

Defaul Personaliza Translata


XML Attribute
t
ble
ble
Value
true
true
no
adminCustomizable

jrad:attributeSe null
tRef

null

no

use

boolean

false

null

no

autoCommitEnabled

string
boolean

null
false

null
admin

no
no

comment
copyAttachmentEna
bled

string

null

admin

no

styleClass

boolean

true

null

no

unvalidated

171

OA Extension Component Reference

occur on the
web tier
during a
form submit.
Disable
Indicates if
Server Side validation
Validation should not
occur on the
business tier
during a
form submit.
Enable
Indicates if
Document the
Catalog
Document
Catalog is
enabled for
the
component.
Enable
Indicates if
Oracle Files attachments
will be
stored in
Oracle Files.
Extends
A reference
to another
component
that creates
a different
instance of
that
component
at runtime.
Help Target This
Appl Short application
Name
will be used
to construct
URI of the
"help" icon
in the global
menu of the
page.This
makes the
help pages
from the
other
applications
referenceabl
e.
Icon URI
The URI for
172

boolean

true

null

no

serverUnvalidated

boolean

true

admin

no

enableDocumentCat
alog

boolean

true

null

no

oracleFilesEnabled

jrad:component null
Ref

null

no

extends

string

null

admin

no

helpTargetAppShort
Name

string

null

admin

no

icon

Item Styles

the icon file.


Inline
Indicates
Attachment whether
Enabled
inline
attachment
capability is
enabled or
not.
Personaliza The region
tion Label label used
for
Personalizat
ion.
Post Initial Indicates if
Values
rows which
are made
dirty only by
the
defaulting of
Initial Values
are to be
posted.
Record
Indicates if
History
Record
Enabled
History
feature is
enabled for
this option.
Rendered Indicates if
the
component
is rendered.
Render
Indicates if
Search
the search
Region
region is
rendered.
Text
The text
label for the
component.
View
The name of
Instance
the view
object
instance.
Virus Scan Indicates if
Enabled
Virus Scan
is enabled
on file
attachments

boolean

(Defau admin
lt)

no

inlineAttachmentEna
bled

string

null

null

no

regionName

boolean

false

admin

no

postDefault

boolean

false

admin

no

recordHistoryEnable
d

boolean

true

user

no

rendered

boolean

true

null

no

searchRegionRende
red

string

null

admin

yes

text

string

null

null

no

viewName

boolean

false

admin

no

virusScanEnabled

173

OA Extension Component Reference

Element Children
Name
entityMappings

Quantity
1

Description
Defines the entity and item relationships.

entityMap
Name

Descriptio
n

Type

Approval Function
string
Function Name for
Name
the
approval
process.
Approval View
string
View
Attribute to
Attribute determine if
approval
process is
required.
Attribute The
jrad:attributeSet
Set
attribute set Ref
for the
component.
Commen Comments. string
ts
Delete
Indicates if boolean
Allowed the user
can delete
attachment
s from the
current
object.
Entity
The name string
of the
attachment
entity which
defines the
primary key
relationship
s.
Insert
Indicates if boolean
Allowed new
174

Defau Personalizab Translatab


lt
le
le
Value

XML Attribute

null

null

no

approvalFunctionNa
me

null

null

no

approvalViewAttr

null

null

no

use

null

null

no

comment

true

null

no

deleteAllowed

null

null

no

entityId

true

null

no

insertAllowed

Item Styles

attachment
s can be
created for
this entity.
Show All Indicates if boolean
the user
can view
any
attachment
for the
current
object,
regardless
of category.
Update Indicates if boolean
Allowed the user
can edit the
attachment
content.

false

null

no

showAll

true

null

no

updateAllowed

Element Children
Name
categoryMappings
primaryKeys

Quantity
0 through 1
0 through 1

Description
Defines the entity and category relationships.
Defines the primary keys.

categoryMap
Name

Descriptio
n
Attribute The
Set
attribute set
for the
component.
Category The
attachment
category
name.
Comment Comments.
s
Secured Indicates if
the object is
secured by
grants
model.

Type

Defaul Personalizabl Translatabl


XML
t Value
e
e
Attribute
jrad:attributeSetRe null
null
no
use
f

string

null

null

no

categoryNam
e

string

null

null

no

comment

boolean

false

admin

no

secured

175

OA Extension Component Reference

primaryKey
Name
Attribute
Set

Description

Type

Default Personalizable Translatable XML


Value
Attribute

The attribute jrad:attributeSetRef null


set for the
component.
Comments Comments. string
null
View
The name of string
null
Attribute the view
attribute.

176

null

no

use

null
null

no
no

comment
viewAttr

Item Styles

button
Description
A button item style creates a push button, which allows the user to trigger some action in
response to a click. The button fires an "onclick" event when it is activated. Buttons will not
render any child nodes.
Corresponding web bean: OAButtonBean

Properties
Name

Description

Type

Access
Key

Default Personal Transla


Value
izable
table

XML
Attribute

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be either
"fireAction", "firePartialAction"
or "none."
Additiona Additional help text.
string
l Text
Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.

null

admin

no

accessKey

none

null

no

primaryClie
ntAction

null

admin

yes

shortDesc

true

admin

no

adminCusto
mizable

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

Destinati The function to invoke.


on
Function
Destinati The destination URI.
on URI

null

admin

no

invokeFunc

null

no

destination

string

uriReferenc null
e

177

OA Extension Component Reference

Name
Disable
Server
Side
Validatio
n
Disabled

Description
Indicates if validation should
not occur on the business tier
during a form submit.

Type
boolean

Indicates if the element is


boolean
disabled.
Documen The name of the component
jrad:refNam
t Name
e
Export
The alternate view attribute for string
View
use when exporting.
Attribute
Extends A reference to another
jrad:compo
component that creates a
nentRef
different instance of that
component at runtime.
Horizonta Horizontal alignment. The legal string
l
values are
Alignmen center, left, right, start, and e
nd.
t
ID
The unique name of this
Name
component.
Popup
Indicates whether the pop-up boolean
Enabled is enabled.
Popup ID The unique name of the pop- string
up.
Popup
Indicates on what action type string
Render the event is to be rendered for
Event
the pop-up.
Prompt The text label for the
string
component.
Rendere Indicates if the component is boolean
d
rendered.
Scope
The Base Packages which are jrad:scope
allowed to reuse this
component.
Target
The name of the target frame string
Frame
for the link.
Text
The text label for the
string
component.
View
The name of the view attribute. string
Attribute
View
The name of the view object
string
178

Default Personal Transla


Value
izable
table

XML
Attribute

false

null

no

serverUnvali
dated

null

null

no

disabled

null

null

no

docName

null

admin

no

exportByVie
wAttr

null

null

no

extends

start

null

no

hAlign

null

null

no

id

false

admin

no

null

admin

no

popupEnabl
ed
popupId

onClick admin

no

popupRend
erEvent

null

admin

true

prompt

true

user

no

rendered

null

no

scope

null

admin

yes

targetFrame

null

admin

yes

text

null

null

no

viewAttr

null

null

no

viewName

Item Styles

Name
Instance
Warn
About
Changes

Description

Type

instance.
Warns the user if there are
boolean
pending changes that will be
lost, and allows them to cancel
the current action or discard
the changes and continue with
the current action.
xml:lang Identifies the language
optional
contained within this
component.

Default Personal Transla


Value
izable
table

XML
Attribute

true

null

no

warnAboutC
hanges

null

null

no

xml:lang

179

OA Extension Component Reference

exportButton
Description
The exportButton item style is used to export the displayed data of either a region or all regions
on a page to a comma separated value (csv) file. Only the beans that are rendered will be
exported. Each region on the exported file will have a row of column names followed by the
results.
In Windows, clicking on the export button will open a dialog that asks you to either open or save
the exported file. You could view the Excel file either by opening it directly or saving and then
opening it.
exportButton can be used as follows:

Exporting the data of all regions on a page.


To do this, create a contentFooter region under the pageLayout region of that specific
page. Then add an "Export Button" to the contentFooter region. If more than one button
needs to be added to the contentFooter, then they should be put under a flowLayout
region, which should then be added to the contentFooter.

Exporting data of a specific region on a page.


To do this, create an "Export Button" under the region whose data you want to export.
Then, in the container object, position this export button and set a view usage name for
this export button. The data of this VO will be exported.

Corresponding web bean: OAExportBean

Properties
oa:exportButton extends oa:submitButton and inherits all the properties from it. Please refer to
the submitButton section for more information on all submitButton properties.
Name

Additional
Text
Admin
Personaliz
ation
180

Description

Type

Defa Personaliz Translat XML Attribute


ult
able
able
Valu
e

Additional help text.

string

null

admin

yes

shortDesc

Indicates if an
Administrator can
personalize this
component.

boolean

true

admin

no

adminCustomi
zable

Item Styles

Name

Description

Attribute
Set
Comments
CSS Class

The attribute set for the


component.
Comments
Overrides the default
CSS class.
Indicates if validation
should not occur on the
web tier during a form
submit.
Indicates if validation
should not occur on the
business tier during a
form submit.
Indicates if the element
is disabled.
Indicates if all rows will
be exported, ignoring
the maximum fetch
size.
A reference to another
component that creates
a different instance of
that component at
runtime.
Horizontal alignment.
The legal values are
center, left, right, start,
and end.
Indicates if cell
contents should be
wrapped.
Indicates if the
component is rendered.
The text label for the
component.
The name of the view
object instance.

Disable
Client Side
Validation
Disable
Server
Side
Validation
Disabled
Export All
Rows

Extends

Horizontal
Alignment

No Wrap

Rendered
Text
View
Instance

Type

Defa Personaliz Translat XML Attribute


ult
able
able
Valu
e

jrad:attributeS null
etRef
string
null
string
null

null

no

use

null
admin

no
no

comment
styleClass

boolean

false null

no

unvalidated

boolean

false null

no

serverUnvalid
ated

boolean

false null

no

disabled

boolean

false null

no

exportAllRows

null

no

extends

string

start null

no

hAlign

boolean

false null

no

cellNoWrapFo
rmat

boolean

true

user

no

rendered

string

null

admin

yes

text

string

null

null

no

viewName

jrad:compone null
ntRef

181

OA Extension Component Reference

flex
Description
There are two types or styles of flex item styles: descriptive flex field and key flex field.
Descriptive flex fields provide customizable "expansion space" which can be used to track
additional information, important and unique to a customer's business, which would not
otherwise be captured by the form. For example, it can be a placeholder for additional
information or a link to another web page.
Key flex fields are "intelligent keys" made up of meaningful segments identifying such business
entities as general ledger accounts, part numbers, etc.
Corresponding web beans: OADescriptiveFlexBean, OAKeyFlexBean

Properties
Name

Description

Additional Additional help


Text
text.
Admin
Indicates if an
Personaliza Administrator
tion
can personalize
this component.
Appl Short The application
Name
short name that
owns the
Flexfield.
Attribute
The attribute set
Set
for the
component.
Comments Comments
CSS Class Overrides the
default CSS
class.
Display
Indicates if the
Context
context field is
Field
displayed.
Document The name of the
182

Type
string

Default Personaliz Translata XML Attribute


Value
able
ble
null
admin
yes
shortDesc

boolean

true

admin

no

adminCustomizab
le

string

null

null

no

flexFieldAppShort
Name

jrad:attributeS null
etRef

null

no

use

string
string

null
null

null
admin

no
no

comment
styleClass

boolean

true

null

no

displayContextFie
ld

jrad:refName

null

null

no

docName

Item Styles

Name
Name
Extends

Description

Type

component
A reference to jrad:compone
another
ntRef
component that
creates a
different
instance of that
component at
runtime.
Name
The name of the string
Flexfield.
Prompt
The text label for string
the flexfield,
used in the
personalization
window.
Read Only Indicates if the boolean
value can be
changed.
Rendered Indicates if the boolean
component is
rendered.
Scope
The Base
jrad:scope
Packages which
are allowed to
reuse this
component.
Segment The limited list string
List
of flexfield
segments.
Type
The type of the string
Flexfield. The
legal values are
key, and descri
ptive.
User
Indicates if a
boolean
Personaliza user can
tion
personalize this
component.
View
The name of the string
Instance
view object
instance.
xml:lang
Identifies the
optional
language
contained within

Default Personaliz Translata


Value
able
ble

XML Attribute

null

null

no

extends

null

null

no

flexName

null

admin

true

prompt

false

admin

no

readOnly

true

user

no

rendered

null

no

scope

null

admin

no

segmentList

descript null
ive

no

flexStyle

false

admin

no

userCustomizable

null

null

no

viewName

null

null

no

xml:lang

183

OA Extension Component Reference

Name

Description

Type

Default Personaliz Translata


Value
able
ble

XML Attribute

this component.

Element Children
Name
flexMaps

Quantity
1

Description
Defines the external references for a flexfield.

flexMap
Name

Descriptio
Type
Defaul Personalizabl
n
t Value
e
Attribute The
jrad:attributeSetRe null
null
Set
attribute set f
for the
component.
Comment Comments. string
null
null
s
Name
Specify the string
null
null
name.
Reference Value to be string
null
null
Value
set on the
named
parameter.
Refers
Indicates
boolean
false null
Context
whether the
value refers
to the
context
field.

184

Translatabl XML Attribute


e
no
use

no

comment

no

name

no

referenceValu
e

no

refersContext

Item Styles

formParameter
Description
The formParameter item style serves as a placeholder for submission parameters. It differs from
formValue in two important ways. First, formParameter does not support a "value" attribute.
Instead, the value is set only at form submission time. Second, a formParameter with a given
name can be added repeatedly to a form without ill effects; only one instance will appear. This is
markedly different from the formValue, where reuse causes the same value to appear multiple
times in the form submission.
Corresponding web bean: OAFormParameterBean

Properties
Name

Description

Admin
Indicates if an
Personaliz Administrator can
ation
personalize this
component.
Attribute
The attribute set for
Set
the component.
Comments Comments
Document The name of the
Name
component
Extends
A reference to
another component
that creates a
different instance of
that component at
runtime.
ID
The unique name of
this component.
Rendered Indicates if the
component is
rendered.
Scope
The Base Packages
which are allowed to
reuse this
component.
Security
Defines the security

Type

boolean

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
true

admin

no

adminCustomi
zable

jrad:attributeS null
etRef
string
null
jrad:refName null

null

no

use

null
null

no
no

comment
docName

jrad:compone null
ntRef

null

no

extends

Name

null

null

no

id

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

stand null

no

securityMode
185

OA Extension Component Reference

Name

Mode

xml:lang

186

Description

Type

mode used to secure


the region. If set to
selfSecured it is the
developer's
responsibility to
handle security
validation. The legal
values are
standard, and selfS
ecured.
Identifies the
optional
language contained
within this
component.

Defau Personaliz Translata XML Attribute


lt
able
ble
Value
ard

null

null

no

xml:lang

Item Styles

formattedText
Description
The formattedText item style accepts a string in its "text" attribute containing a very limited set of
HTML markup and outputs formatted results. It is not intended as anything near to a generic
HTML output engine, and will never be such. Developers needing this functionality must use the
rawText bean. For example, this bean does not support the use of HTML tables or HTML links,
so developers needing those should either use the tableLayout and link beans or use just the
rawText bean.
What this bean does provide is a limited ability to use a single source for translated or userprovided formatted text without further parsing or filtering or dangerous constructs (e.g.,
Javascript), and with some hope of successful output to non-HTML displays. It also supports
more attributes than the rawText bean; for example, it supports styleClass.
This component supports the following HTML markup:

<br>
<hr>
<li>,<ol>,<ul>
<p>
<b>
<i>
<tt>
<big>
<small>
<pre>
<span>
<a>

and the following entities:

<
>
&

"

In addition, the CSS attributes ("class" and "style") and "href" are supported; all others are
ignored. Other elements or entities will be ignored.
Corresponding web bean: OAFormattedTextBean

187

OA Extension Component Reference

Properties
Name

Description

Type

Additiona Additional help text.


string
l Text
Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.
Documen
t Name
Export
View
Attribute
Extends

XML
Attribute

null

admin

yes

shortDesc

true

admin

no

adminCusto
mizable

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

no

dataType

null

no

docName

admin

no

exportByVie
wAttr

null

null

no

extends

null

null

no

id

none

null

no

initSortSeq

null
false

admin
null

no
no

true

user

no

labelTitle
cellNoWrap
Format
rendered

null

no

scope

VARC null
HAR2

The name of the component

jrad:refNam null
e
The alternate view attribute for string
null
use when exporting.

A reference to another
jrad:compo
component that creates a
nentRef
different instance of that
component at runtime.
ID
The unique name of this
Name
component.
Initial
Indicates the initial sort
string
Sort
sequence for each search. The
Sequenc legal values are
none, first, second, and third
e
.
Label
The label for the component. string
No Wrap Indicates if cell contents
boolean
should be wrapped.
Rendere Indicates if the component is boolean
d
rendered.
Scope
The Base Packages which are jrad:scope
allowed to reuse this
component.
188

Default Personal Transla


Value izable
table

Item Styles

Name
Search
Allowed
Sort
Allowed

Description
Indicates if the item will be
shown in the search panels.
Indicates if the user can sort
this column. The legal values
are
yes, no, ascending, and desc
ending.

Sort By The alternate view attribute


View
name for use when sorting.
Attribute
Text
The text label for the
component.
Total
Indicates if an additional field
Value
should be displayed to show
the total of this column.
User
Indicates if a user can
Personali personalize this component.
zation
View
The name of the view attribute.
Attribute
View
The name of the view object
Instance instance.
xml:lang Identifies the language
contained within this
component.

Type

Default Personal Transla


Value izable
table

XML
Attribute

boolean

false

admin

no

queryable

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL) syntax.
string
null

null

no

sortByView
Attr

string

null

admin

yes

text

boolean

false

user

no

totalValue

boolean

false

admin

no

userCustom
izable

string

null

null

no

viewAttr

string

null

null

no

viewName

optional

null

null

no

xml:lang

189

OA Extension Component Reference

formValue
Description
The formValue item style adds a value that will be submitted with a form, but not displayed to
the user. The value submitted with the form comes from the associated formValue element
attributes "viewName" and "viewAttr". The inherited UIX attribute, "value", is used only if there
are no associated viewName/viewAttr attributes.
Corresponding web bean: OAFormValueBean

Properties
Name
Admin
Personali
zation
Attribute
Set
Commen
ts
Data
Type

Description
Indicates if an Administrator
can personalize this
component.
The attribute set for the
component.
Comments

Type
boolean

jrad:attribut null
eSetRef
string
null

The type of data. The legal


string
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Docume The name of the component jrad:refNam
nt Name
e
Encrypt Indicates if the contents is
boolean
encrypted in the HTML
source.
Extends A reference to another
jrad:compo
component that creates a
nentRef
different instance of that
component at runtime.
ID
The unique name of this
Name
component.
Prompt The text label for the
string
component.
Rendere Indicates if the component is boolean
d
rendered.
190

Default Personal Transla


XML
Value izable
table
Attribute
true
admin
no
adminCustomi
zable
null

no

use

null

no

comment

VARC null
HAR2

no

dataType

null

null

no

docName

false

null

no

encrypted

null

null

no

extends

null

null

no

id

null

admin

true

prompt

true

user

no

rendered

Item Styles

Name
Scope

Description

The Base Packages which


are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Security Defines the security mode
Mode
used to secure the region. If
set to selfSecured it is the
developer's responsibility to
handle security validation.
The legal values are
standard, and selfSecured.
Selective Indicates if the item is part of
Search a group of items, one of which
Criteria must be included in the
search.
User
Indicates if a user can
Personali personalize this component.
zation
View
The name of the view
Attribute attribute.
View
The name of the view object
Instance instance.
xml:lang Identifies the language
contained within this
component.

Type

Default Personal Transla


Value izable
table

XML
Attribute

jrad:scope

null

no

scope

boolean

false

null

no

queryable

string

standar null
d

no

securityMode

boolean

false

admin

no

selectiveSear
chCriteria

boolean

false

admin

no

userCustomiz
able

string

null

null

no

viewAttr

string

null

null

no

viewName

optional

null

null

no

xml:lang

191

OA Extension Component Reference

image
Description
The image item style creates an HTML image tag.
Corresponding web bean: OAImageBean

Properties
Name
Access
Key

Description

The character used for quick


keyboard navigation or
activation.
Action
The action type to fire for the
Type
component. It should be
either "fireAction" or "none."
Additiona Additional help text.
l Text
Admin
Indicates if an Administrator
Personali can personalize this
zation
component.
Attribute The attribute set for the
Set
component.
Commen Comments
ts
CSS
Overrides the default CSS
Class
class.
Data
The type of data. The legal
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati The function to invoke.
on
Function
Destinati The destination URI.
on URI
Disable Indicates if validation should
Server
not occur on the business tier
Side
during a form submit.
192

Type

Defaul Personal Transla


XML
t Value izable
table
Attribute

string

null

admin

no

accessKey

string

none

null

no

primaryClie
ntAction

string

null

admin

true

shortDesc

boolean

true

admin

no

adminCusto
mizable

jrad:attributeS null
etRef
string
null

null

no

use

null

no

comment

string

null

admin

no

styleClass

string

VARC null
HAR2

no

dataType

string

null

admin

no

invokeFunc

uriReference

null

null

no

destination

boolean

false

null

no

serverUnval
idated

Item Styles

Name
Validatio
n
Docume
nt Name
Export
View
Attribute
Extends

Height

ID
Image
URI
Initial
Sort
Sequenc
e

Description

Type

Defaul Personal Transla


XML
t Value izable
table
Attribute

The name of the component

jrad:refName

null

null

no

docName

The alternate view attribute


for use when exporting.

string

null

admin

no

exportByVie
wAttr

A reference to another
component that creates a
different instance of that
component at runtime.
Indicates the height in pixels
or as a percentage (if % sign
included).
The unique name of this
component.
The URI for the image file.

jrad:compone null
ntRef

null

no

extends

ui:stringExpre null
ssionType

null

no

imageHeigh
t

Name

null

null

no

id

uriReference

null

null

no

source

none

null

no

initSortSeq

boolean

false

null

no

boolean

false

admin

no

string

null

admin

no

cellNoWrap
Format
popupEnabl
ed
popupId

string

onClick admin

no

popupRend
erEvent

string

null

admin

true

prompt

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

no

admin

no

sortState

Indicates the initial sort


string
sequence for each search.
The legal values are
none, first, second, and thir
d.

No Wrap Indicates if cell contents


should be wrapped.
Popup
Indicates whether the pop-up
Enabled is enabled.
Popup ID The unique name of the popup.
Popup
Indicates on what action type
Render the event is to be rendered for
Event
the pop-up.
Prompt The text label for the
component.
Rendere Indicates if the component is
d
rendered.
Scope
The Base Packages which
are allowed to reuse this
component.
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Also supports
Expression
Language
193

OA Extension Component Reference

Name

Description

Type
(EL) syntax.
string

Sort By The alternate view attribute


View
name for use when sorting.
Attribute
User
Indicates if a user can
boolean
Personali personalize this component.
zation
View
The name of the view
string
Attribute attribute.
View
The name of the view object string
Instance instance.
Warn
Warns the user if there are
boolean
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
Width
On SpacerBean: Indicates the ui:stringExpre
width in pixels. On others:
ssionType
Indicates the width in pixels or
as a percentage (if % sign
included).
xml:lang Identifies the language
optional
contained within this
component.

194

Defaul Personal Transla


XML
t Value izable
table
Attribute
null

null

no

sortByView
Attr

false

admin

no

userCustom
izable

null

null

no

viewAttr

null

null

no

viewName

true

null

no

warnAbout
Changes

null

null

no

imageWidth

null

null

no

xml:lang

Item Styles

link
Description
The link item style creates an HTML link tag.
Corresponding web bean: OALinkBean

Properties
Name

Description

Access Key The character


used for quick
keyboard
navigation or
activation.
Action Type The action
type to fire for
the
component. It
should be
either
"fireAction",
"firePartialActi
on" or "none."
Admin
Indicates if an
Personalizati Administrator
on
can
personalize
this
component.
Attribute Set The attribute
set for the
component.
Comments Comments
CSS Class Overrides the
default CSS
class.
Destination The function
Function
to invoke.
Destination The
URI
destination

Type

string

Defau Personaliza Translata XML Attribute


lt
ble
ble
Value
null
admin
no
accessKey

string

none null

no

primaryClientAct
ion

boolean

true

admin

no

adminCustomiza
ble

jrad:attributeSet null
Ref

null

no

use

string
string

null
null

null
admin

no
no

comment
styleClass

string

null

admin

no

invokeFunc

uriReference

null

null

no

destination
195

OA Extension Component Reference

Name

Description

URI.
Disable
Indicates if
Server Side validation
Validation
should not
occur on the
business tier
during a form
submit.
Document The name of
Name
the
component
Extends
A reference to
another
component
that creates a
different
instance of
that
component at
runtime.
ID
The unique
name of this
component.
Popup
Indicates
Enabled
whether the
pop-up is
enabled.
Popup ID
The unique
name of the
pop-up.
Popup
Indicates on
Render
what action
Event
type the event
is to be
rendered for
the pop-up.
Rendered
Indicates if the
component is
rendered.
Scope
The Base
Packages
which are
allowed to
reuse this
196

Type

Defau Personaliza Translata XML Attribute


lt
ble
ble
Value

boolean

false

null

no

serverUnvalidat
ed

jrad:refName

null

null

no

docName

jrad:component null
Ref

null

no

extends

Name

null

null

no

id

boolean

false

admin

no

popupEnabled

string

null

admin

no

popupId

string

onClic admin
k

no

popupRenderEv
ent

boolean

true

user

no

rendered

jrad:scope

null

no

scope

Item Styles

Name

Description

Type

component.
Target
The name of string
Frame
the target
frame for the
link.
Text
The text label string
for the
component.
User
Indicates if a boolean
Personalizati user can
on
personalize
this
component.
View
The name of string
Attribute
the view
attribute.
View
The name of string
Instance
the view
object
instance.
Warn About Warns the
boolean
Changes
user if there
are pending
changes that
will be lost,
and allows
them to cancel
the current
action or
discard the
changes and
continue with
the current
action.
xml:lang
Identifies the optional
language
contained
within this
component.

Defau Personaliza Translata XML Attribute


lt
ble
ble
Value
null

admin

yes

targetFrame

null

admin

yes

text

false

admin

no

userCustomizabl
e

null

null

no

viewAttr

null

null

no

viewName

true

null

no

warnAboutChan
ges

null

null

no

xml:lang

197

OA Extension Component Reference

list
Description
The list item style creates a control which allows the user to select one or more values from a
list of items. The list control contains any number of option elements, each of which represents
an available option that the user may select.
Corresponding web bean: OAListBean

Properties
Name

Description

Type

Defaul Persona Transl


t
lizable atable
Value

XML
Attribute

Addition Additional help text.


al Text

string

null

admin

yes

shortDesc

Admin
Indicates if an Administrator
Personal can personalize this
ization
component.

boolean

true

admin

no

adminCustom
izable

Attribute The attribute set for the


Set
component.

jrad:attribut null
eSetRef

null

no

use

Commen Comments
ts

string

null

null

no

comment

CSS
Class

Overrides the default CSS


class.

string

null

admin

no

styleClass

Data
Type

The type of data. The legal


string
values are
VARCHAR2, DATE, DATET
IME, BIGDECIMAL,
NUMBER, BOOLEAN, and
CLOB.

VARC
HAR2

null

no

dataType

false

null

no

disabled

Docume The name of the component jrad:refNa


nt Name
me

null

null

no

docName

Export
The alternate view attribute
View
for use when exporting.
Attribute

string

null

admin

no

exportByView
Attr

Extends A reference to another


component that creates a

jrad:compo null
nentRef

null

no

extends

Disabled Indicates if the element is


disabled.

198

boolean

Item Styles

Name

Description

Type

Defaul Persona Transl


t
lizable atable
Value

XML
Attribute

different instance of that


component at runtime.
ID

The unique name of this


component.

Name

null

null

no

id

List
Height

The display height in


characters.

unsignedIn null
t

null

no

size

MultiSelect
Allowed

Indicates if the list allows


multiple selections.

boolean

false

null

no

multiple

No Wrap Indicates if cell contents


should be wrapped.

boolean

false

null

no

cellNoWrapF
ormat

Picklist The view attribute that


Descripti serves as the description of
on
choices.
Attribute

string

null

null

no

pickListViewD
escription

Picklist The view attribute that


Display serves as the displayed
Attribute value of choices.

string

null

null

no

pickListDispA
ttr

Picklist The view attribute that


Value
serves as the internal value
Attribute of choices.

string

null

null

no

pickListValAtt
r

Picklist The fully-qualified view


View
object name for the picklist,
Definitio cached at the JVM level.
n

string

null

null

no

pickListViewD
ef

Picklist The view instance name for


View
the picklist.
Instance

string

null

null

no

pickListViewN
ame

Read
Only

boolean

false

admin

no

readOnly

Rendere Indicates if the component is boolean


d
rendered.

true

user

no

rendered

Scope

jrad:scope

null

no

scope

string

standa null
rd

no

securityMode

Indicates if the value can be


changed.

The Base Packages which


are allowed to reuse this
component.

Security Defines the security mode


Mode
used to secure the region. If
set to selfSecured it is the
developer's responsibility to
handle security validation.
The legal values are

199

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl


t
lizable atable
Value

XML
Attribute

standard, and selfSecured.


View
The name of the view
Attribute attribute.

string

null

null

no

viewAttr

View
The name of the view object string
Instance instance.

null

null

no

viewName

xml:lang Identifies the language


contained within this
component.

null

null

no

xml:lang

200

optional

Item Styles

messageCheckBox
Description
The messageCheckBox item style is a combination of the checkBox and inlineMessage
controls.
Corresponding web bean: OAMessageCheckBoxBean

Properties
Name
Access
Key

Description

Type

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction",
"firePartialAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Checked The value when checked.
string
Value
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati The function to invoke.
string
on

Defaul Persona Transl XML Attribute


t Value lizable atable
null
admin
no
accessKey

none

null

no

primaryClientAc
tion

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

checkedValue

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

no

invokeFunc

admin

201

OA Extension Component Reference

Name
Function
Disable
Server
Side
Validatio
n
Disabled

Description

Indicates if validation should boolean


not occur on the business tier
during a form submit.

Indicates if the element is


disabled.
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Initial
The initial (default) value of
Value
the item.
Initially The initial (default) state of
Checked the item.
Long Tip The fully-qualified reference
Region to the long tip region.
No Wrap Indicates if cell contents
should be wrapped.
Prompt The text label for the
component.
Read
Indicates if the value can be
Only
changed.
Rendere Indicates if the component is
d
rendered.
Required Indicates if the user must
enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", and "default".

202

Type

Defaul Persona Transl XML Attribute


t Value lizable atable
false

null

no

serverUnvalidat
ed

boolean

false

null

no

disabled

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

Name

null

null

no

id

string

none

null

no

initSortSeq

string

null

admin

no

defaultValue

boolean

null

null

no

checked

jrad:refNa
me
boolean

null

admin

no

longTipRegion

false

null

no

string

null

admin

yes

cellNoWrapFor
mat
prompt

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

admin

no

required

ui:required no

Item Styles

Name

Description

Scope

The Base Packages which


are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Selective Indicates if the item is part of
Search a group of items, one of
Criteria which must be included in the
search.
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

boolean

false

admin

no

selectiveSearch
Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

The alternate view attribute


name for use when sorting.

The type of tip. The legal


string
values are
dateFormat, longMessage,
shortTip, and none.

none

admin

no

tipType

Uncheck
ed Value
User
Personal
ization
Vertical
Alignme
nt
View
Attribute
View
Instance

The value when unchecked.

string

null

null

no

Indicates if a user can


personalize this component.

boolean

false

admin

no

unCheckedValu
e
userCustomiza
ble

null

null

no

vAlign

null

null

no

viewAttr

null

null

no

viewName

The application short name


that owns the tip message.

Vertical alignment.
string
Acceptable values are
"middle", "top", and "bottom".
The name of the view
string
attribute.
The name of the view object string
instance.

203

OA Extension Component Reference

Name

Description

Type

Warn
Warns the user if there are
boolean
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
optional
contained within this
component.

204

Defaul Persona Transl XML Attribute


t Value lizable atable
true

null

no

warnAboutChan
ges

null

null

no

xml:lang

Item Styles

messageChoice
Description
The messageChoice item style is a combination of the choice and inlineMessage controls.
Corresponding web bean: OAMessageChoiceBean

Properties
Name
Access
Key
Action
Type

Add
Blank
Value
Addition
al Text
Admin
Personal
ization
Attribute
Set
Commen
ts
CSS
Class
Data
Type

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

The character used for quick string


keyboard navigation or
activation.
The action type to fire for the string
component. It should be
either "fireAction",
"firePartialAction" or "none."
Adds an empty value to the boolean
choice list if it is not Required

null

admin

no

accessKey

none

null

no

primaryClientAc
tion

true

admin

no

allowBlankValu
e

Additional help text.

string

null

admin

yes

shortDesc

Indicates if an Administrator
can personalize this
component.
The attribute set for the
component.
Comments

boolean

true

admin

no

adminCustomiz
able

null

no

use

null

no

comment

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

false

null

no

serverUnvalidat

jrad:attribut null
eSetRef
string
null

Overrides the default CSS


string
class.
The type of data. The legal
string
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati The function to invoke.
string
on
Function
Disable Indicates if validation should boolean

null

205

OA Extension Component Reference

Name

Description

Server not occur on the business tier


Side
during a form submit.
Validatio
n
Disabled Indicates if the element is
disabled.
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Initial
The initial (default) value of
Value
the item.
Long Tip The fully-qualified reference
Region to the long tip region.
No Wrap Indicates if cell contents
should be wrapped.
Picklist The view attribute that serves
Display as the displayed value of
Attribute choices.
Picklist The view attribute that serves
Value
as the internal value of
Attribute choices.
Picklist The fully-qualified view object
View
name for the picklist, cached
Definitio at the JVM level.
n
Picklist The view instance name for
View
the picklist.
Instance
Prompt The text label for the
component.
Read
Indicates if the value can be
206

Type

Defaul Persona Transl XML Attribute


t Value lizable atable
ed

boolean

false

null

no

disabled

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

Name

null

null

no

id

string

none

null

no

initSortSeq

string

null

admin

no

defaultValue

jrad:refNa
me
boolean

null

admin

no

longTipRegion

false

null

no

string

null

null

no

cellNoWrapFor
mat
pickListDispAttr

string

null

null

no

pickListValAttr

string

null

null

no

pickListViewDef

string

null

null

no

pickListViewNa
me

string

null

admin

yes

prompt

boolean

false

admin

no

readOnly

Item Styles

Name

Description

Only
Rendere
d
Required

changed.
Indicates if the component is
rendered.
Indicates if the user must
enter a value and how that
appears to the user. Two
values are allowed: "yes",
"no".
The Base Packages which
are allowed to reuse this
component.
Indicates if the item will be
shown in the search panels.
Defines the security mode
used to secure the region. If
set to selfSecured it is the
developer's responsibility to
handle security validation.
The legal values are
standard, and selfSecured.
Indicates if the item is part of
a group of items, one of
which must be included in the
search.
Indicates if the user can sort
this column. The legal values
are
yes, no, ascending, and des
cending.

Scope

Search
Allowed
Security
Mode

Selective
Search
Criteria
Sort
Allowed

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

true

user

no

rendered

string

no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

string

standa null
rd

no

securityMode

boolean

false

admin

no

selectiveSearch
Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

The type of tip. The legal


values are

none

admin

no

tipType

The alternate view attribute


name for use when sorting.
The application short name
that owns the tip message.

string

207

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

dateFormat, longMessage,
shortTip, and none.
Total
Value

Indicates if an additional field boolean


should be displayed to show
the total of this column.
User
Indicates if a user can
boolean
Personal personalize this component.
ization
Vertical Vertical alignment.
string
Alignme Acceptable values are
nt
"middle", "top", and "bottom".
View
The name of the view
string
Attribute attribute.
View
The name of the view object string
Instance instance.
Warn
Warns the user if there are
boolean
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
optional
contained within this
component.

208

false

user

no

totalValue

false

admin

no

userCustomiza
ble

null

null

no

vAlign

null

null

no

viewAttr

null

null

no

viewName

true

null

no

warnAboutChan
ges

null

null

no

xml:lang

Item Styles

messageDownload
Description
The messageDownload item style enables downloading of a file from the middle tier to a client
machine. The messageDownload component appears as linked text on a page.
The messageDownload item style extends messageStyledText. Please refer to the
messageStyledText section for more information on all messageDownload properties.
Corresponding web bean: OAMessageDownloadBean

Properties
Name
Access
Key

Description

The character used for quick


keyboard navigation or
activation.
Admin
Indicates if an Administrator
Personal can personalize this
ization component.
Attribute The attribute set for the
Set
component.
Commen Comments
ts
Data
The type of data. The legal
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, CLO
B, and BLOB.
Destinati The function to invoke.
on
Function
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

string

null

admin

no

accessKey

boolean

true

admin

no

adminCustomiz
able

null

no

use

null

no

comment

string

VARC null
HAR2

no

dataType

string

null

admin

no

invokeFunc

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

null

no

extends

jrad:attribut null
eSetRef
string
null

jrad:compo null
nentRef

209

OA Extension Component Reference

Name

File
MIME
Type
File
Name
Override
File View
Attribute
Height

Description
component at runtime.
The MIME type of the File.

The File Name to use instead


of the view attribute text when
saving the file.
The view attribute for the file
content.
The display height of the
Search item in characters.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Long Tip The fully-qualified reference
Region to the long tip region.
Maximu The number of characters a
m
user can enter as search
Length criteria for this field in a
results-based (automatic)
search.

No Wrap Indicates if cell contents


should be wrapped.
Prompt The text label for the
component.
Rendere Indicates if the component is
d
rendered.
Required Indicates if the user must
enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", "default".
Scope
The Base Packages which
are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Selective Indicates if the item is part of
Search a group of items, one of
210

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

string

null

null

no

fileContentType

string

null

null

no

downloadFileNa
me

string

null

null

no

unsignedInt null

null

no

contentViewAttr
ibuteName
rows

string

null

no

initSortSeq

admin

no

longTipRegion

admin

no

maximumLengt
h

Also
supports
Expression
Language
(EL)
syntax.
boolean
false

null

no

string

null

admin

yes

cellNoWrapFor
mat
prompt

boolean

true

user

no

rendered

ui:required no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

boolean

false

admin

no

selectiveSearch
Criteria

none

jrad:refNa null
me
unsignedInt null

Item Styles

Name

Description

which must be included in the


search.
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

The alternate view attribute


name for use when sorting.

The type of tip. The legal


string
values are
dateFormat, longMessage,
shortTip, and none.

none

admin

no

tipType

User
Personal
ization
Vertical
Alignme
nt
View
Attribute
View
Instance
Warn
About
Changes

Indicates if a user can


personalize this component.

boolean

false

admin

no

userCustomiza
ble

Vertical alignment.

string

null

null

no

vAlign

The name of the view


attribute.
The name of the view object
instance.
Warns the user if there are
pending changes that will be
lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
The display length of the
Search item in characters.

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

unsignedInt null

null

no

columns

Width

The application short name


that owns the tip message.

211

OA Extension Component Reference

Name

Description

xml:lang Identifies the language


contained within this
component.

212

Type
optional

Defaul Persona Transl XML Attribute


t Value lizable atable
null

null

no

xml:lang

Item Styles

messageFileUpload
Description
The messageFileUpload item style is a combination of the fileUpload and inlineMessage
controls. The fileUpload control adds a widget that can be used to upload a file. Any form that
contains this control must have attribute "usesUpload" set to true.
Corresponding web bean: OAMessageFileUploadBean

Properties
Name

Description

Type

Access
Key

The character used for quick string


keyboard navigation or
activation.
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, CLO
B, and BLOB.
Docume The name of the component
nt Name
Extends A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Length The display length in

Defaul Persona Transl XML Attribute


t Value lizable atable
null

admin

no

accessKey

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

no

dataType

VARC null
HAR2

jrad:refNa null
me
jrad:compo null
nentRef

null

no

docName

null

no

extends

Name

null

null

no

id

unsignedInt null

null

no

columns
213

OA Extension Component Reference

Name

Long Tip
Region
No Wrap
Prompt
Rendere
d
Required

Scope

Description
characters.
The fully-qualified reference
to the long tip region.
Indicates if cell contents
should be wrapped.
The text label for the
component.
Indicates if the component is
rendered.
Indicates if the user must
enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", and "default".
The Base Packages which
are allowed to reuse this
component.
The application short name
that owns the tip message.

Tip
Message
Appl
Short
Name
Tip
The name of the tip message.
Message
Name
Tip Type The type of tip. The legal
values are
dateFormat, longMessage,
shortTip, and none.
User
Indicates if a user can
Personal personalize this component.
ization
Vertical Vertical alignment.
Alignme Acceptable values are
nt
"middle", "top", and "bottom".
View
The name of the view
Attribute attribute.
View
The name of the view object
Instance instance.
Virus
Indicates if Virus Scan is
Scan
enabled on file attachments.
Enabled
xml:lang Identifies the language
contained within this
214

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

jrad:refNa
me
boolean

null

admin

no

longTipRegion

false

null

no

string

null

admin

yes

cellNoWrapFor
mat
prompt

boolean

true

user

no

rendered

ui:required no

admin

no

required

jrad:scope .

null

no

scope

string

null

admin

no

tipMessageApp
ShortName

string

null

admin

no

tipMessageNa
me

string

none

admin

no

tipType

boolean

false

admin

no

userCustomiza
ble

string

null

null

no

vAlign

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

false

admin

no

virusScanEnabl
ed

optional

null

null

no

xml:lang

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

component.

215

OA Extension Component Reference

messageInlineAttachment
Description
The messageInlineAttachment item style is used to display attachments in a message bean.
Corresponding web bean: OAMessageInlineAttachmentBean

Properties
Name

Description

Admin
Personal
ization
Attribute
Set
Automati
c Save
Commen
ts
CSS
Class
Disable
Client
Side
Validatio
n
Disable
Server
Side
Validatio
n
Enable
Docume
nt
Catalog
Extends

Indicates if an Administrator
can personalize this
component.
The attribute set for the
component.
Indicates if automatic save
is enabled.
Comments.

boolean

Overrides the default CSS


class.
Indicates if validation
should not occur on the
web tier during a form
submit.

216

Type

Defaul Persona Transl XML Attribute


t Value lizable atable
true
admin
no
adminCustomizab
le

jrad:attribut null
eSetRef
boolean
false

null

no

use

null

no

string

null

null

no

autoCommitEnabl
ed
comment

string

null

admin

no

styleClass

boolean

true

null

no

unvalidated

Indicates if validation
boolean
should not occur on the
business tier during a form
submit.

true

null

no

serverUnvalidate
d

Indicates if the Document


Catalog is enabled for the
component.

boolean

true

admin

no

enableDocument
Catalog

A reference to another
component that creates a
different instance of that
component at runtime.

jrad:compo null
nentRef

null

no

extends

Item Styles

ID

The unique name of this


component.
Inline
Indicates whether inline
Attachm attachment capability is
ent
enabled or not.
Enabled
Links
The number of attachments
Displaye links displayed inline.
d
Default value is 5 if not
defined.
Long Tip The fully-qualified reference
Region to the long tip region.
Prompt The text label for the
component.
Render Indicates if the search
Search region is rendered.
Region
Rendere Indicates if the component
d
is rendered.
Required Indicates if the user must
enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", and "default".
Tip
The application short name
Message that owns the tip message.
Appl
Short
Name
Tip
The name of the tip
Message message.
Name
Tip Type The type of tip. The legal
values are
dateFormat, longMessage,
shortTip, and none.
View
The name of the view
Instance object instance.

Name

null

null

no

id

boolean

null

admin

no

inlineAttachment
Enabled

admin

no

numberAttachme
ntsDisplayed

jrad:refNam null
admin
e
string
Attach admin
ments
boolean
true
null

no

longTipRegion

yes

prompt

no

searchRegionRe
ndered

boolean

user

no

rendered

ui:required no

admin

no

required

string

null

admin

no

tipMessageAppS
hortName

string

null

admin

no

tipMessageName

string

none

admin

no

tipType

string

null

null

no

viewName

nonNegativ 5
eInteger

true

Element Children
Name
entityMappings

Quantity
1

Description
Defines the entity and item relationships.

entityMap
217

OA Extension Component Reference

Name

Descriptio
n

Type

Approval Function
string
Function Name for
Name
the
approval
process.
Approval View
string
View
Attribute to
Attribute determine if
approval
process is
required.
Attribute The
jrad:attributeSet
Set
attribute set Ref
for the
component.
Commen Comments. string
ts
Delete
Indicates if boolean
Allowed the user
can delete
attachment
s from the
current
object.
Entity
The name string
of the
attachment
entity which
defines the
primary key
relationship
s.
Insert
Indicates if boolean
Allowed new
attachment
s can be
created for
this entity.
Show All Indicates if boolean
the user
can view
any
attachment
for the
current
218

Defau Personalizab Translatab


XML Attribute
lt
le
le
Value
null
null
no
approvalFunctionNa
me

null

null

no

approvalViewAttr

null

null

no

use

null

null

no

comment

true

null

no

deleteAllowed

null

null

no

entityId

true

null

no

insertAllowed

false

null

no

showAll

Item Styles

object,
regardless
of category.
Indicates if boolean
the user
can edit the
attachment
content.

Update
Allowed

true

null

no

updateAllowed

Element Children
Name
categoryMappings
primaryKeys

Quantity
0 through 1
0 through 1

Description
Defines the entity and category relationships.
Defines the primary keys.

categoryMap
Name

Descriptio
n
Attribute The
Set
attribute set
for the
component.
Category The
attachment
category
name.
Comment Comments.
s
Secured Indicates if
the object is
secured by
grants
model.

Type

Defaul Personalizabl Translatabl


XML
t Value
e
e
Attribute
jrad:attributeSetRe null
null
no
use
f

string

null

null

no

categoryNam
e

string

null

null

no

comment

boolean

false

admin

no

secured

primaryKey
Name
Attribute
Set

Description

Type

Default Personalizable Translatable XML


Value
Attribute

The attribute jrad:attributeSetRef null


set for the
component.
Comments Comments. string
null
View
The name of string
null

null

no

use

null
null

no
no

comment
viewAttr
219

OA Extension Component Reference

Attribute

220

the view
attribute.

Item Styles

messageLovChoice
Description
The messageLovChoice item style is a hybrid between a messageLovInput and a
messageChoice. Please refer to the messageLovInput and messageChoice sections for more
information on all messageLovChoice properties.
Corresponding web bean: OAMessageLovChoiceBean

Properties
Name

Description

Access The character used for quick


Key
keyboard navigation or
activation.
Action The action type to fire for the
Type
component. It should be either
"fireAction", "firePartialAction" or
"none."
Addition Additional help text.
al Text
Admin Indicates if an Administrator can
Persona personalize this component.
lization
Attribute The attribute set for the
Set
component.
Comme Comments
nts
CSS
Overrides the default CSS class.
Class
Data
The type of data. The legal
Type
values are
VARCHAR2, DATE, DATETIME,
NUMBER, BIGDECIMAL,
BOOLEAN, and CLOB.
Destinati The function to invoke.
on
Function
Disable Indicates if validation should not
Validatio occur on the web tier during a

Type

string

Defaul Persona Transl XML Attribute


t
lizable atable
Value
null
admin no
accessKey

string

none

null

no

primaryClientA
ction

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomi
zable

jrad:attribu null
teSetRef
string
null

null

no

use

null

no

comment

string

null

admin

no

styleClass

string

VARC null
HAR2

no

dataType

string

null

admin

no

invokeFunc

boolean

false

null

no

unvalidated

221

OA Extension Component Reference

n
Disable
d
Export
View
Attribute
External
LOV
Initial
Sort
Sequen
ce
Initial
Value
List
Persona
lization
No
Wrap
Picklist
Display
Attribute
Picklist
Value
Attribute
Prompt
Read
Only
Rendere
d
Require
d

form submit.
Indicates if the element is
disabled.
The alternate view attribute for
use when exporting.

boolean

false

null

no

disabled

string

null

admin

no

exportByViewA
ttr

The name of the external List of jrad:comp null


Values region.
onentRef
Indicates the initial sort sequence string
none
for each search. The legal values
are
none, first, second, and third.

null

no

null

no

externalListOf
Values
initSortSeq

The initial (default) value of the string


item.
Indicates if the user can
boolean
personalize the LOV Choice list.

null

admin

no

defaultValue

false

null

no

userEditableLi
st

Indicates if cell contents should boolean


be wrapped.
The view attribute that serves as string
the displayed value of choices.

false

null

no

null

null

no

cellNoWrapFor
mat
pickListDispAtt
r

The view attribute that serves as string


the internal value of choices.

null

null

no

pickListValAttr

The text label for the component.


Indicates if the value can be
changed.
Indicates if the component is
rendered.
Indicates if the user must enter a
value and how that appears to
the user. Two values are
allowed: "yes", "no".
Indicates if the item will be shown
in the search panels.
Indicates if the item is part of a
group of items, one of which
must be included in the search.

string
boolean

null
false

admin
admin

yes
no

prompt
readOnly

boolean

true

user

no

rendered

string

no

admin

no

required

admin

no

queryable

admin

no

selectiveSearc
hCriteria

admin

no

sortState

Search
boolean
false
Allowed
Selectiv
boolean
false
e
Search
Criteria
Sort
Indicates if the user can sort this string
no
Allowed column. The legal values are
yes, no, ascending, and descendi Also
ng.
supports
Expressio
n
222

Item Styles

Language
(EL)
syntax.
Sort By The alternate view attribute name string
null
View
for use when sorting.
Attribute
Tip
The application short name that string
null
Messag owns the tip message.
e Appl
Short
Name
Tip
The name of the tip message.
string
null
Messag
e Name
Tip Type The type of tip. The legal values string
none
are
dateFormat, longMessage, short
Tip, and none.
Total
Indicates if an additional field
boolean
false
Value
should be displayed to show the
total of this column.
User
Indicates if a user can
boolean
false
Persona personalize this component.
lization
Vertical Vertical alignment. Acceptable
string
null
Alignme values are "middle", "top", and
nt
"bottom".
View
The name of the view attribute. string
null
Attribute
View
The name of the view object
string
null
Instance instance.
Warn
Warns the user if there are
boolean
true
About
pending changes that will be lost,
Change and allows them to cancel the
s
current action or discard the
changes and continue with the
current action.
xml:lang Identifies the language contained optional
null
within this component.

null

no

sortByViewAttr

admin

no

tipMessageAp
pShortName

admin

no

tipMessageNa
me

admin

no

tipType

user

no

totalValue

admin

no

userCustomiza
ble

null

no

vAlign

null

no

viewAttr

null

no

viewName

null

no

warnAboutCha
nges

null

no

xml:lang

lovMap
Name

Attribute

Description

Type

Defau Personaliza Translata XML Attribute


lt
ble
ble
Value

The attribute set jrad:attributeSet null

null

no

use
223

OA Extension Component Reference

Set

for the
component.
Comments Comments.
Criteria
The ID of the
Item
item in the base
page that
provides the
criteria for the
LOV.
LOV
The name of the
Region
item in the List
Item
Of Values
region.
Programm Indicates if the
atic Query Criteria Item
value will not be
automatically
applied to the
LOV.
Required Indicates if the
item specified in
the Criteria Item
property must
have a value.
Return
The name of the
Item
item in the base
page that
receives the
result from the
LOV Region
Item.
Use for
Indicates if the
Validation return item will
always contain a
value if a row
from the LOV is
selected. The
legal values are
default, yes, and
no.

224

Ref
string
jrad:localRef

null
null

null
null

no
no

comment
criteriaFrom

jrad:localRefStri null
ng

null

no

lovItem

boolean

false null

no

programmaticQ
uery

boolean

false null

no

requiredForLOV

jrad:localRef

null

null

no

resultTo

string

defaul null
t

no

useForValidatio
n

Item Styles

messageLovInput
Description
The messageLovInput item style is a combination of the lovInput and inlineMessage controls.
Please refer to the listOfValues section for more information on LOVs.
Note: messageLovInput can have two or more lovMaps created under it, and each of those
lovMaps can have the Criteria Item property set. However if you set the Criteria Item property on
more than one lovMap, at runtime when the user invokes an LOV, selects a value from the LOV,
and then re-invokes it, both the entered criteria are used. In this case, deleting the value from
the search item will not enable the user to query all records from the LOV table's view objects.
Corresponding web bean: OAMessageLovInputBean

Properties
Name

Description

Access The character used for quick


Key
keyboard navigation or
activation.
Addition Additional help text.
al Text
Admin Indicates if an Administrator can
Persona personalize this component.
lization
Attribute The attribute set for the
Set
component.
Comme Comments
nts
CSS
Overrides the default CSS
Class class.
Data
The type of data. The legal
Type
values are
VARCHAR2, DATE, DATETIM
E, NUMBER, BIGDECIMAL,
BOOLEAN, and CLOB.
Disable Indicates if validation should not
Validati occur on the web tier during a

Type

Defau Person Transl


lt
alizable atable
Value

XML Attribute

string

null

admin

no

accessKey

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomizab
le

jrad:attrib null
uteSetRef
string
null

null

no

use

null

no

comment

string

null

admin

no

styleClass

string

VARC null
HAR2

no

dataType

boolean

false

no

unvalidated

null

225

OA Extension Component Reference

on
form submit.
Disable Indicates if the element is
boolean false
d
disabled.
Docume The name of the component
jrad:refNa null
nt
me
Name
Export The alternate view attribute for string
null
View
use when exporting.
Attribute
Extends A reference to another
jrad:comp null
component that creates a
onentRef
different instance of that
component at runtime.
External The name of the external List of jrad:comp null
LOV
Values region.
onentRef
Height The display height in
unsignedI 1
characters.
nt
ID
The unique name of this
Name
null
component.
Initial
Indicates the initial sort
string
none
Sort
sequence for each search. The
Sequen legal values are
ce
none, first, second, and third.
Initial
The initial (default) value of the string
null
Value item.
Length The display length in
unsignedI null
characters.
nt
Long
The fully-qualified reference to jrad:refNa null
Tip
the long tip region.
me
Region
Look
Whether look-ahead capability boolean null
Ahead is enabled or not.
Enabled
Look
Maximum number of records
unsignedI 50
Ahead displayed in the look ahead
nt
Records window.
Display
ed
Look
The maximum number of
unsignedI 10
Ahead records visible to a user in the nt
Records look ahead window at any point
Visible in time.
Look
Type of search to be performed. anySimple starts
Ahead
Type
With
Search
Type
226

null

no

disabled

null

no

docName

admin

no

exportByViewAttr

null

no

extends

null

no

null

no

externalListOfValu
es
rows

null

no

id

null

no

initSortSeq

admin

true

null

no

translatableDefaul
tValue
columns

admin

no

longTipRegion

admin

no

lookAheadEnable
d

admin

no

lookAheadRecord
sDisplayed

admin

no

lookAheadRecord
sVisible

admin

no

lookAheadSearch
Type

Item Styles

Look
Ahead
Selectio
n Event
Enabled
Maximu
m
Length

Whether server-side event to be boolean


generated on value selection.

The maximum number of


characters per line that can be
entered.

true

null

no

lookAheadSelecti
onEventEnabled

unsignedI null
nt

null

no

maximumLength

admin

no

lookAheadMinCha
rs

null

no

admin

yes

cellNoWrapForma
t
prompt

admin

no

readOnly

user

no

rendered

admin

no

required

null

no

scope

admin

no

queryable

admin

no

selectiveSearchCr
iteria

null

no

showRequired

admin

no

sortState

Also
supports
Expressio
n
Language
(EL)
syntax.
Minimu Minimum number of characters unsignedI null
m
required to initiate look ahead. nt
Charact
ers For
Look
Ahead
No
Indicates if cell contents should boolean false
Wrap
be wrapped.
Prompt The text label for the
string
null
component.
Read
Indicates if the value can be
boolean false
Only
changed.
Render Indicates if the component is
boolean true
ed
rendered.
Require Indicates if the user must enter ui:require no
d
a value and how that appears to d
the user. Three values are
allowed: "yes", "no", and
"validaterOnly".
Scope The Base Packages which are jrad:scope .
allowed to reuse this
component.
Search Indicates if the item will be
boolean false
Allowed shown in the search panels.
Selectiv Indicates if the item is part of a boolean false
e
group of items, one of which
Search must be included in the search.
Criteria
showRe
boolean false
quired
Sort
Indicates if the user can sort
string
no
Allowed this column. The legal values

227

OA Extension Component Reference

are
Also
yes, no, ascending, and descen supports
ding.
Expressio
n
Language
(EL)
syntax.
Sort By The alternate view attribute
string
null
View
name for use when sorting.
Attribute
Tip
The application short name that string
null
Messag owns the tip message.
e Appl
Short
Name
Tip
The name of the tip message. string
null
Messag
e Name
Tip
The type of tip. The legal values string
none
Type
are
dateFormat, longMessage, shor
tTip, and none.
User
Indicates if a user can
boolean false
Persona personalize this component.
lization
Vertical Vertical alignment. Acceptable string
null
Alignme values are "middle", "top", and
nt
"bottom".
View
The name of the view attribute. string
null
Attribute
View
The name of the view object
string
null
Instanc instance.
e
Warn
Warns the user if there are
boolean true
About pending changes that will be
Change lost, and allows them to cancel
s
the current action or discard the
changes and continue with the
current action.
xml:lang Identifies the language
optional null
contained within this
component.

null

no

sortByViewAttr

admin

no

tipMessageAppSh
ortName

admin

no

tipMessageName

admin

no

tipType

admin

no

userCustomizable

null

no

vAlign

null

no

viewAttr

null

no

viewName

null

no

warnAboutChang
es

null

no

xml:lang

lovMap
Name
228

Description

Type

Defau Personaliza Translata XML Attribute

Item Styles

lt
Value
Attribute
Set

The attribute set


for the
component.
Comments Comments.
Criteria
The ID of the
Item
item in the base
page that
provides the
criteria for the
LOV.
LOV
The name of the
Region
item in the List
Item
Of Values
region.
Programm Indicates if the
atic Query Criteria Item
value will not be
automatically
applied to the
LOV.
Required Indicates if the
item specified in
the Criteria Item
property must
have a value.
Return
The name of the
Item
item in the base
page that
receives the
result from the
LOV Region
Item.
Use for
Indicates if the
Validation return item will
always contain a
value if a row
from the LOV is
selected. The
legal values are
default, yes, and
no.

ble

ble

jrad:attributeSet null
Ref

null

no

use

string
jrad:localRef

null
null

null
null

no
no

comment
criteriaFrom

jrad:localRefStri null
ng

null

no

lovItem

boolean

false null

no

programmaticQ
uery

boolean

false null

no

requiredForLOV

jrad:localRef

null

null

no

resultTo

string

defaul null
t

no

useForValidatio
n

229

OA Extension Component Reference

messageRadioButton
Description
The messageRadioButton item style is a combination of the radioButton and inlineMessage
controls.
Corresponding web bean: OAMessageRadioButtonBean

Properties
Name
Access
Key

Description

Type

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction",
"firePartialAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Checked The value when checked.
string
Value
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati The function to invoke.
string
on
Function
Disable Indicates if validation should boolean
230

Defaul Persona Transl XML Attribute


t Value lizable atable
null
admin
no
accessKey

none

null

no

primaryClientAc
tion

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

checkedValue

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

false

null

no

serverUnvalidat

Item Styles

Name

Description

Server not occur on the business tier


Side
during a form submit.
Validatio
n
Disabled Indicates if the element is
disabled.
Docume The name of the component
nt Name
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Group
The name of the Radio
Name
Group.
ID
The unique name of this
component.
Initial
The initial (default) value of
Value
the item.
Long Tip The fully-qualified reference
Region to the long tip region.
Prompt The text label for the
component.
Read
Indicates if the value can be
Only
changed.
Rendere Indicates if the component is
d
rendered.
Required Indicates if the user must
enter a value, and how that
appears to the user. Three
values are allowed: "yes",
"no", and "default".
Scope
The Base Packages which
are allowed to reuse this
component.
Selective Indicates if the item is part of
Search a group of items, one of
Criteria which must be included in the
search.
Tip
The application short name
Message that owns the tip message.
Appl
Short
Name
Tip
The name of the tip message.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable
ed

boolean

false

null

no

disabled

jrad:refNa null
me
jrad:compo null
nentRef

null

no

docName

null

no

extends

string

null

null

no

name

Name

null

null

no

id

string

null

admin

no

defaultValue

jrad:refNa
me
string

null

admin

no

longTipRegion

null

admin

yes

prompt

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

ui:required no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

selectiveSearch
Criteria

string

null

admin

no

tipMessageApp
ShortName

string

null

admin

no

tipMessageNa
231

OA Extension Component Reference

Name

Description

Type

Message
Name
Tip Type The type of tip. The legal
string
values are
dateFormat, longMessage,
shortTip, and none.
Uncheck
ed Value
Vertical
Alignme
nt
View
Attribute
View
Instance
Warn
About
Changes

The value when unchecked.

Vertical alignment.
Acceptable values are
"middle", "top", and "bottom".
The name of the view
attribute.
The name of the view object
instance.
Warns the user if there are
pending changes that will be
lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
contained within this
component.

232

Defaul Persona Transl XML Attribute


t Value lizable atable
me
none

admin

no

tipType

string

null

null

no

string

null

null

no

unCheckedValu
e
vAlign

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

optional

null

null

no

xml:lang

Item Styles

messageRadioGroup
Description
The messageRadioGroup item style is a combination of the radioGroup and inlineMessage
controls.
Corresponding web bean: OAMessageRadioGroupBean

Properties
Name
Access
Key

Description

Type

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction",
"firePartialAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati The function to invoke.
string
on
Function
Disable Indicates if validation should boolean
Server not occur on the business tier
Side
during a form submit.

Defaul Persona Transl XML Attribute


t Value lizable atable
null
admin
no
accessKey

none

null

no

primaryClientAc
tion

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

false

null

no

serverUnvalidat
ed

233

OA Extension Component Reference

Name

Description

Validatio
n
Disabled Indicates if the element is
disabled.
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Initial
The initial (default) value of
Value
the item.
Long Tip The fully-qualified reference
Region to the long tip region.
No Wrap Indicates if cell contents
should be wrapped.
Picklist The view attribute that serves
Display as the displayed value of
Attribute choices.
Picklist The view attribute that serves
Value
as the internal value of
Attribute choices.
Picklist The fully-qualified view object
View
name for the picklist, cached
Definitio at the JVM level.
n
Picklist The view instance name for
View
the picklist.
Instance
Prompt The text label for the
component.
Read
Indicates if the value can be
Only
changed.

234

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

false

null

no

disabled

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

Name

null

null

no

id

string

none

null

no

initSortSeq

string

null

admin

no

defaultValue

jrad:refNa
me
boolean

null

admin

no

longTipRegion

false

null

no

string

null

null

no

cellNoWrapFor
mat
pickListDispAttr

string

null

null

no

pickListValAttr

string

null

null

no

pickListViewDef

string

null

null

no

pickListViewNa
me

string

null

admin

yes

prompt

boolean

false

admin

no

readOnly

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

Rendere Indicates if the component is


d
rendered.
Required Indicates if the user must
enter a value and how that
appears to the user. Two
values are allowed: "yes",
"no".
Scope
The Base Packages which
are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Security Defines the security mode
Mode
used to secure the region. If
set to selfSecured it is the
developer's responsibility to
handle security validation.
The legal values are
standard, and selfSecured.

boolean

true

user

no

rendered

string

no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

string

standa null
rd

no

securityMode

Selective Indicates if the item is part of


Search a group of items, one of
Criteria which must be included in the
search.
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

boolean

false

admin

no

selectiveSearch
Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

The type of tip. The legal


string
values are
dateFormat, longMessage,

none

admin

no

tipType

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

The alternate view attribute


name for use when sorting.
The application short name
that owns the tip message.

235

OA Extension Component Reference

Name

Description

shortTip, and none.


User
Indicates if a user can
Personal personalize this component.
ization
Vertical Vertical alignment.
Alignme Acceptable values are
nt
"middle", "top", and "bottom".
View
The name of the view
Attribute attribute.
View
The name of the view object
Instance instance.
Warn
Warns the user if there are
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
contained within this
component.

236

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

false

admin

no

userCustomiza
ble

string

null

null

no

vAlign

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

optional

null

null

no

xml:lang

Item Styles

messageRatingBar
Description
The messageRatingBar item style creates a rating bar component that allows users to rate a
product, service or entity in an OA Framework-based page. Users may modify existing rating
information or provide new rating information to an updatable rating bar, whereas they may only
view existing rating information for a read-only rating bar.
Corresponding web bean: OAMessageRatingBarBean

Properties
Name
Access
Key
Action
Type

Add
Blank
Value
(In
Release
12.2.2,
this
property
is not
impleme
nted.)
Addition
al Text
Admin
Personal
ization
Attribute
Set
Commen
ts

Description

Type

The character used for quick string


keyboard navigation or
activation.
The action type to fire for the string
component. It should be
either "fireAction",
"firePartialAction" or "none."
Adds an empty value to the boolean
choice list if it is not Required

Defaul Persona Transl XML Attribute


t Value lizable atable
null
admin
no
accessKey

none

null

no

primaryClientAc
tion

true

admin

no

allowBlankValu
e

Additional help text.

string

null

admin

yes

shortDesc

Indicates if an Administrator
can personalize this
component.
The attribute set for the
component.
Comments

boolean

true

admin

no

adminCustomiz
able

null

no

use

null

no

comment

jrad:attribut null
eSetRef
string
null

237

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

CSS
Class
Data
Type

Overrides the default CSS


string
class.
The type of data. The legal
string
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.

null

Destinati
on
Function
Disable
Server
Side
Validatio
n
Disabled

The function to invoke.

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

Indicates if validation should boolean


not occur on the business tier
during a form submit.

false

null

no

serverUnvalidat
ed

Indicates if the element is


disabled.
The alternate view attribute
for use when exporting.

boolean

false

null

no

disabled

Export
View
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.

string

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

Name

null

null

no

id

string

none

null

no

initSortSeq

Initial
Value
Long Tip
Region
No Wrap

string

null

admin

no

defaultValue

jrad:refNa
me
boolean

null

admin

no

longTipRegion

false

null

no

string

null

null

no

cellNoWrapFor
mat
pickListDispAttr

string

null

null

no

pickListValAttr

The initial (default) value of


the item.
The fully-qualified reference
to the long tip region.
Indicates if cell contents
should be wrapped.
Picklist The view attribute that serves
Display as the displayed value of
Attribute choices.
Picklist The view attribute that serves
Value
as the internal value of
Attribute choices.
238

string

admin

Item Styles

Name
Picklist
View
Definitio
n
Picklist
View
Instance
Prompt
Read
Only
Rendere
d
Required

Search
Allowed
Security
Mode

Selective
Search
Criteria
Sort
Allowed

Sort By
View
Attribute
Tip
Message
Appl

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

The fully-qualified view object string


name for the picklist, cached
at the JVM level.

null

null

no

pickListViewDef

The view instance name for


the picklist.

string

null

null

no

pickListViewNa
me

The text label for the


component.
Indicates if the value can be
changed.
Indicates if the component is
rendered.
Indicates if the user must
enter a value and how that
appears to the user. Two
values are allowed: "yes",
"no".
Indicates if the item will be
shown in the search panels.
Defines the security mode
used to secure the region. If
set to selfSecured it is the
developer's responsibility to
handle security validation.
The legal values are
standard, and selfSecured.
Indicates if the item is part of
a group of items, one of
which must be included in the
search.
Indicates if the user can sort
this column. The legal values
are
yes, no, ascending, and des
cending.

string

null

admin

yes

prompt

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

string

no

admin

no

required

boolean

false

admin

no

queryable

string

standa null
rd

no

securityMode

boolean

false

admin

no

selectiveSearch
Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

admin

no

tipMessageApp
ShortName

The alternate view attribute


name for use when sorting.
The application short name
that owns the tip message.

null

239

OA Extension Component Reference

Name

Description

Short
Name
Tip
The name of the tip message.
Message
Name
Tip Type The type of tip. The legal
values are
dateFormat, longMessage,
shortTip, and none.
Total
Indicates if an additional field
Value
should be displayed to show
the total of this column.
User
Indicates if a user can
Personal personalize this component.
ization
Vertical Vertical alignment.
Alignme Acceptable values are
nt
"middle", "top", and "bottom".
View
The name of the view
Attribute attribute.
View
The name of the view object
Instance instance.
Warn
Warns the user if there are
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.

240

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

string

null

admin

no

tipMessageNa
me

string

none

admin

no

tipType

boolean

false

user

no

totalValue

boolean

false

admin

no

userCustomiza
ble

string

null

null

no

vAlign

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

Item Styles

messageRichTextEditor
Description
The messageRichTextEditor item style provides rich text editing capability within the OA
Framework. It can be placed within any region except search regions or tables. The component
allows users to author, edit and view rich text content in a browser that supports IFRAMEs.
The messageRichTextEditor item style extends messageTextInput and can be used to provide
rich text editing capabilities where they are required. Please refer to the messageTextInput
section for more information on all messageRichTextEditor properties.
Corresponding web bean: OAMessageRichTextEditorBean

Properties
Name
Additional
Text
Admin
Personaliz
ation

Description

Additional help
text.
Indicates if an
Administrator can
personalize this
component.
Alignment Indicates if the
Icons
left, center, and
right alignment
icons are
displayed.
Attribute The attribute set
Set
for the
component.
Bullet
Indicates if the
Icons
bullet icons are
displayed.
ClickThru The URI
Destinatio launched from
n URI
the "Click Thru
Destination" icon.
If empty, no icon
is shown.
Comments Comments
Create
Indicates if the

Type

Default Personali Translat


Value
zable
able

XML Attribute

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomizable

boolean

false

null

no

alignmentGroup

jrad:attribute null
SetRef

null

no

use

boolean

true

null

no

bulletGroup

string

null

null

no

clickThruDestinatio
nUri

string
boolean

null
false

null
null

no
no

comment
hyperlinkButton
241

OA Extension Component Reference

Name

Description

Type

Hyperlink create hyperlink


Icon
icon is displayed.
Data Type The type of data. string
The legal values
are
VARCHAR2, and
CLOB.
Disable
Indicates if
boolean
Server
validation should
Side
not occur on the
Validation business tier
during a form
submit.
Edit Icons Indicates if the
boolean
cut, copy and
paste icons are
displayed.
Extends
A reference to
jrad:compone
another
ntRef
component that
creates a
different instance
of that
component at
runtime.
Font Bar Indicates if the
boolean
font bar is
displayed.
Image
The URI
string
Upload
launched from
URl
the insert image
icon. If empty, no
icon is shown.
Indentatio Indicates if the
boolean
n Icons
indentation icons
are displayed.
Long Tip The fully-qualified string
Region
reference to the
long tip region.
Maximum The maximum
unsignedInt
Length
number of
characters that
Also supports
can be entered in Expression
the editor.
Language
(EL) syntax.
242

Default Personali Translat


Value
zable
able

XML Attribute

VARCH null
AR2

no

dataType

false

null

no

serverUnvalidated

true

null

no

editGroup

null

null

no

extends

false

null

no

fontBar

null

null

no

imageUploadUri

false

null

no

indentationGroup

null

admin

no

longTipRegion

null

null

no

maximumLength

Item Styles

Name

Description

Plain Text The display


Mode
height of the text
Height
mode editor in
characters.
Plain Text The display
Mode
length of the text
Length
mode editor in
characters.
Prompt
The text label for
the component.
Read Only Indicates if the
value can be
changed.
Rendered Indicates if the
component is
rendered.
Required Indicates if the
user must enter a
value, and how
that appears to
the user.
Rich Text The display
Mode
height of the rich
Height
text editor in
pixels or % of the
container.
Rich Text The display
Mode
length of the rich
Length
text editor in
pixels or % of the
container.
showRequ
ired
Style
Indicates if the
Icons
bold, italic and
underline icons
are displayed.
Tip
The application
Message short name that
Appl Short owns the tip
Name
message.
Tip
The name of the
Message tip message.
Name
Tip Type The type of tip.

Type

Default Personali Translat


Value
zable
able

XML Attribute

unsignedInt

null

admin

no

textModeDisplayHe
ight

unsignedInt

null

admin

no

textModeDisplayLe
ngth

string

null

admin

yes

prompt

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

string

no

admin

no

required

string

null

admin

no

richTextModeDispl
ayHeight

string

null

admin

no

richTextModeDispl
ayLength

boolean

false

null

no

showRequired

boolean

true

null

no

styleGroup

string

null

admin

no

tipMessageAppSho
rtName

string

null

admin

no

tipMessageName

string

none

admin

no

tipType
243

OA Extension Component Reference

Name
User
Personaliz
ation
Vertical
Aligment
View
Attribute
View
Instance

244

Description

Type

Default Personali Translat


Value
zable
able

XML Attribute

Indicates if a user boolean


can personalize
this component.
Vertical alignment string

false

admin

no

userCustomizable

null

null

no

vAlign

The name of the string


view attribute.
The name of the string
view object
instance.

null

null

no

viewAttr

null

null

no

viewName

Item Styles

messageSpinBox
Description
The messageSpinBox item style is a combination of the textInput and inlineMessage controls.
Corresponding web bean: OAMessageSpinBoxBean

Properties
Name

Description

Type

Access
Key

Defaul Persona Transl XML Attribute


t Value lizable atable

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction",
"firePartialAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.

null

admin

no

accessKey

none

null

no

primaryClientAc
tion

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

Destinati
on
Function
Disable
Server
Side
Validatio

null

admin

no

invokeFunc

false

null

no

serverUnvalidat
ed

The function to invoke.

string

Indicates if validation should boolean


not occur on the business tier
during a form submit.

245

OA Extension Component Reference

Name

Description

n
Disabled Indicates if the element is
disabled.
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Height The display height in
characters.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Initial
Value
Length

The initial (default) value of


the item.
The display length in
characters.
Long Tip The fully-qualified reference
Region to the long tip region.
Maximu The maximum number of
m
characters per line that can
Length be entered.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

false

null

no

disabled

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

unsignedInt 1

null

no

rows

Name

null

null

no

id

string

none

null

no

initSortSeq

string

null

admin

true

unsignedInt null

admin

no

translatableDef
aultValue
columns

jrad:refNa null
me
unsignedInt null

admin

no

longTipRegion

null

no

maximumLengt
h

admin

no

maxValue

Also
supports
Expression
Language
(EL)
syntax.
Maximu Maximum value the user can decimal
null
m Value input.
(Note:
Although
OA
Extension
Declarative
Implement
ation only
246

Item Styles

Name

Description

Minimum Minimum value the user can


Value
input.

No Wrap Indicates if cell contents


should be wrapped.
Prompt The text label for the
component.
Read
Indicates if the value can be
Only
changed.
Rendere Indicates if the component is
d
rendered.
Required Indicates if the user must
enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", and "validaterOnly".

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

supports
integer
type input
for this
property,
this web
bean can
be used
with double
and long
type inputs
in code.)
decimal
null

admin

no

minValue

(Note:
Although
OA
Extension
Declarative
Implement
ation only
supports
integer
type input
for this
property,
this web
bean can
be used
with double
and long
type inputs
in code.)
boolean
false

null

no

string

null

admin

yes

cellNoWrapFor
mat
prompt

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

admin

no

required

ui:required no

247

OA Extension Component Reference

Name

Description

Scope

The Base Packages which


are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Secret Indicates if the value is
visually concealed.
Selective Indicates if the item is part of
Search a group of items, one of
Criteria which must be included in the
search.
showRe
quired
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Sort By
View
Attribute
Step
Size

248

The alternate view attribute


name for use when sorting.
The value that is
added/subtracted to the
current value when the user
clicks on
increment/decrement.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

boolean

false

no

no

secret

boolean

false

admin

no

selectiveSearch
Criteria

boolean

false

null

no

showRequired

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

decimal

admin

no

stepSize

(Note:
Although
OA
Extension
Declarative
Implement
ation only
supports
integer
type input
for this
property,
this web
bean can
be used
with double
and long
type inputs
in code.)

Item Styles

Name
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

Description
The application short name
that owns the tip message.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

none

admin

no

tipType

false

user

no

totalValue

false

admin

no

userCustomiza
ble

null

null

no

vAlign

null

null

no

viewAttr

null

null

no

viewName

true

null

no

warnAboutChan
ges

null

null

no

xml:lang

The type of tip. The legal


string
values are
dateFormat, longMessage,
shortTip, and none.
Total
Indicates if an additional field boolean
Value
should be displayed to show
the total of this column.
User
Indicates if a user can
boolean
Personal personalize this component.
ization
Vertical Vertical alignment.
string
Alignme Acceptable values are
nt
"middle", "top", and "bottom".
View
The name of the view
string
Attribute attribute.
View
The name of the view object string
Instance instance.
Warn
Warns the user if there are
boolean
About
pending changes that will be
Changes lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
optional
contained within this
component.

249

OA Extension Component Reference

messageStyledText
Description
The messageStyledText item style is a combination of the styledText and inlineMessage
controls.
Corresponding web bean: OAMessageStyledTextBean

Properties
Name

Description

Type

Access
Key

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.
Destinati
on
Function
Destinati
on URI
Disable
Server
250

Defaul Persona Transl XML Attribute


t Value lizable atable
null
admin
no
accessKey

none

null

no

primaryClientAc
tion

null

admin

true

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

null

no

destination

null

no

serverUnvalidat
ed

The function to invoke.

string

The destination URI.

uriReferenc null
e
boolean
false

Indicates if validation should


not occur on the business tier

Item Styles

Name
Side
Validatio
n
Docume
nt Name
Export
View
Attribute
Extends

Description

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

during a form submit.

The name of the component


The alternate view attribute
for use when exporting.

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

A reference to another
component that creates a
different instance of that
component at runtime.
Height The display height of the
Search item in characters.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.

jrad:compo null
nentRef

null

no

extends

unsignedInt null

null

no

rows

Name

null

null

no

id

string

none

null

no

initSortSeq

Long Tip
Region
Maximu
m
Length

jrad:refNa null
me
unsignedInt null

admin

no

longTipRegion

admin

no

maximumLengt
h

Also
supports
Expression
Language
(EL)
syntax.
boolean
false

null

no

boolean

false

admin

no

cellNoWrapFor
mat
popupEnabled

string

null

admin

no

popupId

string

onClick admin

no

popupRenderE
vent

string

null

admin

yes

prompt

boolean

true

user

no

rendered

The fully-qualified reference


to the long tip region.
The number of characters a
user can enter as search
criteria for this field in a
results-based (automatic)
search.

No Wrap Indicates if cell contents


should be wrapped.
Popup Indicates whether the pop-up
Enabled is enabled.
Popup The unique name of the popID
up.
Popup Indicates on what action type
Render the event is to be rendered
Event
for the pop-up.
Prompt The text label for the
component.
Rendere Indicates if the component is
d
rendered.

251

OA Extension Component Reference

Name

Description

Required Indicates if the user must


enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", "default".
Scope
The Base Packages which
are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Selective Indicates if the item is part of
Search a group of items, one of
Criteria which must be included in the
search.
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

Type

ui:required no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

boolean

false

admin

no

selectiveSearch
Criteria

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

none

admin

no

tipType

false

user

no

totalValue

false

admin

no

userCustomiza
ble

null

null

no

vAlign

The alternate view attribute


name for use when sorting.
The application short name
that owns the tip message.

The type of tip. The legal


string
values are
dateFormat, longMessage,
shortTip, and none.
Total
Indicates if an additional field boolean
Value
should be displayed to show
the total of this column.
User
Indicates if a user can
boolean
Personal personalize this component.
ization
Vertical Vertical alignment.
string
Alignme Acceptable values are
252

Defaul Persona Transl XML Attribute


t Value lizable atable

Item Styles

Name
nt
View
Attribute
View
Instance
Warn
About
Changes

Description

"middle", "top", and "bottom".


The name of the view
attribute.
The name of the view object
instance.
Warns the user if there are
pending changes that will be
lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
Width
The display length of the
Search item in characters.
xml:lang Identifies the language
contained within this
component.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

unsignedInt null

null

no

columns

optional

null

no

xml:lang

null

253

OA Extension Component Reference

messageTextInput
Description
The messageTextInput item style is a combination of the textInput and inlineMessage controls.
Corresponding web bean: OAMessageTextInputBean

Properties
Name

Description

Type

Access
Key

Defaul Persona Transl XML Attribute


t Value lizable atable

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be
either "fireAction",
"firePartialAction" or "none."
Addition Additional help text.
string
al Text
Admin
Indicates if an Administrator boolean
Personal can personalize this
ization component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Commen Comments
string
ts
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and C
LOB.

null

admin

no

accessKey

none

null

no

primaryClientAc
tion

null

admin

yes

shortDesc

true

admin

no

adminCustomiz
able

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

Destinati
on
Function
Disable
Server
Side
Validatio

null

admin

no

invokeFunc

false

null

no

serverUnvalidat
ed

254

The function to invoke.

string

Indicates if validation should boolean


not occur on the business tier
during a form submit.

Item Styles

Name

Description

n
Disabled Indicates if the element is
disabled.
Docume The name of the component
nt Name
Export The alternate view attribute
View
for use when exporting.
Attribute
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Height The display height in
characters.
ID
The unique name of this
component.
Initial
Indicates the initial sort
Sort
sequence for each search.
Sequenc The legal values are
none, first, second, and thir
e
d.
Initial
Value
Length

The initial (default) value of


the item.
The display length in
characters.
Long Tip The fully-qualified reference
Region to the long tip region.
Maximu The maximum number of
m
characters per line that can
Length be entered.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

false

null

no

disabled

jrad:refNa
me
string

null

null

no

docName

null

admin

no

exportByViewAt
tr

jrad:compo null
nentRef

null

no

extends

unsignedInt 1

null

no

rows

Name

null

null

no

id

string

none

null

no

initSortSeq

string

null

admin

true

unsignedInt null

admin

no

translatableDef
aultValue
columns

jrad:refNa null
me
unsignedInt null

admin

no

longTipRegion

null

no

maximumLengt
h

null

no

null

admin

yes

cellNoWrapFor
mat
prompt

false

admin

no

readOnly

true

user

no

rendered

Also
supports
Expression
Language
(EL)
syntax.
boolean
false

No Wrap Indicates if cell contents


should be wrapped.
Prompt The text label for the
string
component.
Read
Indicates if the value can be boolean
Only
changed.
Rendere Indicates if the component is boolean
d
rendered.

255

OA Extension Component Reference

Name

Description

Required Indicates if the user must


enter a value and how that
appears to the user. Three
values are allowed: "yes",
"no", and "validaterOnly".
Scope
The Base Packages which
are allowed to reuse this
component.
Search Indicates if the item will be
Allowed shown in the search panels.
Secret Indicates if the value is
visually concealed.
Selective Indicates if the item is part of
Search a group of items, one of
Criteria which must be included in the
search.
showRe
quired
Sort
Indicates if the user can sort
Allowed this column. The legal values
are
yes, no, ascending, and des
cending.

Sort By
View
Attribute
Tip
Message
Appl
Short
Name
Tip
Message
Name
Tip Type

Total
Value

256

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

ui:required no

admin

no

required

jrad:scope .

null

no

scope

boolean

false

admin

no

queryable

boolean

false

no

no

secret

boolean

false

admin

no

selectiveSearch
Criteria

boolean

false

null

no

showRequired

string

no

admin

no

sortState

Also
supports
Expression
Language
(EL)
syntax.
string
null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp
ShortName

The name of the tip message. string

null

admin

no

tipMessageNa
me

The type of tip. The legal


string
values are
dateFormat, longMessage,
shortTip, and none.
Indicates if an additional field boolean
should be displayed to show
the total of this column.

none

admin

no

tipType

false

user

no

totalValue

The alternate view attribute


name for use when sorting.
The application short name
that owns the tip message.

Item Styles

Name
User
Personal
ization
Vertical
Alignme
nt
View
Attribute
View
Instance
Warn
About
Changes

Description
Indicates if a user can
personalize this component.

Vertical alignment.
Acceptable values are
"middle", "top", and "bottom".
The name of the view
attribute.
The name of the view object
instance.
Warns the user if there are
pending changes that will be
lost, and allows them to
cancel the current action or
discard the changes and
continue with the current
action.
xml:lang Identifies the language
contained within this
component.

Type

Defaul Persona Transl XML Attribute


t Value lizable atable

boolean

false

admin

no

userCustomiza
ble

string

null

null

no

vAlign

string

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChan
ges

optional

null

null

no

xml:lang

257

OA Extension Component Reference

rawText
Description
The rawText item style supports output of unescaped text. Use of this class means assuming
full responsibility for generating proper HTML. Clients should strongly consider using elements
in the HTML namespace instead of this class. In particular, this class does not attempt to
encode or escape characters for NLS or HTML compliance.
Corresponding web bean: OARawTextBean

Properties
Name

Description

Type

Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.
Documen The name of the component
jrad:refNam
t Name
e
Export
The alternate view attribute for string
View
use when exporting.
Attribute
Extends A reference to another
jrad:compo
component that creates a
nentRef
different instance of that
component at runtime.
ID
The unique name of this
Name
component.
258

Default Personal Transla


XML
Value izable
table
Attribute
true
admin
no
adminCusto
mizable
null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

null

no

docName

null

admin

no

exportByVie
wAttr

null

null

no

extends

null

null

no

id

Item Styles

Name
Initial
Sort
Sequenc
e

Description

Type

Indicates the initial sort


string
sequence for each search. The
legal values are
none, first, second, and third
.
No Wrap Indicates if cell contents
boolean
should be wrapped.
Prompt The text label for the
string
component.
Rendere Indicates if the component is boolean
d
rendered.
Scope
The Base Packages which are jrad:scope
allowed to reuse this
component.
Search Indicates if the item will be
boolean
Allowed shown in the search panels.
Sort
Indicates if the user can sort
string
Allowed this column. The legal values
are
Also
yes, no, ascending, and desc supports
ending.
Expression
Language
(EL) syntax.
Sort By The alternate view attribute
string
View
name for use when sorting.
Attribute
Text
The text label for the
string
component.
Total
Indicates if an additional field boolean
Value
should be displayed to show
the total of this column.
User
Indicates if a user can
boolean
Personali personalize this component.
zation
View
The name of the view attribute. string
Attribute
View
The name of the view object
string
Instance instance.
xml:lang Identifies the language
optional
contained within this
component.

Default Personal Transla


Value izable
table

XML
Attribute

none

null

no

initSortSeq

false

null

no

null

admin

true

cellNoWrap
Format
prompt

true

user

no

rendered

null

no

scope

false

admin

no

queryable

no

admin

no

sortState

null

null

no

sortByView
Attr

null

admin

yes

text

false

user

no

totalValue

false

admin

no

userCustom
izable

null

null

no

viewAttr

null

null

no

viewName

null

null

no

xml:lang

259

OA Extension Component Reference

resetButton
Description
The resetButton item style creates a push button which will reset the content of a form.
Corresponding web bean: OAResetButtonBean

Properties
Name

Action
Type

Description

Type

The action type to fire for string


the component. It should
be either "fireAction",
"firePartialAction" or
"none."
Additional Additional help text.
string
Text
Admin
Indicates if an
boolean
Personaliz Administrator can
ation
personalize this
component.
Attribute
The attribute set for the jrad:attributeS
Set
component.
etRef
Comments Comments
string
CSS Class Overrides the default
string
CSS class.
Disable
Indicates if validation
boolean
Server
should not occur on the
Side
business tier during a
Validation form submit.
Document The name of the
jrad:refName
Name
component
Extends
A reference to another jrad:compone
component that creates ntRef
a different instance of
that component at
runtime.
Horizontal Horizontal alignment.
string
Alignment The legal values are
260

Defa Personaliz Translat


ult
able
able
Valu
e

XML
Attribute

null

null

no

primaryClient
Action

null

admin

yes

shortDesc

true

admin

no

adminCustomi
zable

null

null

no

use

null
null

null
admin

no
no

comment
styleClass

false null

no

serverUnvalid
ated

null

null

no

docName

null

null

no

extends

start null

no

hAlign

Item Styles

Name

Description

Type

Defa Personaliz Translat


ult
able
able
Valu
e

XML
Attribute

center, left, right, start,


and end.
ID

The unique name of this


component.
Rendered Indicates if the
component is rendered.
Scope
The Base Packages
which are allowed to
reuse this component.
Text
The text label for the
component.
xml:lang
Identifies the language
contained within this
component.

Name

null

null

no

id

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

null

admin

yes

text

optional

null

null

no

xml:lang

261

OA Extension Component Reference

richContainer

Description
The richContainer item style is used to create a container to hold external rich content.
Examples of external content include embedded analytics from Oracle Business Intelligence
Applications (OBIA), Adobe Flex or third-party Oracle-compatible widgets. The richContainer
can accept either an URL or URI of the rich content. The rich content may be embedded within
an OA Framework page directly, or enclosed within an iFrame depending on the rich content
source. The richContainer exposes a set of parameters that can be set by the root OA
Framework application and passed to the rich content URL, allowing context-sensitive content.
richContainer extends flowlayout and inherits all the attributes from it. See the section on
flowLayout for a list of attributes available on the flowLayout element.
Corresponding web bean: OARichContainerBean

Properties
Name

Descriptio
n

Admin
Indicates if
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
attribute
set for the
component
.
Comments Comments
Content Type Indicates
the type of
content to
embed.
Destination The
Function
developer
262

Type

boolean

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true

admin

no

adminCustomiza
ble

null

no

use

string
null
null
anySimpleType OBIE admin
E

no
no

comment
richContentType

anyURI

no

invokeFunc

jrad:attributeSet null
Ref

null

admin

Item Styles

Name

Height

ID

Name

Parameters

View
Instance

Width

Descriptio
n
name of
the FND
function
used to
secure the
embedded
content or
widget.
The display
height in
pixels.
The unique
name of
this
component
.
The display
name of
the
content.
The
parameters
that can be
passed to
the
embedded
content as
a list of
commaseparated,
namevalue pairs.
The name
of the view
object
instance.
Indicates
the width in
pixels or as
a
percentage
(if % sign
included).

Type

Defau Personalizab Translatab XML Attribute


lt
le
le
Value

string

null

admin

no

height

Name

null

null

no

id

string

null

admin

yes

name

string

null

admin

yes

richParameters

string

null

null

no

viewName

string

null

null

no

width

263

OA Extension Component Reference

264

Item Styles

richTextEditor
Description
Note: The richTextEditor item style has been deprecated; use messageRichTextEditor instead.
The richTextEditor item style provides rich text editing capability within the OA Framework. It
can be placed within any region except search regions or tables. The component allows users
to author, edit and view rich text content in a browser that supports IFRAMEs.
The richTextEditor item style extends messageTextInput and can be used to provide rich text
editing capabilities where they are required. Please refer to the messageTextInput section for
more information on all richTextEditor properties.
Corresponding web bean: OARichTextEditorBean

Properties
Name
Additional
Text
Admin
Personaliz
ation

Description

Additional help
text.
Indicates if an
Administrator can
personalize this
component.
Alignment Indicates if the
Icons
left, center, and
right alignment
icons are
displayed.
Attribute The attribute set
Set
for the
component.
Bullet
Indicates if the
Icons
bullet icons are
displayed.
ClickThru The URI
Destinatio launched from
n URI
the "Click Thru
Destination" icon.
If empty, no icon
is shown.
Comments Comments

Type

Default Personali Translat


Value
zable
able

XML Attribute

string

null

admin

yes

shortDesc

boolean

true

admin

no

adminCustomizable

boolean

false

null

no

alignmentIcons

jrad:attribute null
SetRef

null

no

use

boolean

true

null

no

bulletIcons

string

null

null

no

clickThruDestinatio
nUri

string

null

null

no

comment
265

OA Extension Component Reference

Name
Create
Hyperlink
Icon
Data Type

Description

Indicates if the
boolean
create hyperlink
icon is displayed.
The type of data. string
The legal values
are
VARCHAR2, and
CLOB.

Edit Icons Indicates if the


cut, copy and
paste icons are
displayed.
Extends
A reference to
another
component that
creates a
different instance
of that
component at
runtime.
Font Bar Indicates if the
font bar is
displayed.
Image
The URI
Upload
launched from
URl
the insert image
icon. If empty, no
icon is shown.
Indentatio Indicates if the
n Icons
indentation icons
are displayed.
Initial
The initial
Value
(default) value of
the item.
Long Tip The fully-qualified
Region
reference to the
long tip region.
Maximum The maximum
Length
number of
characters that
can be entered in
the editor.
Plain Text The display
Mode
height of the text
266

Type

Default Personali Translat


Value
zable
able
null

no

hyperlinkIcon

VARCH null
AR2

no

dataType

true

null

no

editIcons

jrad:compone null
ntRef

null

no

extends

boolean

false

null

no

fontBar

string

null

null

no

imageUploadUri

boolean

false

null

no

indentationIcons

string

null

admin

yes

translatableDefault
Value

string

null

admin

no

longTipRegion

unsignedInt

null

null

no

maximumLength

Also supports
Expression
Language
(EL) syntax.
unsignedInt null

null

no

textModeDisplayHe
ight

boolean

false

XML Attribute

Item Styles

Name
Height
Plain Text
Mode
Length
Read Only

Rendered

Required

Rich Text
Mode
Height

Rich Text
Mode
Length

Description
mode editor in
characters.
The display
length of the text
mode editor in
characters.
Indicates if the
value can be
changed.
Indicates if the
component is
rendered.
Indicates if the
user must enter a
value, and how
that appears to
the user.
The display
height of the rich
text editor in
pixels or % of the
container.
The display
length of the rich
text editor in
pixels or % of the
container.

Type

Default Personali Translat


Value
zable
able

XML Attribute

unsignedInt

null

null

no

textModeDisplayLe
ngth

boolean

false

admin

no

readOnly

boolean

true

user

no

rendered

string

no

admin

no

required

string

null

null

no

richTextModeDispl
ayHeight

string

null

null

no

richTextModeDispl
ayLength

false

null

no

showRequired

true

null

no

styleIcons

null

admin

no

tipMessageAppSho
rtName

null

admin

no

tipMessageName

none
null

admin
null

no
no

tipType
vAlign

null

null

no

viewAttr

showRequ
boolean
ired
Style
Indicates if the
boolean
Icons
bold, italic and
underline icons
are displayed.
Tip
The application string
Message short name that
Appl Short owns the tip
Name
message.
Tip
The name of the string
Message tip message.
Name
Tip Type The type of tip.
string
Vertical
Vertical alignment string
Aligment
View
The name of the string

267

OA Extension Component Reference

Name
Attribute
View
Instance

268

Description

Type

view attribute.
The name of the string
view object
instance.

Default Personali Translat


Value
zable
able
null

null

no

XML Attribute

viewName

Item Styles

selectionButton
Description
The selectionButton item style creates specific submit buttons. It can be created only under a
singleSelection or multipleSelection named child in a table region.
Please refer to the submitButton section for more information on all submitButton properties.
Corresponding web bean: OASelectionButtonBean

Properties
Name
Action
Type

Description

Type

The action type to fire for the string


component. It should be either
"fireAction", "firePartialAction"
or "none."
Additiona Additional help text.
string
l Text
Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETIM
E, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.
Destinati The function to invoke.
string
on
Function
Disable Indicates if validation should boolean
Client
not occur on the web tier
Side
during a form submit.
Validatio

Default Personal Transla


XML
Value
izable
table
Attribute
none null
no
primaryClien
tAction

null

admin

yes

shortDesc

true

admin

no

adminCusto
mizable

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

false

null

no

unvalidated

269

OA Extension Component Reference

Name
n
Disable
Server
Side
Validatio
n
Disabled

Description

Indicates if validation should boolean


not occur on the business tier
during a form submit.

Indicates if the element is


disabled.
Documen The name of the component
t Name
Extends A reference to another
component that creates a
different instance of that
component at runtime.
Horizonta Horizontal alignment. The
l
legal values are
Alignmen center, left, right, start, and en
t
d.
ID
The unique name of this
component.
No Wrap Indicates if cell contents
should be wrapped.
Rendere Indicates if the component is
d
rendered.
Scope
The Base Packages which are
allowed to reuse this
component.
Text
The text label for the
component.
User
Indicates if a user can
Personali personalize this component.
zation

270

Type

Default Personal Transla


Value
izable
table

XML
Attribute

false

null

no

serverUnvali
dated

false

null

no

disabled

jrad:refNam null
e
jrad:compon null
entRef

null

no

docName

null

no

extends

string

start

null

no

hAlign

Name

null

null

no

id

boolean

false

null

no

boolean

true

user

no

cellNoWrap
Format
rendered

jrad:scope

null

no

scope

string

null

admin

yes

text

boolean

false

admin

no

userCustomi
zable

boolean

Item Styles

separator
Description
The separator item style creates a horizontal separator.
Corresponding web bean: OASeparatorBean

Properties
Name

Descriptio
n

Type

Admin
Indicates if boolean
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
CSS Class Overrides string
the default
CSS class.
Document
The name jrad:refName
Name
of the
component
Extends
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
ID
The unique Name

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true
admin
no
adminCustomiza
ble

null

null

no

use

null
null

null
admin

no
no

comment
styleClass

null

null

no

docName

null

null

no

extends

null

null

no

id
271

OA Extension Component Reference

Name

Rendered

Scope

xml:lang

272

Descriptio
n

Type

name of
this
component
.
Indicates if boolean
the
component
is
rendered.
The Base jrad:scope
Packages
which are
allowed to
reuse this
component
.
Identifies optional
the
language
contained
within this
component
.

Defau Personalizab Translatab XML Attribute


lt
le
le
Value

true

user

no

rendered

null

no

scope

null

null

no

xml:lang

Item Styles

servletInclude
Description
The servletInclude item style allows you to includes HTML content loaded from a local Servlet or
JSP under the parent region.
Corresponding web bean: OAServletIncludeBean

Properties
Name

Descriptio
n

Type

Admin
Indicates if boolean
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
Extends
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
ID
The unique Name
name of
this
component
.
Rendered
Indicates if boolean

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true

admin

no

adminCustomiza
ble

null

null

no

use

null
null

null
null

no
no

comment
extends

null

null

no

id

true

user

no

rendered
273

OA Extension Component Reference

Name

Source URI

xml:lang

274

Descriptio
n

Type

the
component
is
rendered.
The
uriReference
relative
servlet
URI.
Identifies optional
the
language
contained
within this
component
.

Defau Personalizab Translatab XML Attribute


lt
le
le
Value

null

admin

no

source

null

null

no

xml:lang

Item Styles

spacer
Description
The spacer item style inserts empty space in a page. SpacerBeans occupy a fixed amount of
space in an HTML layout.
Corresponding web bean: OASpacerBean

Properties
Name

Descriptio
n

Type

Admin
Indicates if boolean
Personalizati an
on
Administrat
or can
personalize
this
component
.
Attribute Set The
jrad:attributeSet
attribute
Ref
set for the
component
.
Comments Comments string
CSS Class Overrides string
the default
CSS class.
Document
The name jrad:refName
Name
of the
component
Extends
A reference jrad:component
to another Ref
component
that
creates a
different
instance of
that
component
at runtime.
Height
The display string
height in

Defau Personalizab Translatab XML Attribute


lt
le
le
Value
true
admin
no
adminCustomiza
ble

null

null

no

use

null
null

null
admin

no
no

comment
styleClass

null

null

no

docName

null

null

no

extends

null

no

height

275

OA Extension Component Reference

Name

ID

Rendered

Scope

Width

xml:lang

276

Descriptio
n
pixels.
The unique
name of
this
component
.
Indicates if
the
component
is
rendered.
The Base
Packages
which are
allowed to
reuse this
component
.
Indicates
the width in
pixels.
Identifies
the
language
contained
within this
component
.

Type

Defau Personalizab Translatab XML Attribute


lt
le
le
Value

Name

null

null

no

id

boolean

true

user

no

rendered

jrad:scope

null

no

scope

string

null

null

no

width

optional

null

null

no

xml:lang

Item Styles

staticStyledText
Description
The staticStyledText item style extends styledText. All attributes supported by styledText are
inherited by staticStyledText. See the section on styledText for a list of attributes available on
the styledText element.
Corresponding web bean: OAStaticStyledTextBean

Properties
Name

Description

Action
Type

Type

Default Personali Translat XML Attribute


Value
zable
able

The action type to fire for


the component. It should
be either "fireAction" or
"none."
Admin
Indicates if an
Personali Administrator can
zation
personalize this
component.
Attribute The attribute set for the
Set
component.
Comment Comments
s
CSS
Overrides the default
Class
CSS class.
Data
The type of data. The
Type
legal values are
VARCHAR2, DATE, DA
TETIME, BIGDECIMAL,
NUMBER, BOOLEAN, a
nd CLOB.

string

none

null

no

primaryClientAc
tion

boolean

true

admin

no

adminCustomiz
able

jrad:attribute null
SetRef
string
null

null

no

use

null

no

comment

string

null

admin

no

styleClass

string

VARCH null
AR2

no

dataType

Destinatio
n
Function
Destinatio
n URI
Disable
Server
Side
Validation

The function to invoke.

string

null

admin

no

invokeFunc

The destination URI.

uriReferenc null
e
boolean
false

null

no

destination

null

no

serverUnvalidat
ed

Indicates if validation
should not occur on the
business tier during a
form submit.

277

OA Extension Component Reference

Name

Description

Export
View
Attribute
Extends

Type

The alternate view


attribute for use when
exporting.
A reference to another
component that creates a
different instance of that
component at runtime.
ID
The unique name of this
component.
Initial Sort Indicates the initial sort
Sequence sequence for each
search. The legal values
are
none, first, second, and
third.

string

Message
Appl
Short
Name
Message
Name
No Wrap
Prompt
Search
Allowed
Sort
Allowed

Default Personali Translat XML Attribute


Value
zable
able
null

admin

no

exportByViewAt
tr

jrad:compon null
entRef

null

no

extends

Name

null

null

no

id

string

none

null

no

initSortSeq

The application short


name that owns the
message.

string

null

admin

no

messageAppSh
ortName

The name of the


message.
Indicates if cell contents
should be wrapped.
The text label for the
component.
Indicates if the item will
be shown in the search
panels.
Indicates if the user can
sort this column. The
legal values are
yes, no, ascending, and
descending.

string

null

admin

no

messageName

boolean

false

null

no

string

null

admin

true

cellNoWrapFor
mat
prompt

boolean

false

admin

no

queryable

string

no

admin

no

sortState

user

no

totalValue

admin

no

userCustomiza
ble

null

no

warnAboutChan
ges

Also
supports
Expression
Language
(EL) syntax.
Total
Indicates if an additional boolean
false
Value
field should be displayed
to show the total of this
column.
User
Indicates if a user can
boolean
false
Personali personalize this
zation
component.
Warn
Warns the user if there
boolean
true
About
are pending changes that
278

Item Styles

Name

Description

Type

Default Personali Translat XML Attribute


Value
zable
able

Changes will be lost, and allows


them to cancel the
current action or discard
the changes and
continue with the current
action.

279

OA Extension Component Reference

styledText
Description
The styledText item style supports styled text and links.
Corresponding web bean: OAStyledTextBean

Properties
Name

Description

Type

Additiona Additional help text.


string
l Text
Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETI
ME, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.
Destinati
on
Function
Destinati
on URI
Documen
t Name
Extends

280

Default Personal Transla


XML
Value izable
table
Attribute
null
admin
yes
shortDesc
true

admin

no

adminCusto
mizable

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

null

no

destination

null

no

docName

null

no

extends

The function to invoke.

string

The destination URI.

uriReferenc null
e
jrad:refNam null
e
jrad:compo null
nentRef

The name of the component


A reference to another
component that creates a
different instance of that
component at runtime.

Item Styles

Name
ID

Description

Type

The unique name of this


Name
component.
Initial
Indicates the initial sort
string
Sort
sequence for each search. The
Sequenc legal values are
none, first, second, and third
e
.
Rendere Indicates if the component is boolean
d
rendered.
Scope
The Base Packages which are jrad:scope
allowed to reuse this
component.
Sort
Indicates if the user can sort
string
Allowed this column. The legal values
are
Also
yes, no, ascending, and desc supports
ending.
Expression
Language
(EL) syntax.
Sort By The alternate view attribute
string
View
name for use when sorting.
Attribute
Text
The text label for the
string
component.
Total
Indicates if an additional field boolean
Value
should be displayed to show
the total of this column.
View
The name of the view attribute. string
Attribute
View
The name of the view object
string
Instance instance.
xml:lang Identifies the language
optional
contained within this
component.

Default Personal Transla


Value izable
table

XML
Attribute

null

null

no

id

none

null

no

initSortSeq

null

user

no

rendered

null

no

scope

no

admin

no

sortState

null

null

no

sortByView
Attr

null

admin

yes

text

false

user

no

totalValue

null

null

no

viewAttr

null

null

no

viewName

null

null

no

xml:lang

281

OA Extension Component Reference

submitButton
Description
The submitButton item style creates a push button which allows submission of forms. The
"destination" attribute of a submit button is ignored. Instead, the destination of the form is used.
Corresponding web bean: OASubmitButtonBean

Properties
Name
Access
Key

Description

Type

The character used for quick string


keyboard navigation or
activation.
Action
The action type to fire for the string
Type
component. It should be either
"fireAction", "firePartialAction"
or "none."
Additiona Additional help text.
string
l Text
Admin
Indicates if an Administrator
boolean
Personali can personalize this
zation
component.
Attribute The attribute set for the
jrad:attribut
Set
component.
eSetRef
Comment Comments
string
s
CSS
Overrides the default CSS
string
Class
class.
Data
The type of data. The legal
string
Type
values are
VARCHAR2, DATE, DATETIM
E, BIGDECIMAL,
NUMBER, BOOLEAN, and CL
OB.
Destinati The function to invoke.
string
on
Function
Disable Indicates if validation should boolean
Client
not occur on the web tier
Side
during a form submit.
282

Default Personal Transla


XML
Value
izable
table
Attribute
null
admin
no
accessKey

none

null

no

primaryClien
tAction

null

admin

yes

shortDesc

true

admin

no

adminCusto
mizable

null

null

no

use

null

null

no

comment

null

admin

no

styleClass

VARC null
HAR2

no

dataType

null

admin

no

invokeFunc

false

null

no

unvalidated

Item Styles

Validatio
n
Disable
Server
Side
Validatio
n
Disabled

Indicates if validation should boolean


not occur on the business tier
during a form submit.

false

null

no

serverUnvali
dated

Indicates if the element is


boolean
false
disabled.
Documen The name of the component jrad:refNam null
t Name
e
Event
Name of the event.
string
null
Extends A reference to another
jrad:compon null
component that creates a
entRef
different instance of that
component at runtime.
Horizonta Horizontal alignment. The
string
start
l
legal values are
Alignmen center, left, right, start, and en
t
d.
ID
The unique name of this
Name
null
component.
No Wrap Indicates if cell contents
boolean
false
should be wrapped.
Prompt The text label for the
string
null
component.
Rendere Indicates if the component is boolean
true
d
rendered.
Scope
The Base Packages which are jrad:scope .
allowed to reuse this
component.
Text
The text label for the
string
null
component.
User
Indicates if a user can
boolean
false
Personali personalize this component.
zation
View
The name of the view object string
null
Instance instance.
Warn
Warns the user if there are
boolean
false
About
pending changes that will be
Changes lost, and allows them to cancel
the current action or discard
the changes and continue with
the current action.
xml:lang Identifies the language
optional
null
contained within this

null

no

disabled

null

no

docName

null
null

no
no

event
extends

null

no

hAlign

null

no

id

null

no

admin

true

cellNoWrap
Format
prompt

user

no

rendered

null

no

scope

admin

yes

text

admin

no

userCustomi
zable

null

no

viewName

null

no

warnAboutC
hanges

null

no

xml:lang

283

OA Extension Component Reference

component.

284

Item Styles

tip
Description
The tip item style provides page or section level hints to the user.
Typically, the only indexed child of the tip will be a TextNode, but as many children as
necessary can be added and will be laid out as with a flowLayout.
Corresponding web bean: OATipBean

Properties
Name

Descripti
on

Type

Admin
Indicates if boolean
Personalizat an
ion
Administra
tor can
personaliz
e this
componen
t.
Attribute Set The
jrad:attributeSet
attribute Ref
set for the
componen
t.
Comments Comments string
CSS Class Overrides string
the default
CSS
class.
Document The name jrad:refName
Name
of the
componen
t
Extends
A
jrad:component
reference Ref
to another
componen
t that
creates a

Defau Personaliza Translata


lt
ble
ble
Value

XML Attribute

true

admin

no

adminCustomizable

null

null

no

use

null
null

null
admin

no
no

comment
styleClass

null

null

no

docName

null

null

no

extends

285

OA Extension Component Reference

Name

ID

Rendered

Scope

Text

Tip
Message
Appl Short
Name

Tip
Message
Name
xml:lang

286

Descripti
on

Type

different
instance of
that
componen
t at
runtime.
The
Name
unique
name of
this
componen
t.
Indicates if boolean
the
componen
t is
rendered.
The Base jrad:scope
Packages
which are
allowed to
reuse this
componen
t.
The text
string
label for
the
componen
t.
The
string
application
short
name that
owns the
tip
message.
The name string
of the tip
message.
Identifies optional
the
language
contained
within this
componen

Defau Personaliza Translata


lt
ble
ble
Value

XML Attribute

null

null

no

id

true

user

no

rendered

null

no

scope

null

admin

true

text

null

admin

no

tipMessageAppShort
Name

null

admin

no

tipMessageName

null

null

no

xml:lang

Item Styles

Name

Descripti
on

Type

Defau Personaliza Translata


lt
ble
ble
Value

XML Attribute

t.

287

OA Extension Component Reference

urlInclude
Description
The urlInclude item style allows you to includes HTML content loaded from an external source
under the parent region.
Corresponding web bean: OAUrlIncludeBean

Properties
Name

Description

Admin
Indicates if an
Personalizati Administrator
on
can
personalize
this
component.
Attribute Set The attribute
set for the
component.
Comments Comments
Extends
A reference
to another
component
that creates a
different
instance of
that
component at
runtime.
ID
The unique
name of this
component.
Rendered
Indicates if
the
component is
rendered.
Source URI The
relative/absol
ute URI.
xml:lang
Identifies the
288

Type

boolean

Defau Personaliza Translata


lt
ble
ble
Value
true

XML Attribute

admin

no

adminCustomiza
ble

jrad:attributeSet null
Ref

null

no

use

string
null
jrad:component null
Ref

null
null

no
no

comment
extends

Name

null

null

no

id

boolean

true

user

no

rendered

uriReference

null

admin

no

source

optional

null

null

no

xml:lang

Item Styles

Name

Description

Type

Defau Personaliza Translata


lt
ble
ble
Value

XML Attribute

language
contained
within this
component.

289

OA Extension Component Reference

Documentation Notices
Copyright 2014, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing
restrictions on use and disclosure and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law, you may not use, copy,
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be
error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone
licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system,
integrated software, any programs installed on the hardware, and/or documentation, delivered to
U.S. Government end users are "commercial computer software" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use,
duplication, disclosure, modification, and adaptation of the programs, including any operating
system, integrated software, any programs installed on the hardware, and/or documentation, shall
be subject to license terms and license restrictions applicable to the programs. No other rights are
granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications,
including applications that may create a risk of personal injury. If you use this software or
hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its
affiliates disclaim any liability for any damages caused by use of this software or hardware in
dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC
trademarks are used under license and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or
registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open
Group.
This software or hardware and documentation may provide access to or information on content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible
for and expressly disclaim all warranties of any kind with respect to third-party content,
290

Item Styles

products, and services. Oracle Corporation and its affiliates will not be responsible for any loss,
costs, or damages incurred due to your access to or use of third-party content, products, or
services.
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility
Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For information,
visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

291