Você está na página 1de 266

OA Component Reference

Release 12.2
July 2013

Table of Contents
OA COMPONENT REFERENCE ......................................................................................................... 1 package .....................................................................................................................................1 page ..........................................................................................................................................1 attributeSet ................................................................................................................................2 REGION STYLES .............................................................................................................................5 advancedSearch .......................................................................................................................5 advancedTable ..........................................................................................................................6 bulletedList ..............................................................................................................................23 cellFormat ................................................................................................................................27 contentContainer .....................................................................................................................30 contentFooter ..........................................................................................................................33 defaultDoubleColumn .............................................................................................................. 36 defaultFormStack ....................................................................................................................38 defaultSingleColumn ............................................................................................................... 41 defaultStack .............................................................................................................................44 flexibleContent .........................................................................................................................47 flexibleLayout ..........................................................................................................................51 flowLayout ...............................................................................................................................55 footer .......................................................................................................................................58 Gantt ........................................................................................................................................60 graphTable ..............................................................................................................................65 header .....................................................................................................................................71 HGrid .......................................................................................................................................74

iii

OA Component Reference hideShow .................................................................................................................................78 hideShowHeader .....................................................................................................................82 labeledFieldLayout .................................................................................................................. 85 listOfValues .............................................................................................................................89 messageComponentLayout .................................................................................................... 91 navigationBar ..........................................................................................................................95 pageButtonBar ........................................................................................................................97 pageLayout ..............................................................................................................................99 popUp ....................................................................................................................................104 query .....................................................................................................................................106 rowLayout ..............................................................................................................................111 shuttle ....................................................................................................................................115 stackLayout ...........................................................................................................................118 subTabLayout ........................................................................................................................121 switcher .................................................................................................................................125 table .......................................................................................................................................129 tableLayout ............................................................................................................................134 train .......................................................................................................................................137 tree ........................................................................................................................................139 ITEM STYLES ..............................................................................................................................147 attachmentImage ................................................................................................................... 147 attachmentLink ......................................................................................................................152 attachmentTable ....................................................................................................................157 button ....................................................................................................................................163

iv

Table of Contents exportButton ..........................................................................................................................165 flex .........................................................................................................................................167 formParameter ......................................................................................................................170 formattedText ........................................................................................................................171 formValue ..............................................................................................................................174 image .....................................................................................................................................176 link .........................................................................................................................................179 list ..........................................................................................................................................182 messageCheckBox ............................................................................................................... 184 messageChoice .....................................................................................................................188 messageDownload ................................................................................................................ 192 messageFileUpload ............................................................................................................... 195 messageInlineAttachment ..................................................................................................... 198 messageLovChoice ............................................................................................................... 202 messageLovInput .................................................................................................................. 206 messageRadioButton ............................................................................................................ 212 messageRadioGroup ............................................................................................................ 215 messageRatingBar ................................................................................................................ 219 messageRichTextEditor ........................................................................................................ 223 messageStyledText ............................................................................................................... 226 messageTextInput ................................................................................................................. 230 rawText ..................................................................................................................................234 resetButton ............................................................................................................................236 richContainer .........................................................................................................................238

OA Component Reference richTextEditor ........................................................................................................................240 selectionButton ......................................................................................................................243 separator ...............................................................................................................................245 servletInclude ........................................................................................................................247 spacer ....................................................................................................................................248 staticStyledText .....................................................................................................................250 styledText ..............................................................................................................................253 submitButton .........................................................................................................................254 tip ...........................................................................................................................................257 urlInclude ...............................................................................................................................259

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 Comments Description Comments Type string string Default Personalizable Translatable XML Value Attribute null null no no comment not applicable from null template file null null null

Documentation Formatted Comment text for use with Javadoc. File Version OA Extension Version

The version string of the file.

no no

fileversion version

The Oracle jrad:version null Applications Extension version with which the file was created or updated.

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

Properties
Name Descriptio Type Defaul Personalizabl Translatabl XML 1

OA Extension Component Reference

n Attribute Set

t Value null

e no

Attribut e use

The jrad:attributeSetRe null attribute set f for the component. Comments. string The version string of the file. null null null

Comment s File Version

null null null

no no no

comment fileversion version

OA The Oracle jrad:version Extension Applications Version Extension version with which the file was created or updated.

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.

OA Component Reference

Name

Description

Type

Default Personalizable Translatable XML Value Attribute null no no docName scope

Document The name of Name the component Scope

jrad:refName null

The Base jrad:scope Packages which are allowed to reuse this component.

. null (public)

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 Type Default Personalizable Translatable XML Attribute Value null no intermediaStyle 5

Intermedia Indicates if the

boolean false

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.

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

Region Styles

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 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 Description Type string Defaul Personali Translat t Value zable able null admin yes XML Attribute shortDesc 7

Additional Additional help

OA Extension Component Reference

Text

text. true admin no adminCustomiza ble

Admin Indicates if an boolean Personaliz Administrator can ation personalize this component. AM Definition The fully-qualified string class name for the application module. The instance name of an application module. The attribute set for the component. The number of rows or columns to group with the same shade. The type of banding on the table. The name of the child view attribute. string

null

null

no

amDefName

AM Instance

null

null

no

amUsageName

Attribute Set Banding Interval

jrad:attribute SetRef unsignedInt

null

null

no

use

user

no

bandingInterval

Banding Type Child View Attribute

ui:tableBandi noBan user ngRule ding string null null

no

tableBanding

no

childViewAttrNam e comment controllerClass

Comment Comments s

string

null null

null admin

no no

Controller The fully-qualified string Class class name for the controller object. Detail View Attribute The view attribute string that determines if that particular row is to be stamped with the detail child. boolean

null

null

no

detailViewAttr

Dirty Row Indicates if Sort middle-tier sort Enabled should be performed on the table. Disable Client Side 8 Indicates if validation should not occur on the

false

null

no

dirtyRowSortEna bled

boolean

false

null

no

unvalidated

Region Styles

Validation web tier during a form submit. Document The name of the Name component jrad:refName null null no no docName not applicable

Document Formatted text for string ation use with Javadoc. Comment Empty Table Text Enable Column Reorder Enable Column Resize Enable Detach The text to display string inside an empty table. Enable columns to boolean be reordered by end users Enable columns to boolean be resized by end users. Enable the table boolean to be detached and maximized in the browser. boolean

from null templat e file null null

no

alternateText

true

admin

no

colReorderEnabl ed colResizeEnable d detachEnabled

true

admin

no

true

admin

no

Enable Enable horizontal Horizontal scroll bars in the Scroll table. Extends

true

admin

no

horizontalScrollE nabled extends

A reference to jrad:compone null another ntRef component that creates a different instance of that component at runtime. The version of the string file. The target name for the page online help. string null null

null

no

File Version Help Target Help Target Appl Short Name

null null

no no

file-version helpTarget

This application string 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.

null

null

no

helpTargetAppSh ortName

OA Extension Component Reference

ID

The unique name Name of this component.

null null

null null

no no

id version

OA The Oracle jrad:version Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization. string

null

null

no

regionName

Post Initial Indicates if rows boolean Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record History feature is enabled. boolean

false

null

no

postDefault

false

admin

no

recordHistoryEna bled

Records The maximum unsignedInt Displayed number of rows to display. Rendered Indicates if the component is rendered. Row Header Col Row Header View Attribute Scope boolean

10

admin

no

blockSize

true

user

no

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. jrad:scope

null

admin

no

rowheadercol

null

null

no

rowHeaderViewA ttr

null

no

scope

Security Mode

Defines the string security mode used to secure the region. If set to selfSecured it is the developer's responsibility to

standa null rd

no

securityMode

10

Region Styles

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. boolean false null no standalone

string

null false

admin admin

no no

text userCustomizabl e viewName

User Indicates if a user boolean Personaliz can personalize ation this component. View Instance The name of the view object instance. string

null

null

no

View Link The name of the Instance View Link Instance establishing master-detail relationship between outer and inner repeating containers. Width Indicates the width in pixels or as a percentage (if the % sign is included). Identifies the language contained within this component.

string

null

null

no

viewLinkName

string

null

null

no

width

xml:lang

optional

null

null

no

xml:lang

Element Children
Name detail footer tableActions Quantity Description

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. 11

OA Extension Component Reference

tableSelection 0 through 1 SingleSelectionBean or MultipleSelectionBean to render with the table.

columnGroup
Name Descriptio n Type Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

adminCustomiz able

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments Document Name Extends Comments string The name jrad:refName of the component null null

null

no

use

null null

no no

comment docName

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime. Indicates if boolean the component is rendered. The Base Packages which are allowed to jrad:scope null

null

no

extends

Rendered

user

no

rendered

Scope

null

no

scope

12

Region Styles

reuse this component . User Indicates if boolean Personalizati a user can on personaliz e this component . Valid only when used in table region. xml:lang Identifies optional the language contained within this component . false admin no userCustomizab le

null

null

no

xml:lang

Column
Name Description Type boolean Default Personaliz Translat Value able able true admin no XML Attribute adminCustom izable

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

columnDataFo ui:tableColumnDat textFor user rmat aFormat mat The attribute set for the component. jrad:attributeSetRe null f none null

no no

columnDataF ormat use

The shade of string banding used for the column. The legal values are none, dark, an d light. string

user

no

bandingShad e

Comments Comments

null null

null null

no no

comment docName

Document The name of jrad:refName Name the component

13

OA Extension Component Reference

Extends

A reference to jrad:componentRef null 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 Packages which are allowed to reuse this component. jrad:scope true

null

no

extends

Grid Displayed

user

no

displayGrid

No Wrap

false

user

no

cellNoWrapF ormat

Rendered

null

user

no

rendered

Scope

null

no

scope

Total Value

Indicates if an boolean additional field should be displayed to show the total of this column. boolean

false

user

no

totalValue

User Indicates if a Personaliz user can ation personalize this component. Valid only when used in table region. Width xml:lang column width. Identifies the language

false

admin

no

userCustomiz able

string optional

null null

user null

no no

width xml:lang

14

Region Styles

contained within this component.

sortableHeader
Name Description Type Defa Personali Translat ult zable able Valu e null null no XML Attribute

Abbreviati The value for this string on property 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 Set The attribute set for the component. string boolean

abbreviation

null true

admin admin

yes no

shortDesc adminCusto mizable

jrad:attribute null SetRef string string null null

null null admin null null

no no no no no

use comment styleClass docName extends

Comment Comments s 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.

jrad:refName null jrad:compon entRef null

Initial Sort Indicates the initial sort string Sequence sequence for each search. The legal values are none, first, second, and t

none null

no

initSortSeq

15

OA Extension Component Reference

hird. No Wrap Indicates if cell contents boolean should be wrapped. Valid only when used in table region. The text label for the component. string boolean false null no cellNoWrapF ormat

Prompt

null null no

admin user admin

yes no no

prompt rendered required

Rendered Indicates if the component is rendered. Required Indicator

Indicates if the required ui:required indicator is shown on the column header. Valid values are "no," "uiOnly," "validaterOnly" and "yes." The Base Packages which are allowed to reuse this component. Indicates if the user can sort this column. Valid only when used in table region. The legal values are yes, no, ascending, and descending. The alternate view attribute name for use when sorting. Valid only when used in table region. jrad:scope

Scope

null

no

scope

Sort Allowed

string

no

admin

no

sortState

Sort By View Attribute

string

null

user

no

sortByViewAt tr

User Indicates if a user can Personaliz personalize this ation component. Valid only when used in table region. xml:lang Identifies the language contained within this component.

boolean

false admin

no

userCustomi zable

optional

null

null

no

xml:lang

tableFooter
Name Description Type Defau Personaliz Translat lt able able Value XML Attribute

16

Region Styles

Admin Indicates if an Personaliz Administrator can ation personalize this component. Attribute Set Controller Class Document Name Extends

boolean

true

admin

no

adminCustomi zable

The attribute set for jrad:attributeS null the component. etRef string string null null The fully-qualified class name for the controller object. The name of the component

null null admin

no no no

use comment controllerClas s docName extends

Comments Comments

jrad:refName

null

null null

no no

A reference to jrad:compone null another component ntRef that creates a different instance of that component at runtime. string null

Personaliz The region label ation Label used for Personalization. Post Initial Values 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.

null

no

regionName

boolean

false

null

no

postDefault

Rendered

boolean

null

user

no

rendered

Scope

jrad:scope

null

no

scope

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 selfS ecured.

stand null ard

no

securityMode

17

OA Extension Component Reference

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

addTableRow
Name Descriptio n Overrides string the default text of the Add Rows button. Additional help text. string Type Defau Personaliza Translata lt ble ble Value null admin true XML Attribute

Add Rows Label

text

Additional Text

null true

admin admin

yes no

shortDesc adminCustomiz able

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments Document Name Extends Comments string The name jrad:refName of the component null null

null

no

use

null null

no no

comment docName

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime.

null

no

extends

18

Region Styles

Insert Rows Indicates if boolean Automaticall rows will y be added automatica lly when the Add Rows button is pressed, or if the developer must respond to the event. Rendered Indicates if boolean the component is rendered.

true

null

no

autoInsertion

null

user

no

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 . Identifies optional the language contained within this component .

null

admin

no

rows

null

no

scope

xml:lang

null

null

no

xml:lang

totalRow
Name Descriptio n Additional help text. string Type Defau Personaliza Translata lt ble ble Value null admin yes XML Attribute

Additional Text

shortDesc

19

OA Extension Component Reference

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

true

admin

no

adminCustomiz able

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments Disable Total Recalculatio n Comments string Indicates if boolean the button used to update totals should not be rendered. The name jrad:refName of the component null false

null

no

use

null admin

no no

comment readOnly

Document Name Extends

null

null

no

docName

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime. null

null

no

extends

Recalculate Overrides string Totals Label the default text of the Update Totals button. Rendered Indicates if boolean the component is rendered.

admin

true

text

true

user

no

rendered

20

Region Styles

Scope

The Base jrad:scope Packages which are allowed to reuse this component . Identifies optional the language contained within this component .

null

no

scope

xml:lang

null

null

no

xml:lang

lovActionButton
Name Descriptio n Additional help text. Type Defau Personaliza Translata lt ble ble Value null true admin admin yes no XML Attribute

Additional Text

string

shortDesc adminCustomiza ble

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this componen t.

Attribute Set The jrad:attributeSet null attribute Ref set for the componen t. Comments CSS Class Comments string Overrides string the default CSS class. The name jrad:refName of the componen t A reference null null

null

no

use

null admin

no no

comment styleClass

Document Name

null

null

no

docName

Extends

jrad:component null Ref

null

no

extends

21

OA Extension Component Reference

to another componen t that creates a different instance of that componen t at runtime. External LOV The name jrad:component null of the Ref external List of Values region. The text string label for the componen t. Indicates if boolean the componen t is rendered. The Base jrad:scope Packages which are allowed to reuse this componen t. Identifies optional the language contained within this componen t. null null no externalListOfVal ues

Prompt

admin

true

prompt

Rendered

null

user

no

rendered

Scope

null

no

scope

xml:lang

null

null

no

xml:lang

lovActionMap
Name Descriptio n string Type Defaul Personalizabl t Value e null admin Translatabl XML e Attribute yes shortDes

Additiona Additional 22

Region Styles

l Text Attribute Set

help text. The jrad:attributeSetRe null attribute set f for the component. The name of the item in the List Of Values region. jrad:localRefString null null no

c use

LOV Region Item

null

no

lovItem

Rendere d

Indicates if boolean the component is rendered. The name jrad:localRef of the item in the base page that receives the result from the LOV Region Item.

null

user

no

rendered

Return Item

null

null

no

resultTo

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.

23

OA Extension Component Reference 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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

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

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef null null

null null null

no no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS 24 Overrides the string string

null null

null admin

no no

comment controllerClass

string

null

admin

no

styleClass

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value null no no

XML Attribute

Class

default CSS class. jrad:refName null string docName not applicable

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

from null templ ate file null null

A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. The version of the file. The display height in characters. string string

no

extends

File Version Height Help Target Help Target Appl Short Name

null null null

null null null

no no no

file-version height helpTarget

The target name for string the page online help. This application will string 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. Name jrad:version

null

null

no

helpTargetAppSh ortName

ID

null null

null null

no no

id version

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization. Post Initial Indicates if rows

string

null

null

no

regionName

boolean

false

null

no

postDefault 25

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

Values

which are made dirty only by the defaulting of Initial Values are to be posted. boolean true user no rendered

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

jrad:scope

null

no

scope

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 self Secured. boolean

stand null ard

no

securityMode

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

false

null

no

standalone

string

null

null

no

viewLinkName

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

26

Region Styles

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 Description Type Defau Personaliz Translat XML Attribute lt able able Value true null no addChildren

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance Attribute Set The fully-qualified class name for the application module. The instance name of an application module.

true

admin

no

adminCustomiz able

string

null

null

no

amDefName

string

null

null

no

amUsageName

The attribute set for jrad:attribute the component. SetRef string

null null

null null

no no

use childViewAttrN ame 27

Child View The name of the Attribute child view attribute.

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value null null no childViewUsag eName

Child View Renders an Instance instance of the object for each row in the View Instance. Column Span The number of columns spanned by the cell. The fully-qualified class name for the controller object.

string

string

(if not null set): 1 null null null admin

no

columnSpan

Comments Comments Controller Class

string string

no no

comment controllerClass

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

string

null

admin null

no no no

styleClass docName not applicable

jrad:refName null string

from null templ ate file null

A reference to jrad:compone null another component ntRef that creates a different instance of that component at runtime. The version of the file. The display height in pixels. string string string null null null

no

extends

File Version Height

null null null

no no no

file-version height hAlign

Horizontal Horizontal Alignment alignment. Acceptable values are "center", "left", "right", "start", and "end". ID OA Extension Version 28

The unique name of Name this component. The Oracle Applications Extension version jrad:version

null null

null null

no no

id version

Region Styles

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value

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. Rendered Indicates if the component is rendered. string null null no regionName

boolean

false

null

no

postDefault

boolean

true

user

no

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. 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 self Secured. Vertical aligmnet. Acceptable values are "middle", "top", and "bottom". string

(if not null set): 1 . null

no no

rowSpan scope

Security Mode

stand null ard

no

securityMode

Vertical Alignment

null

null

no

vAlign

View Link Instance

The name of the string View Link Instance establishing masterdetail relationship between outer and inner repeating containers.

null

null

no

viewLinkName

29

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value null null no width

Width

Indicates the width in pixels or as a percentage (if % sign included).

string

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

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 Description Type Defau Personaliz Translat XML Attribute lt able able Value true null no addChildren

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

Admin Indicates if an Personaliz Administrator can 30

true

admin

no

adminCustomiz able

Region Styles

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value

ation AM Definition AM Instance Attribute Set

personalize this component. The fully-qualified class name for the application module. The instance name of an application module. string null null no amDefName

string

null

null

no

amUsageName

The attribute set for jrad:attribute the component. SetRef

null null

null null

no no

use background

Backgroun The background ui:backgroun d Shade shade of the content dType container. It should be one of "light", "medium", "dark", or "transparent". 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 Class The fully-qualified class name for the controller object. string string

null null

null null

no no

childViewAttrN ame childViewUsag eName

string string

null null

null admin

no no

comment controllerClass

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

string

null

admin null

no no no

styleClass docName not applicable

jrad:refName null string

from null templ ate file null

A reference to jrad:compone null another component ntRef that creates a different instance of that component at runtime.

no

extends

31

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value null null null null null admin null null no no no no file-version icon id version

File Version Icon URI ID OA Extension Version

The version of the file. the URI for the icon file.

string anyURI

The unique name of Name this component. The Oracle Applications Extension version with which the file was created or updated. jrad:version

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. Rendered Indicates if the component is rendered.

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

Scope

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 self Secured. The text label for the component. The name of the string string

null

no

scope

Security Mode

stand null ard

no

securityMode

Text View Link 32

null null

admin null

no no

text viewLinkName

Region Styles

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value

Instance

View Link Instance establishing masterdetail relationship between outer and inner repeating containers. Indicates the width in pixels or as a percentage (if % sign included). string null null no width

Width

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

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

33

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value true admin no adminCustomiz able

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance Attribute Set The fully-qualified class name for the application module. The instance name of an application module.

boolean

string

null

null

no

amDefName

string

null

null

no

amUsageName

The attribute set for jrad:attribute the component. SetRef string string

null null null

null null null

no no no

use childViewAttrN ame childViewUsag eName

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 Class The fully-qualified class name for the controller object.

string string

null null

null admin

no no

comment controllerClass

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

string

null

admin null

no no no

styleClass docName not applicable

jrad:refName null string

from null templ ate file null

A reference to jrad:compone null another component ntRef that creates a different instance of that component at runtime. The version of the file. string null null

no

extends

File Version ID

null null

no no

file-version id

The unique name of Name this component.

34

Region Styles

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value null null no version

OA Extension Version

The Oracle Applications Extension version with which the file was created or updated.

jrad:version

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. Rendered Indicates if the component is rendered.

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

Scope

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 self Secured. The name of the string View Link Instance establishing masterdetail relationship between outer and inner repeating containers. Identifies the optional language contained within this

null

no

scope

Security Mode

stand null ard

no

securityMode

View Link Instance

null

null

no

viewLinkName

xml:lang

null

null

no

xml:lang

35

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat XML Attribute lt able able Value

component.

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 Type Defa Personali Translat ult zable able Value true admin no XML Attribute

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance Attribute Set 36

boolean

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef

null

no

use

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value null null null null no no

XML Attribute

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Extends Overrides the default CSS class. string string

childViewAttrNam e childViewUsageN ame

null null

null admin

no no

comment controllerClass

string

null null

admin null

no no

styleClass extends

A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. The target name for string the page online help. This application will string 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. boolean

Help Target Help Target Appl Short Name

null

null

no

helpTarget

null

null

no

helpTargetAppSh ortName

Hide Header Icon URI

false

null

no

headerDisabled

the URI for the icon anyURI file. string

null null

admin null

no no

icon regionName

Personaliz The region label ation used for Label Personalization. Post Initial Indicates if rows

boolean

false

null

no

postDefault 37

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

Values

which are made dirty only by the defaulting of Initial Values are to be posted. Indicates if Record History feature is enabled. boolean false admin no recordHistoryEna bled rendered

Record History Enabled

Rendered Indicates if the component is rendered. Security Mode

boolean

null

user

no

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 self Secured. boolean

stand null ard

no

securityMode

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

false

null

no

standalone

string string

null null

admin null

yes no

text viewLinkName

defaultFormStack
38

Region Styles

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 Type Defa Personali Translat ult zable able Value true admin no XML Attribute

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition

boolean

adminCustomizab le

The fully-qualified string class name for the application module. The instance name of an application module. string

null

null

no

amDefName

AM Instance

null

null

no

amUsageName

Attribute Set

The attribute set jrad:attribute for the component. SetRef string

null null

null null

no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the Attribute child view attribute.

Child View Renders an string Instance instance of the object for each row in the View Instance. Comment s Comments string

null

null

no

null

null

no

comment

39

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null admin no

XML Attribute

Controller Class CSS Class Extends

The fully-qualified string class name for the controller object. Overrides the string default CSS class. A reference to another component that creates a different instance of that component at runtime. jrad:compon entRef

controllerClass

null null

admin null

no no

styleClass extends

Help Target Help Target Appl Short Name

The target name string for the page online help. This application string 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. anyURI string

null

null

no

helpTarget

null

null

no

helpTargetAppSh ortName

Icon URI

null null

admin null

no no

icon regionName

Personaliz The region label ation used for Label Personalization.

Post Initial Indicates if rows boolean Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record boolean History feature is enabled. boolean

false

null

no

postDefault

false

admin

no

recordHistoryEna bled rendered

Rendered Indicates if the component is rendered. 40

true

user

no

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value stand null ard no

XML Attribute

Security Mode

Defines the string 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 Secure. boolean

securityMode

Standalon Indicates if this e region can be rendered on its own. Text View Link Instance The text label for the component.

false

null

no

standalone

string

null null

admin null

yes no

text viewLinkName

The name of the string View Link Instance establishing master-detail relationship between outer and inner repeating containers.

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

41

OA Extension Component Reference

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

Properties
Name Description Type Defa Personali Translat ult zable able Value true admin no XML Attribute

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

boolean

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef null null

null null null

no no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Extends Overrides the default CSS class. string string

null null

null admin

no no

comment controllerClass

string

null null

admin null

no no

styleClass extends

A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. The target name for string the page online help. This application will string

Help Target Help 42

null

null

no

helpTarget

null

null

no

helpTargetAppSh

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

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. Hide Header Icon URI Indicates if the region header is rendered. The URI for the icon file. boolean false null no

ortName

headerDisabled

string string

null null

admin null

no no

icon regionName

Personaliz The region label ation used for Label Personalization. Post Initial Indicates if rows Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record History feature is enabled.

boolean

false

null

no

postDefault

boolean

false

admin

no

recordHistoryEna bled rendered

Rendered Indicates if the component is rendered. Security Mode

boolean

true

user

no

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 self Secured. boolean

stand null ard

no

securityMode

Standalon Indicates if this e region can be

false

null

no

standalone

43

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

rendered on its own. Text View Link Instance The text label for the component. The name of the View Link Instance establishing master-detail relationship between outer and inner repeating containers. string string null null admin null yes no text viewLinkName

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 Type Defa Personali Translat ult zable able Value true admin no XML Attribute

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance

boolean

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

44

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value null null null no no no

XML Attribute

Attribute Set

The attribute set for jrad:attribute null the component. SetRef null null

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class. string string

null null

null admin

no no

comment controllerClass

string string

null

admin

no no

styleClass not applicable

Document Formatted text for ation use with Javadoc. Comment Extends

from null templ ate file null null

A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. The target name for string the page online help. This application will string 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. string string

no

extends

Help Target Help Target Appl Short Name

null

null

no

helpTarget

null

null

no

helpTargetAppSh ortName

Icon URI

null null

admin null

no no

icon regionName 45

Personaliz The region label

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

ation Label

used for Personalization. boolean false null no postDefault

Post Initial Indicates if rows Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record History feature is enabled.

boolean

false

admin

no

recordHistoryEna bled rendered

Rendered Indicates if the component is rendered. Security Mode

boolean

true

user

no

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 self Secured. boolean

stand null ard

no

securityMode

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

false

null

no

standalone

string string

null null

admin null

yes no

text viewLinkName

46

Region Styles

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 Defau Personaliz Translata XML Attribute lt able ble Value remov null e no adminOperation s

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 Personaliza Administrator tion can personalize this component. AM The fullystring

true

null

no

adminCustomiz able

null

null

no

amDefName 47

OA Extension Component Reference

Definition

qualified class name for the application module. The instance name of an application module. The attribute set for the component. Comments string null null no amUsageName

AM Instance

Attribute Set Comments

jrad:attributeS etRef string

null

null

no

use

null null

null admin

no true

comment description

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 not-disclosed, only an outline of the component is shown along with an icon to restore to the disclosed state. The name of jrad:refName the component string

true

null

no

disclosed

Document Name

null

null

no no

docName not applicable

Documenta Formatted text tion for use with Comment Javadoc. Extends A reference to another

from null templ ate file null

jrad:componen null tRef

no

extends

48

Region Styles

component that creates a different instance of that component at runtime. Flexible Layout Reference A reference to string the oa:flexibleLayo ut 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="fals e" 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 Name <uix:base>. The page-wide unique client ID of this node. Whether the boolean flexibleContent is rendered. Whether the border around the layout is boolean null null no flexibleLayoutR ef

ID

null

null

no

id

Rendered

true

admin

no

rendered

Show Border

false

null

no

showBorder

49

OA Extension Component Reference

shown. Show Header Whether the header of this layout is shown. The title to display above the flexible content. boolean true null no showHeader

Title

string

null

null

no

title

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/disclo se 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 Personaliza user can tion personalize this component. View Source Region ID Specifies ID of string the region (within the flexibleContent) on which personalization

null

user

no

userOperations

true

user

no

userCustomiza ble

null

null

no

viewSourceReg ionId

50

Region Styles

views have been defined. View Target Specifies ID of string Region ID the region on which the personalization view should be applied. null null no viewTargetRegi onId

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 Defau Personaliz Translata XML Attribute lt able ble Value add null no adminOperatio ns

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

51

OA Extension Component Reference

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 Personaliza Administrator tion can personalize this component. AM Definition The fullyqualified class name for the application module. The instance name of an application module. boolean true null no adminCustomi zable

string

null

null

no

amDefName

AM Instance

string

null

null

no

amUsageNam e

Attribute Set Columns

The attribute set jrad:attributeS null for the etRef component. The number of string columns the flexibleLayout will have. Use layoutStyle=hori zontal to horizontally layout the contents. Comments string 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. The name of the jrad:refName 1

null

no

use

null

no

columns

Comments Disclosed

null true

null null

no no

comment disclosed

Document 52

null

null

no

docName

Region Styles

Name

component string from null templ ate file null no not applicable

Documenta Formatted text tion for use with Comment Javadoc. Extends A reference to another component that creates a different instance of that component at runtime.

jrad:componen null tRef

no

extends

Height

The pixels or string percentage 'hint' to the browser for the flexibleLayout. Inherited from Name <uix:base>. The page-wide unique client ID of this node. 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. Whether the flexibleLayout is rendered. boolean

null

null

no

height

ID

null

null

no

id

Layout Style

vertica null l

no

layoutStyle

Rendered

true

admin

no

rendered

Rows

The number of string rows the flexibleLayout will have. Use layoutStyle=verti cal to vertically lay out the contents. Whether the boolean

null

no

rows

Show

false

null

no

showBorder 53

OA Extension Component Reference

Border

border around the layout is shown. Whether the header of this layout is shown. The title to display above the flexible layout. boolean false null no showHeader

Show Header Title

string

null

null

no

title

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/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 Personaliza user can tion personalize this component. Width boolean

null

user

no

userOperation s

true

user

no

userCustomiza ble

Provides a width string hint to the browser.

null

admin

no

width

54

Region Styles

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 Description Type Defa Personal Transla ult izable table Valu e true null no XML Attribute

Add Indexed Children

Indicates if indexed children will be automatically added to this UI node tree.

boolean

addChildren

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

boolean

true

admin

no

adminCustomiza ble

AM The fully-qualified class string Definition name for the application module. AM Instance Attribute Set Child View Attribute Child View Instance The instance name of an string application module. The attribute set for the component. jrad:attribut eSetRef

null

null

no

amDefName

null null null

null null null

no no no

amUsageName use childViewAttrNa me

The name of the child string view attribute. Valid only when used in table region. Renders an instance of the object for each row in the View Instance. Valid only when used in table region. string

null

null

no

childViewUsage Name

55

OA Extension Component Reference

Name

Description

Type

Defa Personal Transla ult izable table Valu e null null null admin no no

XML Attribute

Comment Comments s Controller The fully-qualified class Class name for the controller object. CSS Class Overrides the default CSS class.

string string

comment controllerClass

string

null

admin null

no no no

styleClass docName not applicable

Documen The name of the t Name component Documen Formatted text for use tation with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file. The target name for the page online help.

jrad:refNam null e string

from null templ ate file null

jrad:compon null entRef

no

extends

File Version Help Target Help Target Appl Short Name

string string

null null null

null null null

no no no

file-version helpTarget helpTargetAppS hortName

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 applications referenceable. The unique name of this Name component. Indicates the initial sort string sequence for each search. The legal values are none, first, second, an d third. Indicates if cell contents should be wrapped. Valid only when used in boolean

ID Initial Sort Sequenc e

null

null

no no

id initSortSeq

none null

No Wrap

false null

no

cellNoWrapFor mat

56

Region Styles

Name

Description

Type

Defa Personal Transla ult izable table Valu e null no

XML Attribute

table region. OA The Oracle Applications Extension Extension version with Version which the file was created or updated. jrad:version null version

Personali The region label used for string zation Personalization. Label Post Initial Values Prompt Indicates if rows which boolean are made dirty only by the defaulting of Initial Values are to be posted. The text label for the component. string boolean jrad:scope

null

null

no

regionName

false null

no

postDefault

null true .

admin user null

true no no

prompt rendered scope

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

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 selfSecu red. Indicates if the user can sort this column. Valid only when used in table region. The legal values are yes, no, ascending, an d descending. The alternate view attribute name for use when sorting. Valid only when used in table region. string

stand null ard

no

securityMode

Sort Allowed

no

admin

no

sortState

Sort By View Attribute

string

null

user

no

sortByViewAttr

57

OA Extension Component Reference

Name

Description

Type

Defa Personal Transla ult izable table Valu e false null no

XML Attribute

Standalo Indicates if this region ne can be rendered on its own. User Indicates if a user can Personali personalize this zation component. Valid only when used in table region. xml:lang Identifies the language contained within this component.

boolean

standalone

boolean

false admin

no

userCustomizabl e

optional

null

null

no

xml:lang

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 Type Defau Personaliz Translat lt able able Value true admin no XML Attribute adminCustomi zable

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance 58 The fully-qualified class name for the application module. The instance name of an application

boolean

string

null

null

no

amDefName

string

null

null

no

amUsageNam e

Region Styles

Name

Description

Type

Defau Personaliz Translat lt able able Value null null admin no no no

XML Attribute

module. Attribute Set Controller Class The attribute set for the component. The fully-qualified class name for the controller object. jrad:attributeS null etRef string string null null use comment controllerClas s styleClass docName not applicable

Comments Comments

CSS Class Overrides the default CSS class. Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file.

string jrad:refName string

null null

admin null

no no no

from null templ ate file null

jrad:compone null ntRef

no

extends

File Version ID OA Extension Version

string

null null null

null null null

no no no

file-version id version

The unique name of Name this component. The Oracle Applications Extension version with which the file was created or updated. jrad:version

Personaliz The region label ation Label used for Personalization.

string

null

null

no

regionName

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

false

null

no

postDefault

true

user

no

rendered 59

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat lt able able Value

XML Attribute

component is rendered. Scope 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. Identifies the language contained within this component. optional . null no scope

Security Mode

stand null ard

no

securityMode

xml:lang

null

null

no

xml:lang

Element Children
Name copyright privacy Quantity 0 through 1 0 through 1 Description Node to use as a copyright statement. Node to use as a privacy statement.

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.

60

Region Styles 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

Description

Type

Defa Persona Transl XML Attribute ult lizable atable Valu e null null no actualFinishVie wAttr

Actual The view attribute for the string End actual end date of the task for Date the Variance bar Type. View Attribute Actual The view attribute for the string Start actual start date of the task for Date the Variance bar Type. View Attribute Addition Additional help text. al Text Admin Indicates if an Administrator Personal can personalize this ization component. string boolean

null

null

no

actualStartView Attr

null true

admin admin

yes no

shortDesc adminCustomiz able amDefName

AM The fully-qualified class name string Definitio for the application module. n AM The instance name of an Instance application module. Attribute The attribute set for the Set component. Auto Scale string

null

null

no

null

null null user

no no no

amUsageName use autoScale

jrad:attribu null teSetRef true

Indicates if the Gantt chart will boolean scale the axis units depending on the time-period specified. string

Axis End The view attribute for the end Date date of the Gantt chart View horizontal axis. Attribute

null

null

no

endTimeViewA ttr

61

OA Extension Component Reference

Axis Major Scale

The major unit of time for the string Gantt chart horizontal axis. The legal values are years, halfyears, quarters, mo nths, weeks, and days. The minor unit of time for the string Gantt chart horizontal axis. The legal values are years, halfyears, quarters, mo nths, weeks, and days.

mont user hs

no

majorScale

Axis Minor Scale

wee user ks

no

minorScale

Axis The view attribute for the start string Start date of the Gantt chart Date horizontal axis. View Attribute Bar The view attribute indicating Type the bar type. View 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 Comme nts Comments string

null

null

no

startTimeView Attr

null

null

no

barTypeViewAt tr

string

null

null

no

baseFinishVie wAttr

string

null

null

no

baseStartView Attr

string string

null null

null null

no no

comment completedThro ughViewAttr

Complet The view attribute for the ed current 'completed through' Through date of the task. View Attribute

Controll The fully-qualified class name string er Class for the controller object. CSS Class Overrides the default CSS class. string boolean

null null

admin admin

no no no

controllerClass styleClass unvalidated

Disable Indicates if validation should Client not occur on the web tier Side during a form submit. Validatio n

false null

62

Region Styles

Extends A reference to another component that creates a different instance of that component at runtime. Help Target Help Target Appl Short Name The target name for the page online help.

jrad:compo null nentRef

null

no

extends

string

null null

null null

no no

helpTarget helpTargetApp ShortName

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. string

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 Initial Values

null

null

no

leftTextViewAtt r percentComple teViewAttr

string

null

null

no

string

null

null

no

regionName

Indicates if rows which are boolean made dirty only by the defaulting of Initial Values are to be posted. string

false null

no

postDefault

Predece Accessor Name for the ssor predecessor's rowset for the Accesso current task. r 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 Text The view attribute for the text label to the right of the task.

null

null

no

predecessorAc cessor

string

null

null

no

predecessorVie wAttr

string

null

null

no

childBlockSize

boolean

true

user

no

descChildrenVi s

boolean string

true null

user null

no no

rendered rightTextViewA ttr 63

OA Extension Component Reference

View Attribute Search The fully-qualified class name string Controll for the controller object er Class associated with the search results table. Search View Usage The view usage to be used for string running queries on the hGrid. null admin no searchControll erClass

null

null

no

searchViewNa me securityMode

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 selfSecured. Show Bubble Text Show Current Date Show Depend ency Lines Indicates if Bubble Text will be boolean shown for the task. Indicates if a line is drawn to indicate the current date. Indicates if dependency lines are visible. boolean

stan null dard

no

true

user

no

showTooltip

true

user

no

showCurrentDa te showDependen cyLines

boolean

false user

no

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

boolean string

false null null null

no no

standalone barFinishViewA ttr

string

null

null

no

taskIdViewAttr

Task The view attribute for the start string Start date of the task. Date View Attribute User Indicates if a user can Personal personalize this component. ization View 64 The name of the view object boolean

null

null

no

barStartViewAtt r

false admin

no

userCustomiza ble viewName

string

null

null

no

Region Styles

Instance instance. Name

Element Children
Name tableActions tableSelection viewInHierarchy Quantity Description

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

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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add

Indicates if indexed boolean

addChildren 65

OA Extension Component Reference

Indexed Children

children will be automatically added to this UI node tree. boolean true admin no adminCustomizab le

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

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef string string null null

null null admin

no no no

use comment controllerClass

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Extends Overrides the default CSS class.

string

null null

admin null

no no

styleClass extends

A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. Indicates which string components of the graph are rendered. The legal values are both, and graph. Number of graphs to be displayed on each row. unsignedInt

Graph Render Style

graph null

no

renderStyle

Graphs per Row Help Target Help Target Appl Short Name 66

null

null

no

graphsPerRow

The target name for string the page online help. This application will string be used to construct URI of the "help" icon in

null

null

no

helpTarget

null

null

no

helpTargetAppSh ortName

Region Styles

the global menu of the page.This makes the help pages from the other applications referenceable. Personaliz The region label ation used for Label 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. Security Mode string null null no regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

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 self Secured. boolean

stand null ard

no

securityMode

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

false

null

no

standalone

string

null

null

no

viewLinkName

Element Children
67

OA Extension Component Reference

Name graphs tabularFormat 1

Quantity 0 through 1

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

graph
Name Description Type Defa Personali Translat ult zable able Value none admin no XML Attribute aggregateFu nction

Aggreg ate Functio n

The aggregate function to string apply to the data. The legal values are sum, avg, max, min, and n one. boolean

Allow Indicates if a combination Combin graph is allowed. ation Graph AM The fully-qualified class Definitio name for the application n module. AM Instanc e The instance name of an application module.

false

user

no

combo

string

null

null

no

amDefName

string

null

null

no

amUsageNa me use comment styleClass yAxisLabel

Attribute The attribute set for the Set component. Comme Comments nts CSS Class Data Axis Label Data Axis scale from zero Overrides the default CSS class.

jrad:attribute null SetRef string string null null null

null null admin admin

no no no true

The Data Axis label for the string graph. Determines whether the lower limit for Data Axis is zero or the lowest data value. boolean

true

admin

no

yAxisScaleFr omZero

Destinat The Destination URI. ion URI Display Data Bubble 68 Indicates if Bubble Text is displayed for the Data Points.

string boolean

null true

null null

no no

drillDownUrl displayBubbl eText

Region Styles

Text Display Indicates if the data boolean Data markers should be plotted. Markers Display Indicates if this graph has Second a secondary Y-axis. ary YAxis Docume The name of the nt component Name Extends A reference to another component that creates a different instance of that component at runtime. Graph Type boolean false admin no displayDataM arkers dualYAxis

false

user

no

jrad:refNam e

null

null

no

docName

jrad:compon null entRef

null

no

extends

The type of the graph. The string 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. Graph's height in pixels, applicable only if size="custom". Indicates if the component is rendered. string

vertic admin al cluste red bar

no

graphType

Height

null

null

no

height

Render ed Scope

boolean

true .

user null

no no

rendered scope

The Base Packages which jrad:scope are allowed to reuse this component.

Second The label for the secondary string ary data axis. Data Axis Label Size The size of the graph. The string legal values are verysmall, small, medium, large , and custom.

null

user

true

secYAxisLab el

small user

no

size

69

OA Extension Component Reference

Title Width

The title of the graph. Graph's width in pixels, applicable only if size="custom". The X-Axis label for the graph.

string string

null null

admin null

true no

title width

X-Axis Label

string optional

null null

admin null

true no

xAxisLabel xml:lang

xml:lang Identifies the language contained within this component.

Element Children
Name dataMap 1 Quantity Description Lists a bunch of graphData elements.

graphData
Name Description Type Defa Personaliz Translat ult able able Valu e null null no no XML Attribute

Attribute The attribute set for the Set component. Combina tion Graph Type Comme nts Prompt 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'.

jrad:attribute SetRef string

use comboGrap hType

none null

string string

null null

null admin

no true

comment prompt

Purpose Specifies the purpose of string in Graph the graph data element. The legal values are data, groupLabels, and se riesLabels. Seconda Indicates if this graphData boolean ry Axis is plotted on the secondary axis. Stock Value Type 70 The Stock Type Value to use for the graph. The legal values are string

data

null

no

graphAs

false user

no

assignedTo Y2 stockValue

none null

no

Region Styles

high, low, close, and none . View The name of the view Attribute attribute. View The name of the view Instance object instance. string string null null null null no no viewAttr viewName

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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module.

null

null

no

amDefName

71

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null null no

XML Attribute

AM Instance Attribute Set

The instance name string of an application module.

amUsageName

The attribute set for jrad:attribute null the component. SetRef null null

null null null

no no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class. string string

null null

null admin

no no

comment controllerClass

string

null

admin null

no no no

styleClass docName not applicable

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

jrad:refName null string

from null templ ate file null null

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

no

extends

File Version Help Target Help Target Appl Short Name

null null

null null

no no

file-version helpTarget

The target name for string the page online help. This application will string be used to construct URI of the "help" icon in the global menu of

null

null

no

helpTargetAppSh ortName

72

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

the page.This makes the help pages from the other applications referenceable. Icon URI ID The URI for the icon file. The unique name of this component. string Name jrad:version null null null admin null null no no no icon id version

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization. Post Initial Indicates if rows Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record History feature is enabled.

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

false

admin

no

recordHistoryEna bled rendered

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

boolean

true

user

no

jrad:scope

null

no

scope

Security Mode

Defines the security string mode used to secure the region. If set to selfSecured it is the developer's responsibility to

stand null ard

no

securityMode

73

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

handle security validation. The legal values are standard, and self Secured. Standalon Indicates if this e region can be rendered on its own. Text View Link Instance The text label for the component. The name of the View Link Instance establishing master-detail relationship between outer and inner repeating containers. boolean false null no standalone

string string

null null

admin null

yes no

text viewLinkName

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

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 74

Region Styles 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 Description Type Defa Personali Translat ult zable able Value null true admin admin yes no XML Attribute

Additional Additional help text. string Text Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance Attribute Set boolean

shortDesc adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef string string null null

null null admin

no no no

use comment controllerClass

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Disable Client Side Validation Overrides the default CSS class. Indicates if validation should not occur on the web tier during a form submit.

string boolean

null false

admin null

no no

styleClass unvalidated

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

jrad:refName null string

null

no no

docName not applicable

from null templ ate file

75

OA Extension Component Reference

Extends

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

null

null

no

extends

File Version Help Target Help Target Appl Short Name

null null

null null

no no

file-version helpTarget

The target name for string the page online help. This application will string 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 property of the nested region that points to the HGrid region. Name

null

null

no

helpTargetAppSh ortName

ID

null

null

no

id

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization. Post Initial Indicates if rows Values which are made dirty only by the defaulting of Initial Values are to be posted. Record Set Size The maximum number of records that can be displayed under each node.

jrad:version

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

string

null

null

no

childBlockSize

76

Region Styles

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

boolean

true

user

no

rendered

jrad:scope

null

no

scope

Search The fully-qualified string Controller class name for the Class controller object associated with the search results table. Search View Usage Security Mode 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 self Secured. boolean

null

admin

no

searchControllerC lass

null

null

no

searchViewName

stand null ard

no

securityMode

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

false

null

no

standalone

boolean

false

admin

no

userCustomizable

string

null

null

no

width

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

77

OA Extension Component Reference

Element Children
Name tableActions tableSelection Quantity Description

0 through 1 Component used for performing table actions that are independent of row selection. 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.

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 Description Type Defa Personal Transla ult izable table Valu e XML Attribute

78

Region Styles

Name

Description

Type

Defa Personal Transla ult izable table Valu e true null no

XML Attribute

Add Indexed Children

Indicates if indexed children will be automatically added to this UI node tree.

boolean

addChildren

Additional Additional help text. string Text Note: If a hideShow region is created under advancedTable then the Additional Text property is not displayed. Admin Indicates if an Personali Administrator can zation personalize this component. boolean

null

admin

yes

shortDesc

true

admin

no

adminCustomiza ble

AM The fully-qualified class string Definition name for the application module. AM Instance Attribute Set The instance name of an string application module. The attribute set for the component. jrad:attribut eSetRef string string

null

null

no

amDefName

null null null null

null null null admin

no no no no

amUsageName use comment controllerClass

Comment Comments s Controller The fully-qualified class Class name for the controller object. CSS Class Disable Client Side Validation Disable Server Side Validation 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.

string boolean

null

admin

no no

styleClass unvalidated

false null

boolean

false null

no

serverUnvalidat ed

Disclosed The text to display when string Text the children are shown. Disclosed The initial disclosure state. boolean

null

admin

no no

disclosedText disclosed

false user

79

OA Extension Component Reference

Name

Description

Type

Defa Personal Transla ult izable table Valu e null no no

XML Attribute

Documen The name of the t Name component Documen Formatted text for use tation with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file. The target name for the page online help.

jrad:refNam null e string

docName not applicable

from null templ ate file null

jrad:compon null entRef

no

extends

File Version Help Target Help Target Appl Short Name

string string

null null null

null null null

no no no

file-version helpTarget helpTargetAppS hortName

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 applications referenceable. The unique name of this Name component. Indicates the initial sort string sequence for each search. The legal values are none, first, second, an d third.

ID Initial Sort Sequenc e

null

null

no no

id initSortSeq

none null

OA The Oracle Applications Extension Extension version with Version which the file was created or updated.

jrad:version null

null

no

version

Personali The region label used for string zation Personalization. Label Post Initial Values 80 Indicates if rows which are made dirty only by the defaulting of Initial boolean

null

null

no

regionName

false null

no

postDefault

Region Styles

Name

Description

Type

Defa Personal Transla ult izable table Valu e true . user null no no

XML Attribute

Values are to be posted. Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component. boolean jrad:scope rendered scope

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 selfSecu red. Indicates if the user can sort this column. The legal values are yes, no, ascending, an d descending. The alternate view attribute name for use when sorting. boolean

stand null ard

no

securityMode

Sort Allowed

no

admin

no

sortState

Sort By View Attribute

string

null

null

no

sortByViewAttr

Standalo Indicates if this region ne can be rendered on its own.

boolean

false null

no

standalone

Undisclos The text to display when string ed Text the children are hidden. User Indicates if a user can Personali personalize this zation component. View Attribute View Instance xml:lang The name of the view attribute. The name of the view object instance. Identifies the language contained within this component. boolean

null

admin

no no

undisclosedText userCustomizabl e viewAttr viewName xml:lang

false admin

string string optional

null null null

null null null

no no no

81

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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

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

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef string string null null

null null admin

no no no

use comment controllerClass

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class 82 Overrides the default CSS class.

string

null

admin

no

styleClass

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value false null no

XML Attribute

Disable Client Side Validation Disable Server Side Validation

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

boolean

unvalidated

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

false

null

no

serverUnvalidated

Disclosed The initial disclosed boolean state. Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends

false

user null

no no no

disclosed docName not applicable

jrad:refName null string

from null templ ate file null null

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

no

extends

File Version Help Target Help Target Appl Short Name

null null

null null

no no

file-version helpTarget

The target name for string the page online help. This application will string 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 unique name string Name

null

null

no

helpTargetAppSh ortName

Icon URI ID

null null

admin null

no no

icon id 83

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null null no

XML Attribute

of this component. OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label 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. jrad:version version

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

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 self Secured. boolean

stand null ard

no

securityMode

Standalon Indicates if this e region can be rendered on its own. Text The text label for the component.

false

null

no

standalone

string

null

admin

yes

text

84

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value null null null null no no

XML Attribute

View Attribute View Instance xml:lang

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

string string

viewAttr viewName

Identifies the optional language contained within this component.

null

null

no

xml:lang

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

85

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value true null no

XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

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

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef null null

null null null

no no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Columns The number of columns to display in the layout. unsignedInt

null

no

columns

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class.

string string

null null

null admin

no no

comment controllerClass

string

null

admin null

no no no

styleClass docName not applicable

Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends 86 A reference to

jrad:refName null string

from null templ ate file null null

jrad:compon

no

extends

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

another component entRef that creates a different instance of that component at runtime. File Version Help Target Help Target Appl Short Name The version of the file. string null null null null no no file-version helpTarget

The target name for string the page online help. This application will string 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. Name

null

null

no

helpTargetAppSh ortName

ID Item Width

null null

null null

no no

id fieldWidth

Indicates the width string of the item in pixels or as a percentage (if % sign included). jrad:version

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

null

null

no

version

string

null

null

no

regionName

boolean

false

null

no

postDefault

string

null

null

no

labelWidth 87

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

Width

of the prompt in pixels or as a percentage (if % sign included). boolean true user no rendered

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

jrad:scope

null

no

scope

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 self Secured. boolean

stand null ard

no

securityMode

Standalon Indicates if this e region can be rendered on its own. View Link Instance The name of the View Link Instance establishing master-detail relationship between outer and inner repeating containers. Indicates the width in pixels or as a percentage (if % sign included).

false

null

no

standalone

string

null

null

no

viewLinkName

Width

string

null

null

no

width

xml:lang

Identifies the optional language contained within this

null

null

no

xml:lang

88

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

component.

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 Type Defa Personali Translat ult zable able Value true admin no XML Attribute

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 Definition AM Instance Attribute Set

boolean

adminCustomiza ble

boolean

false

admin

no

advancedSearch Allowed

The fully-qualified string class name for the application module. The instance name string of an application module. The attribute set for jrad:attribute the component. SetRef

null

null

no

amDefName

null

null

no

amUsageName

null

null

no

use

89

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null null null admin no no

XML Attribute

Comment s Controller Class CSS Class

Comments The fully-qualified class name for the controller object. Overrides the default CSS class.

string string

comment controllerClass

string

null

admin null

no no no

styleClass docName not applicable

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

jrad:refName null string

from null templ ate file null null

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

no

extends

File Version

null null

null null

no no

file-version version

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label 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

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

90

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

reuse this component. 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 self Secured. Identifies the optional language contained within this component. stand null ard no securityMode

xml:lang

null

null

no

xml:lang

Element Children
Name Quantity Description

searchInstructions 0 through 1 Short instructional text which will display in the search block of the LOV window.

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

91

OA Extension Component Reference

Properties
Name Description Type Defa Personali Translat ult zable able Valu e true null no XML Attribute

Add Indexed Children

Indicates if indexed children will be automatically added to this UI node tree.

boolean

addChildren

Admin Indicates if an Personali Administrator can zation personalize this component. AM The fully-qualified class Definition name for the application module. AM Instance Attribute Set Columns The instance name of an application module. The attribute set for the component.

boolean

true

admin

no

adminCusto mizable

string

null

null

no

amDefName

string

null

null null null null admin

no no no no no

amUsageNa me use columns comment controllerCla ss styleClass docName not applicable

jrad:attribute null SetRef null null null

The number of columns to unsignedInt display in the layout. string string

Comment Comments s Controller The fully-qualified class Class name for the controller object. CSS Class

Overrides the default CSS string class.

null

admin null

no no no

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

jrad:refName null string

from null templ ate file null

A reference to another jrad:compon null component that creates a entRef different instance of that component at runtime. Overrides the preferred string null

no

extends

Field 92

admin

no

fieldWidth

Region Styles

Width

width of the fields in pixels or as a percentage (if % sign included). The version of the file. The unique name of this component. string Name string null null null null no no no file-version id initSortSeq

File Version ID

Initial Sort Indicates the initial sort Sequence sequence for each search. The legal values are none, first, second, and third.

none null

OA The Oracle Applications jrad:version Extension Extension version with Version which the file was created or updated. Personali The region label used for zation Personalization. Label Post Initial Values Prompt Width string

null

null

no

version

null

null

no

regionName

Indicates if rows which boolean are made dirty only by the defaulting of Initial Values are to be posted. Indicates the width of the prompt in pixels or as a percentage (if % sign included). string

false

null

no

postDefault

null

null

no

labelWidth

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

boolean jrad:scope

true .

user null

no no

rendered scope

Search Region

Indicates if this boolean component is used as a search region. Setting this to True overrides settings for the Width, Prompt Width and Field Width. Defines the security mode string used to secure the region. If set to selfSecured it is the developer's responsibility to handle security validation. The

false

null

no

searchRegio n

Security Mode

stand null ard

no

securityMod e

93

OA Extension Component Reference

legal values are standard, and selfSecure d. Sort Allowed Indicates if the user can sort this column. The legal values are yes, no, ascending, and descending. The alternate view attribute name for use when sorting. Indicates the width in pixels or as a percentage (if % sign included). Identifies the language contained within this component. boolean no admin no sortState

Sort By View Attribute Width

string

null

null

no

sortByViewA ttr width

string

null

null

no

xml:lang

optional

null

null

no

xml:lang

messageLayout
Name Descriptio n Type Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

adminCustomiz able

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments Prompt Comments string The text string label for the component . Indicates if boolean the component null null

null

no

use

null admin

no yes

comment prompt

Rendered

true

user

no

rendered

94

Region Styles

is rendered.

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 Description Type Defau Personaliz Translat lt able able Value true null no XML Attribute addChildren

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance Attribute Set Controller The fully-qualified class name for the application module. The instance name of an application module. The attribute set for the component. The fully-qualified

true

admin

no

adminCustomi zable

string

null

null

no

amDefName

string

null

null

no

amUsageNam e use comment controllerClas 95

jrad:attributeS null etRef string string null null

null null admin

no no no

Comments Comments

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat lt able able Value s

XML Attribute

Class

class name for the controller object. string null false admin null no no

CSS Class Overrides the default CSS class.

styleClass unvalidated

Disable Indicates if boolean Client Side validation should not Validation occur on the web tier during a form submit. Disable Server Side Validation Indicates if boolean validation should not occur on the business tier during a form submit. jrad:refName string

false

null

no

serverUnvalid ated

Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file. The number of the first step in a multistep navigation. The number of the last step in a multistep navigation. The Oracle Applications Extension version with which the file was created or updated.

null

null

no no

docName not applicable

from null templ ate file null

jrad:compone null ntRef

no

extends

File Version First Step

string unsignedInt

null 1

null null

no no

file-version minValue

Last Step

unsignedInt

-1

null

no

maxValue

OA Extension Version

jrad:version

null

null

no

version

Personaliz The region label ation Label used for 96

string

null

null

no

regionName

Region Styles

Name

Description

Type

Defau Personaliz Translat lt able able Value false admin no

XML Attribute

Personalization. Post Initial Indicates if rows boolean Values which are made dirty only by the defaulting of Initial Values are to be posted. Records Displayed Rendered The maximum number of rows to display. Indicates if the component is rendered. unsignedInt postDefault

-1

user

no

blockSize

boolean

true

user

no

rendered

Scope

The Base Packages jrad:scope which are allowed to reuse this component. Indicates if the user can view any attachment for the current object, regardless of category. string

null

no

scope

Show All

no

null

no

showAll

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 selfS ecured. Identifies the language contained within this component. optional

stand null ard

no

securityMode

xml:lang

null

null

no

xml:lang

pageButtonBar
97

OA Extension Component Reference

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 Description Type Defau Personaliz Translat lt able able Value true null no XML Attribute addChildren

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

Admin Indicates if an Personaliz Administrator can ation personalize this component. Attribute Set Controller Class The attribute set for the component. The fully-qualified class name for the controller object.

true

admin

no

adminCustomi zable

jrad:attributeS null etRef string string null null

null null admin

no no no

use comment controllerClas s styleClass docName not applicable

Comments Comments

CSS Class Overrides the default CSS class. Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file.

string jrad:refName string

null null

admin null

no no no

from null templ ate file null

jrad:compone null ntRef

no

extends

File Version 98

string

null

null

no

file-version

Region Styles

Name

Description

Type

Defau Personaliz Translat lt able able Value null null no

XML Attribute version

OA Extension Version

The Oracle Applications Extension version with which the file was created or updated.

jrad:version

Personaliz The region label ation Label used for Personalization.

string

null

null

no

regionName

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 component is rendered. boolean

false

null

no

postDefault

true

user

no

rendered

Scope

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. Identifies the language contained within this component. optional

null

no

scope

Security Mode

stand null ard

no

securityMode

xml:lang

null

null

no

xml:lang

pageLayout
99

OA Extension Component Reference

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. Corresponding web bean: OAPageLayoutBean

Properties
Name Description Type Defa Personali Translat ult zable able Value true admin no XML Attribute

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM State Required

boolean

adminCustomizab le

The fully-qualified string class name for the application module. Indicates if an error boolean will be displayed when navigating to the page and an Application Module is not found.

null

null

no

amDefName

false

null

no

amStateRequired

Applicatio The menu to render string n Menu with the page. Attribute Set Auto Footer

null

null null null

no no no

appMenu use autoFooter

The attribute set for jrad:attribute null the component. SetRef Indicates if boolean standard copyright and privacy named children are added automatically. string string true

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class.

null null

null admin

no no

comment controllerClass

string

null

admin null null

no no no

styleClass docName not applicable

Document The name of the Name component Document Formatted text for 100

jrad:refName null string from

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value templ ate file null null no

XML Attribute

ation use with Javadoc. Comment Extends A reference to jrad:compon another component entRef that creates a different instance of that component at runtime. The version of the file. string

extends

File Version Form

null true

null null

no no

file-version addForm

Indicates if all child boolean elements are embedded inside an HTML form element. The function that string secures the region. The name of the Global Menu. string

Function Name Global Menu Help Target Help Target Appl Short Name

null null null

null null admin

no no no

function globalMenu helpTarget

The target name for string the page online help. This application will string 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. Name jrad:version

null

admin

no

helpTargetAppSh ortName

ID

null null

null null

no no

id version

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Page

The menu name for string

null

null

no

pageMenu 101

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null null no

XML Attribute

Menu

the page. string regionName

Personaliz The region label ation used for Label 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.

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

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 self Secured. Indicates if Quick Links within the page are rendered automatically. The title of the region. boolean

stand null ard

no

securityMode

Show Quick Links Title Warn About Changes

false

null

no

quickLinksShown

string

null false

null null

no no

title warnAboutChang es

Warns the user if boolean there are pending changes that will be lost, and allows them to cancel the current action or discard the

102

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

changes and continue with the current action. Window Title xml:lang The title of the window. string null null admin null true no windowTitle xml:lang

Identifies the optional language contained within this component.

Element Children
Name contentFooter copyright Quantity Description

0 through 1 The content footer region of the page. 0 through 1 Node to use as a copyright statement.

corporateBranding 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 footnote 0 through 1 Flexible contents. 0 through 1 The footnote region. This region provides a location for pagelevel status that is ancillary to the user's task.

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 pageStatus 0 through 1 The locator region of the page. 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. 0 through 1 Node to use as a privacy statement. 0 through 1 The product branding region of the page. This section typically contains an image of the product logo. 0 through 1 The quick search region of the page. 0 through 1 The "return to" link at the bottom of the page. 0 through 1 The user information region.

privacy productBranding quickSearch returnNavigation userInfo

103

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 Additional Text Descripti on Type Default Value null true Personaliz Translata XML Attribute able ble admin admin yes no shortDesc adminCustomi zable

Additional string help text.

Admin Indicates boolean Personaliza if an tion Administr ator can personaliz e this compone nt. 104

Region Styles

Name Attribute Set

Descripti on

Type

Default Value

Personaliz Translata XML Attribute able ble null no use

The jrad:attributeS null attribute etRef set for the compone nt. Comment string s The display height in pixels. string null null

Comments Height

null admin

no no

comment height

ID

The Name unique name of this compone nt. Indicates boolean whether the popup should be a modal dialog or a nonmodal dialog.

null

null

no

id

Modal Enabled

false

admin

no

isModal

Parameters The string parameter s of the pop-up. Read Only Indicates boolean if the value can be changed. Indicates string the region where the pop-up occurs. Indicates the title for the pop-up string

null

admin

no

popupParamet ers

false

admin

no

readOnly

Region

null

admin

no

popupRegion

Title

null

admin

no

popupTitle

105

OA Extension Component Reference

Name Type

Descripti on Indicates the popup type.

Type string

Default Value EmbeddedP opup null

Personaliz Translata XML Attribute able ble admin no popupType

View Instance

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

null

no

viewName

Width

null

admin

no

width

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

106

Region Styles 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 lt alizable atable Value true admin no XML Attribute

Admin Person alizatio n

Indicates if an Administrator can personalize this component.

boolean

adminCustomiz able

Advanc Overrides the default text for string ed the button that navigates to the Button advanced search panel. Label Advanc Overrides the default text for ed the 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 Instanc application module. e string

null

null

true

advSearchPanel ButtonLabel

null

null

true

advancedSearc hInstrTexts

string

null

null

no

amDefName

string

null

null

no

amUsageName

107

OA Extension Component Reference

Attribut e Set

The attribute set for the component.

jrad:attrib null uteSetRef string null none

null null null

no no no

use comment mode

Comme Comments nts

Constru Indicates the level of automatic string ction panel and search construction. Mode 'autoCustomizationCriteria' is the most automatic level; 'resultsBasedSearch' is a semi-automatic level, and 'none' implies manual construction. The legal values are none, resultsBasedSearch, an d autoCustomizationCriteria. Controll The fully-qualified class name er for the controller object. Class CSS Class Data Type Overrides the default CSS class. string

null

admin

no

controllerClass

string

null

admin

no no

styleClass dataType

The type of data. Valid only string when used in table region. The legal values are VARCHAR2, DATE, DATETIM E, NUMBER, BIGDECIMAL, BOOLEAN, and CLOB.

VARC null HAR2

Extends A reference to another component that creates a different instance of that component at runtime. Help Target Help Target Appl Short Name Hide Person alize Hide Save Search The target name for the page online help.

jrad:comp null onentRef

null

no

extends

string

null null

null admin

no no

helpTarget helpTargetAppS hortName

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. Indicates if the Personalize button is hidden. Indicates if the Save Search button is hidden. boolean

false

admin

no

hidePersonalize

boolean

false

admin

no

hideSaveSearch

108

Region Styles

Include Indicates if the advanced boolean Advanc search panel is available to the ed user. Panel Include Indicates if the simple search Simple panel is available to the user. Panel Include Indicates if the Views panel is Views available to the user. Panel Initial Panel boolean

false

null

no

dispAdvanced

false

null

no

dispSimple

boolean

false

null

no

dispCustomized

The initial panel to render. The string legal values are simple, advanced, and customi zed. Indicates the initial sort string sequence for each search. The legal values are none, first, second, and third. Indicates if cell contents should boolean be wrapped. Valid only when used in table region. string

simple user

no

defaultPanel

Initial Sort Sequen ce No Wrap

none

null

no

initSortSeq

false

null

no

cellNoWrapFor mat regionName

Person The region label used for alizatio Personalization. n Label Post Initial Values Indicates if rows which are made dirty only by the defaulting of Initial Values are to be posted.

null

null

no

boolean

false

null

no

postDefault

Render Indicates if the component is ed rendered. Save Search Button Text Overrides the default text for the Save Search button.

boolean string

true null

user null

no true

rendered saveSearchButt onText

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 selfSecured. Show Indicates if the Views Panel Views controls will be displayed. Panel Control boolean

stand ard

null

no

securityMode

true

null

no

showCustomize PanelControls

109

OA Extension Component Reference

s Simple Button Label Overrides the default text for string the button that navigates to the simple search panel. string null null true simpleSearchPa nelButtonLabel simpleSearchIns trTexts

Simple Overrides the default text for Panel the Simple Search Panel Instructi instruction text. ons

null

null

true

Sort Indicates if the user can sort string Allowed this column. Valid only when used in table region. The legal values are yes, no, ascending, and desce nding. Sort By View Attribut e The alternate view attribute name for use when sorting. Valid only when used in table region. string

no

admin

no

sortState

null

user

no

sortByViewAttr

Standal Indicates if this region can be one rendered on its own. Store Indicates if the views are Views stored on the shared region. on Shared Region User Person alizatio n Indicates if a user can personalize this component. Valid only when used in table region.

boolean boolean

false false

null null

no no

standalone storeViewsOnS haredRegion

boolean

false

admin

no

userCustomizab le

View The name of the view object string Instanc instance. Valid only when used e in table region. Views Button Label Overrides the default text for string the button that navigates to the Views panel. string

null

null

no

viewName

null

null

true

viewConfPanelB uttonLabel customizeInstrT exts

Views Overrides the default text for Panel the Views panel instruction Instructi text. ons Views Panel Title Overrides the default text for the Views panel title.

null

null

true

string

null

null

true

customizePanel Title

110

Region Styles

Element Children
Name Quantity Description

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

queryCriteriaMap
Name Attribute Set Descriptio n Type Defaul Personalizabl Translatabl t Value e e null no XML Attribute use

The jrad:attributeSetRe null attribute set f for the component. null

Comment Comments. string s Results Item The ID of the item in the results table or hGrid. The ID of the item in the search panel.

null null

no no

comment resultsIte m

jrad:componentRe null f

Search Item

jrad:componentRe null f

null

no

criteriaIte m

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

rowLayout
111

OA Extension Component Reference

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 Description Type Defa Personali Translat ult zable able Valu e true null no XML Attribute

Add Indexed Children

Indicates if indexed children will be automatically added to this UI node tree.

boolean

addChildren

Admin Indicates if an Personali Administrator can zation personalize this component. AM The fully-qualified class Definition name for the application module. AM Instance Attribute Set Child View Attribute Child View Instance

boolean

true

admin

no

adminCustomi zable

string

null

null

no

amDefName

The instance name of an string application module. The attribute set for the component. The name of the child view attribute. Valid only when used in table region.

null

null null null

no no no

amUsageNam e use childViewAttr Name

jrad:attribute null SetRef string null

Renders an instance of string the object for each row in the View Instance. Valid only when used in table region. string string

null

null

no

childViewUsa geName

Comment Comments s Controller The fully-qualified class Class name for the controller 112

null null

null admin

no no

comment controllerClas s

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Valu e null null admin null no no no

XML Attribute

object. CSS Class Overrides the default CSS class. string jrad:refNam e string styleClass docName not applicable

Documen The name of the t Name component Documen Formatted text for use tation with Javadoc. Comment Extends

from null templ ate file null

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

no

extends

File Version

null null

no no

file-version hAlign

Horizontal Horizontal alignment. Alignment Acceptable values are "center", "left", "right", "start", and "end". ID The unique name of this component.

Name

null

null

no no

id initSortSeq

Initial Sort Indicates the initial sort string Sequence sequence for each search. The legal values are none, first, second, and third. No Wrap Indicates if cell contents boolean should be wrapped. Valid only when used in table region. jrad:version

none null

false

null

no

cellNoWrapFo rmat

OA The Oracle Applications Extension Extension version with Version which the file was created or updated.

null

null

no

version

Personali The region label used for string zation Personalization. Label Post Initial Indicates if rows which are made dirty only by boolean

null

null

no

regionName

false

null

no

postDefault

113

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Valu e

XML Attribute

Values Prompt

the defaulting of Initial Values are to be posted. The text label for the component. string boolean jrad:scope null true . admin user null true no no prompt rendered scope

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component.

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 selfSecur ed. 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. The alternate view attribute name for use when sorting. Valid only when used in table region. string

stand null ard

no

securityMode

Sort Allowed

no

admin

no

sortState

Sort By View Attribute

null

user

no

sortByViewAtt r

User Indicates if a user can Personali personalize this zation component. Valid only when used in table region. Vertical Vertical alignment. Alignment Acceptable values are "middle", "top", and "bottom". Width 114 Indicates the width in

boolean

false

admin

no

userCustomiz able

string

null

null

no

vAlign

string

null

null

no

width

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Valu e

XML Attribute

pixels or as a percentage (if % sign included). xml:lang Identifies the language contained within this component. optional null null no xml:lang

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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition AM Instance

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

115

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value null null null admin no no no no

XML Attribute

Attribute Set Available Header

The attribute set for jrad:attribute null the component. SetRef The header for the available (first) list. string string string null null null

use leadingHeader comment controllerClass

Comment Comments s Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class.

string

null

admin null

no no no

styleClass docName not applicable

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

jrad:refName null string

from null templ ate file null null

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

no

extends

File Version Help Target Help Target Appl Short Name

null null

null null

no no

file-version helpTarget

The target name for string the page online help. This application will string 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. The Oracle Name jrad:version

null

null

no

helpTargetAppSh ortName

ID OA 116

null null

null null

no no

id version

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

Extension Applications Version Extension version with which the file was created or updated. Ordering Allowed Indicates if the boolean contents of the selected (second) list can be ordered. string true null no reorderable

Personaliz The region label ation used for Label 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.

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

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 self Secured. The header for the selected (second) list. string

stand null ard

no

securityMode

Selected Header

null

null

no

trailingHeader

Standalon Indicates if this e region can be

boolean

false

null

no

standalone

117

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

rendered on its own. xml:lang Identifies the optional language contained within this component. null null no xml:lang

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.

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

Properties
Name Description Type Defa Personal Transla ult izable table Valu e true null no XML Attribute

Add Indexed Children

Indicates if indexed children will be automatically added to this UI node tree.

boolean

addChildren

118

Region Styles

Name

Description

Type

Defa Personal Transla ult izable table Valu e true admin no

XML Attribute

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

boolean

adminCustomiza ble

AM The fully-qualified class string Definition name for the application module. AM Instance Attribute Set Child View Attribute Child View Instance The instance name of an string application module. The attribute set for the component. jrad:attribut eSetRef

null

null

no

amDefName

null null null

null null null

no no no

amUsageName use childViewAttrNa me

The name of the child string view attribute. Valid only when used in table region. Renders an instance of the object for each row in the View Instance. Valid only when used in table region. string

null

null

no

childViewUsage Name

Comment Comments s Controller The fully-qualified class Class name for the controller object. CSS Class Overrides the default CSS class.

string string

null null

null admin

no no

comment controllerClass

string

null

admin null

no no no

styleClass docName not applicable

Documen The name of the t Name component Documen Formatted text for use tation with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file.

jrad:refNam null e string

from null templ ate file null

jrad:compon null entRef

no

extends

File Version

string

null

null

no

file-version

119

OA Extension Component Reference

Name

Description

Type

Defa Personal Transla ult izable table Valu e null null null null no no

XML Attribute

Help Target Help Target Appl Short Name

The target name for the page online help.

string

helpTarget helpTargetAppS hortName

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 applications referenceable. The unique name of this Name component. Indicates the initial sort string sequence for each search. The legal values are none, first, second, an d third. Indicates if cell contents should be wrapped. Valid only when used in table region. boolean

ID Initial Sort Sequenc e

null

null

no no

id initSortSeq

none null

No Wrap

false null

no

cellNoWrapFor mat

OA The Oracle Applications Extension Extension version with Version which the file was created or updated.

jrad:version null

null

no

version

Personali The region label used for string zation Personalization. Label Post Initial Values Prompt Indicates if rows which boolean are made dirty only by the defaulting of Initial Values are to be posted. The text label for the component. string boolean jrad:scope

null

null

no

regionName

false null

no

postDefault

null true .

admin user null

true no no

prompt rendered scope

Rendered Indicates if the component is rendered. Scope The Base Packages which are allowed to reuse this component. Defines the security

Security 120

string

stand null

no

securityMode

Region Styles

Name

Description

Type

Defa Personal Transla ult izable table Valu e ard

XML Attribute

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 selfSecu red. Indicates if the user can sort this column. Valid only when used in table region. The legal values are yes, no, ascending, an d descending. The alternate view attribute name for use when sorting. Valid only when used in table region. string

Sort Allowed

no

admin

no

sortState

Sort By View Attribute

string

null

user

no

sortByViewAttr

Standalo Indicates if this region ne can be rendered on its own. User Indicates if a user can Personali personalize this zation component. Valid only when used in table region. xml:lang Identifies the language contained within this component.

boolean

false null

no

standalone

boolean

false admin

no

userCustomizabl e

optional

null

null

no

xml:lang

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 121

OA Extension Component Reference 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 Description Type Defau Personaliz Translat lt able able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

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

true

admin

no

adminCustomiz able

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attributeS null the component. etRef null null

null null null

no no no

use childViewAttrNa me childViewUsag eName

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comments Comments Controller Class The fully-qualified class name for the controller object. string string

null null

null admin

no no

comment controllerClass

122

Region Styles

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

string jrad:refName string

null null

admin null

no no no

styleClass docName not applicable

from null templ ate file null

A reference to jrad:compone null another component ntRef that creates a different instance of that component at runtime. The version of the file. The unique name of this component. The initially selected subtab. The Oracle Applications Extension version with which the file was created or updated. string Name null null

no

extends

File Version ID Initial Subtab OA Extension Version

null null null null

no no no no

file-version id selectedIndex version

nonNegativeI 0 nteger jrad:version null

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. Rendered Indicates if the component is rendered. The Base Packages which are allowed to reuse this component.

string

null

null

no

regionName

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

Scope

jrad:scope

null

no

scope

Security Mode

Defines the string security mode used

stand null ard

no

securityMode

123

OA Extension Component Reference

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. optional null null no xml:lang

Element Children
Name Quantity Description

subTabs 0 through 1 Rendered twice per bean render, once before indexed children and once after.

subTabBar
Name Descriptio n Additional help text. string Type Defau Personaliza Translata lt ble ble Value null true admin admin yes no XML Attribute

Additional Text

shortDesc adminCustomiz able

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments CSS Class Comments string Overrides string the default null null

null

no

use

null admin

no no

comment styleClass

124

Region Styles

CSS class. Document Name Extends The name jrad:refName of the component null null no docName

A jrad:component null reference Ref to another 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

extends

Rendered

user

no

rendered

Scope

null

no

scope

xml:lang

null

null

no

xml:lang

switcher
125

OA Extension Component Reference

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 Type boolean Default Personali Transla Value zable table true admin no XML Attribute adminCusto mizable

Admin Indicates if an Personali Administrator can zation personalize this component. AM The fully-qualified class Definition name for the application module. AM Instance Attribute Set

string

null

null

no

amDefName

The instance name of an string application module. The attribute set for the component.

null

null null null admin

no no no no

amUsageNa me use comment controllerCla ss styleClass dataType

jrad:attribute null SetRef string string null null

Comment Comments s Controller The fully-qualified class Class name for the controller object. CSS Class Data Type Overrides the default CSS class. The type of data. Valid only when used in table region. The legal values are VARCHAR2, DATE, DATETIME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB.

string string

null

admin

no no

VARCH null AR2

Documen The name of the t Name component 126

jrad:refNam null e

null

no

docName

Region Styles

Name

Description

Type string

Default Personali Transla Value zable table from null templat e file null admin no

XML Attribute not applicable exportByVie wAttr

Documen Formatted text for use tation with Javadoc. Comment Export View Attribute The alternate view attribute for use when exporting. Valid only when used in table region.

string

no

Extends

A reference to another jrad:compon null component that creates a entRef different instance of that component at runtime. The version of the file. The unique name of this component. string Name null null none

null

no

extends

File Version ID

null null null

no no no

file-version id initSortSeq

Initial Sort Indicates the initial sort string Sequenc sequence for each e search. The legal values are none, first, second, and third. No Wrap Indicates if cell contents boolean should be wrapped. Valid only when used in table region. jrad:version

false

null

no

cellNoWrap Format

OA The Oracle Applications Extension Extension version with Version which the file was created or updated.

null

null

no

version

Personali The region label used for string zation Personalization. Label Post Initial Values Prompt Indicates if rows which are made dirty only by the defaulting of Initial Values are to be posted. The text label for the component. boolean

null

null

no

regionName

false

null

no

postDefault

string boolean jrad:scope

null true .

admin user null

true no no

prompt rendered scope 127

Rendered Indicates if the component is rendered. Scope The Base Packages

OA Extension Component Reference

Name

Description which are allowed to reuse this component.

Type

Default Personali Transla Value zable table

XML Attribute

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 selfSecur ed. 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. The alternate view attribute name for use when sorting. Valid only when used in table region. string

standar null d

no

securityMod e

Sort Allowed

no

admin

no

sortState

Sort By View Attribute

null

user

no

sortByViewA ttr

User Indicates if a user can Personali personalize this zation component. Valid only when used in table region. View Attribute View Instance The name of the view attribute. The name of the view object instance. Valid only when used in table region. Identifies the language contained within this component.

boolean

false

admin

no

userCustomi zable

string string

null null

null null

no no

viewAttr viewName

xml:lang

optional

null

null

no

xml:lang

Element Children
Name case 128 Quantity 1 or more Description 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 Defa Personali Translat XML Attribute 129

OA Extension Component Reference

ult Value Additional Additional help Text text. Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition string boolean null true

zable admin admin

able yes no shortDesc adminCustomizab le

The fully-qualified string class name for the application module. The instance name of an application module. string

null

null

no

amDefName

AM Instance

null

null

no

amUsageName

Attribute Set

The attribute set jrad:attribute for the component. SetRef string

null null

null null

no no

use childViewAttrNam e comment controllerClass

Child View The name of the Attribute child view attribute. Comment s Controller Class CSS Class Detail View Attribute Comments

string

null null

null admin

no no

The fully-qualified string class name for the controller object. Overrides the string default CSS class. The view attribute that determines if that particular row is to be stamped with the detail child. 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. string

null null

admin null

no no

styleClass detailViewAttr

Disable Client Side Validation Disable Server Side Validation

boolean

false

null

no

unvalidated

boolean

false

null

no

serverUnvalidated

130

Region Styles

Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Enable Column Reorder Enable Column Resize Enable Detach

jrad:refName null string

null

no no

docName not applicable

from null templ ate file true admin

Enable columns to boolean be reordered by end users Enable columns to boolean be resized by end users. Enable the table to boolean be detached and maximized in the browser. boolean

no

colReorderEnable d colResizeEnabled

true

admin

no

true

admin

no

detachEnabled

Enable Enable horizontal Horizontal scroll bars in the Scroll table. Extends

true

admin

no

horizontalScrollEn abled extends

A reference to jrad:compone null another ntRef component that creates a different instance of that component at runtime. The version of the string file. The target name string for the page online help. This application string 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 Name of this component. string null null

null

no

File Version Help Target Help Target Appl Short Name

null null

no no

file-version helpTarget

null

null

no

helpTargetAppSh ortName

ID

null null

null admin

no no

id messageAppShor tName 131

Message The application Appl Short short name that

OA Extension Component Reference

Name Message Name

owns the message. The name of the message. string jrad:version null null admin null no no messageName version

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization.

string

null

null

no

regionName

Post Initial Indicates if rows boolean Values which are made dirty only by the defaulting of Initial Values are to be posted. Record History Enabled Indicates if Record boolean History feature is enabled.

false

null

no

postDefault

false

admin

no

recordHistoryEna bled blockSize

Records The maximum unsignedInt Displayed number of rows to display. Rendered Indicates if the component is rendered. Row Header Col Row Header View Attribute Scope Indicates if Scope attribute is to be added to Table. boolean

10

user

no

true

user

no

rendered

unsignedInt

null

admin

no

rowheadercol

The view attribute string for the row header.

null

null

no

rowHeaderViewAt tr

The Base Packages which are allowed to reuse this component.

jrad:scope

null

no

scope

Security Mode

Defines the string security mode used to secure the region. If set to selfSecured it is

stand null ard

no

securityMode

132

Region Styles

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. boolean false null no standalone

string boolean

null false

admin admin

no no

text userCustomizable

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

The name of the string View Link Instance establishing master-detail relationship between outer and inner repeating containers. Indicates the width string in pixels or as a percentage (if % sign included). Identifies the language contained within this component. optional

null

null

no

viewLinkName

Width

null

null

no

width

xml:lang

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.

133

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 Description Type Defa Personali Translat ult zable able Value true null no XML Attribute

Add Indexed Children

Indicates if indexed boolean children will be automatically added to this UI node tree. boolean

addChildren

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

true

admin

no

adminCustomizab le

The fully-qualified string class name for the application module. The instance name string of an application module.

null

null

no

amDefName

null

null

no

amUsageName

The attribute set for jrad:attribute null the component. SetRef null null

null null null

no no no

use childViewAttrNam e childViewUsageN ame

Child View The name of the string Attribute child view attribute. Child View Renders an string Instance instance of the object for each row in the View Instance. Comment Comments s 134 string

null

null

no

comment

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value null admin no

XML Attribute

Controller The fully-qualified Class class name for the controller object. CSS Class Overrides the default CSS class.

string

controllerClass

string

null

admin null

no no no

styleClass docName not applicable

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

jrad:refName null string

from null templ ate file null null

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

no

extends

File Version Help Target Help Target Appl Short Name

null null

null null

no no

file-version helpTarget

The target name for string the page online help. This application will string 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. string

null

null

no

helpTargetAppSh ortName

Horizontal Horizontal Alignment alignment. The acceptable values are "center", "left", "right", "start", and "end". ID The unique name of this component.

cente null r

no

hAlign

Name jrad:version

null null

null null

no no

id version

OA The Oracle Extension Applications

135

OA Extension Component Reference

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

Version

Extension version with which the file was created or updated. string null null no regionName

Personaliz The region label ation used for Label 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.

boolean

false

null

no

postDefault

boolean

true

user

no

rendered

jrad:scope

null

no

scope

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 self Secured. boolean

stand null ard

no

securityMode

Standalon Indicates if this e region can be rendered on its own. View Link Instance The name of the View Link Instance establishing master-detail relationship between outer and

false

null

no

standalone

string

null

null

no

viewLinkName

136

Region Styles

Name

Description

Type

Defa Personali Translat ult zable able Value

XML Attribute

inner repeating containers. Width Indicates the width in pixels or as a percentage (if % sign included). string null null no width

xml:lang

Identifies the optional language contained within this component.

null

null

no

xml:lang

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 Type Defau Personaliz Translat lt able able Value true admin no XML Attribute adminCustomi zable

Admin Indicates if an Personaliz Administrator can ation personalize this component. Allow Indicates if each Interaction train stop should be rendered as a link. Attribute Set The attribute set for the component.

boolean

boolean

false

null

no

formSubmitte d use comment

jrad:attributeS null etRef string null

null null

no no

Comments Comments

137

OA Extension Component Reference

Name

Description

Type

Defau Personaliz Translat lt able able Value null admin no

XML Attribute controllerClas s styleClass unvalidated

Controller Class

The fully-qualified class name for the controller object.

string

CSS Class Overrides the default CSS class.

string

null false

admin null

no no

Disable Indicates if boolean Client Side validation should not Validation occur on the web tier during a form submit. Document The name of the Name component Document Formatted text for ation use with Javadoc. Comment Extends A reference to another component that creates a different instance of that component at runtime. The version of the file. jrad:refName string

null

null

no no

docName not applicable

from null templ ate file null

jrad:compone null ntRef

no

extends

File Version ID OA Extension Version

string

null null null

null null null

no no no

file-version id version

The unique name of Name this component. The Oracle Applications Extension version with which the file was created or updated. jrad:version

Personaliz The region label ation Label used for Personalization.

string

null

null

no

regionName

Post Initial Indicates if rows boolean Values which are made dirty only by the defaulting of Initial Values are to be posted. Rendered 138 Indicates if the boolean

false

null

no

postDefault

true

user

no

rendered

Region Styles

Name

Description

Type

Defau Personaliz Translat lt able able Value

XML Attribute

component is rendered. Scope 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 images boolean are rendered before and after the train to indicate that this train is part of a subprocess. Identifies the language contained within this component. optional . null no scope

Security Mode

stand null ard

no

securityMode

Sub Train

false

null

no

subTrain

xml:lang

null

null

no

xml:lang

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

139

OA Extension Component Reference

Properties
Name Description Type Defa Personali Translat ult zable able Value true admin no XML Attribute

Admin Indicates if an Personaliz Administrator can ation personalize this component. AM Definition

boolean

adminCustomizab le

The fully-qualified string class name for the application module. The instance name of an application module. string

null

null

no

amDefName

AM Instance

null

null

no

amUsageName

Attribute Set Comment s Controller Class CSS Class Disable Client Side Validation

The attribute set jrad:attribute for the component. SetRef Comments string

null null null

null null admin

no no no

use comment controllerClass

The fully-qualified string class name for the controller object. Overrides the string default CSS class. Indicates if validation should not occur on the web tier during a form submit. boolean

null null

admin null

no no

styleClass unvalidated

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

jrad:refName null string

null

no no

docName not applicable

from null templ ate file null

A reference to jrad:compone null another ntRef component that creates a different instance of that

no

extends

140

Region Styles

component at runtime. File Version Help Target Help Target Appl Short Name The version of the string file. The target name string for the page online help. This application string 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. Maps to the Item Name property of the Default Tree region-item. Name null null null null no no file-version helpTarget

null

null

no

helpTargetAppSh ortName

ID

null

null

no

id

OA The Oracle Extension Applications Version Extension version with which the file was created or updated. Personaliz The region label ation used for Label Personalization.

jrad:version

null

null

no

version

string

null

null

no

regionName

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 component is rendered. Scope The Base Packages which are allowed to reuse this component. Defines the security mode boolean

false

null

no

postDefault

true

user

no

rendered

jrad:scope

null

no

scope

Security Mode

string

stand null ard

no

securityMode

141

OA Extension Component Reference

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 xml:lang The text label for the component. Identifies the language contained within this component. boolean false null no standalone

string optional

null null

admin null

true no

text xml:lang

Element Children
Name members 1 Quantity Description Grouping used for specifying tree's members

nodeDef
Name Description Type Defau Person Transl XML lt alizable atable Attribute Value none null no primaryCli entAction

Action Type

The action type to fire for the component. It should be either "fireAction" or "none."

string

Admin Indicates if an Person Administrator can alization personalize this component. Attribut e Set Child Object Type 142 The attribute set for the component. Object Type of child nodes, used when displaying record set

boolean

true

admin

no

adminCus tomizable

jrad:attributeSetRef string

null null

null null

no true

use childType Text

Region Styles

navigation controls. Comme Comments nts CSS Class Data Type Overrides the default CSS class. string string null null null admin no no no comment styleClass dataType

The type of data. The string legal values are VARCHAR2, DATE, DAT ETIME, BIGDECIMAL, NUMBER, BOOLEAN, an d CLOB. string

VARC null HAR2

Destinat The function to invoke. ion Functio n Destinat The Destination URI. ion URI Disable Client Side Validati on Disable Server Side Validati on Docum ent Name Event 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. The name of the component Name of the event.

null

admin

no

invokeFun c

anyURI boolean

null null

admin null

no no

destinatio n unvalidate d

boolean

false

null

no

serverUnv alidated

jrad:refName

null

null

no

docName

string

null null

null null

no no

event extends

Extends A reference to another jrad:componentRef component that creates a different instance of that component at runtime. Icon URI the URI for the icon file. anyURI

null null

admin null

no no

icon parameter s childBlock Size

Parame A list of parameter names name-value pair ters and values to be submitted by the action. Record Set Size The maximum number of records that can be displayed under each node.

ui:nonNegativeInteg null erExpressionType

null

no

143

OA Extension Component Reference

Render Indicates if the ed component is rendered. Scope The Base Packages which are allowed to reuse this component. Indicates if the action will cause a form submit The name of the target frame for the link. The name of the view attribute. The name of the view object instance.

boolean jrad:scope

null .

user null

no no

rendered scope

Submit Target Frame View Attribut e View Instanc e Warn About Change s

boolean string string

null null null

null null null

no no no

formSubm itted targetFra me viewAttr

string

null

null

no

viewName

Warns the user if there boolean 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. Identifies the language contained within this component. optional

true

null

no

warnAbou tChanges

xml:lan g

null

null

no

xml:lang

childNode
Name Description Type Defa ult Valu e null true Personaliz Translata able ble XML Attribute

Additional Text

Additional help text.

string

admin admin

yes no

shortDesc adminCustomizabl e

Admin Indicates if boolean Personaliza an tion Administrator can personalize this component. AM Definition The fullyqualified class name string

null

null

no

amDefName

144

Region Styles

for the application module. AM Instance The instance string name of an application module. Optionally jrad:localRef set only on the leaf level &lt;childNode &gt; element to recursively point to one of the ancestor nodes. The attribute jrad:attributeS set for the etRef component. Comments string Overrides the string default CSS class. The name of jrad:refName the component A reference to another component that creates a different instance of that component at runtime. null null no amUsageName

Ancestor Node

null

null

no

ancestorNode

Attribute Set Comments CSS Class

null

null

no

use

null null

null admin

no no

comment styleClass

Document Name Extends

null

null

no

docName

jrad:componen null tRef

null

no

extends

Personaliza The region string tion Label label used for Personalizati on. Rendered Indicates if boolean the component is rendered. The Base Packages jrad:scope

null

null

no

regionName

null

user

no

rendered

Scope

null

no

scope

145

OA Extension Component Reference

which are allowed to reuse this component. View Link Accessor The name of string the View Link 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 viewLinkAccessor Name

View Link Instance

null

null

no

viewLink

xml:lang

null

null

no

xml:lang

Element Children
Name members Quantity 0 through 1 Description Grouping used for specifying tree's members.

146

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 on Type Default Value true Personaliz Translata able ble admin no XML Attribute adminCustomizabl e

Admin Indicates boolean Personaliza if an tion Administr ator can personali ze this compone nt. Attribute Set

The jrad:attributeS null attribute etRef set for the compone nt. Indicates boolean if automatic save is enabled. false

null

no

use

Automatic Save

null

no

autoCommitEnable d

Comments Comment string s CSS Class Overrides string the default

null null

null admin

no no

comment styleClass

147

OA Extension Component Reference

CSS class. Document Name The name jrad:refName of the compone nt null null no docName

Disable Indicates boolean Client Side if Validation validation should not occur on the web tier during a form submit. Disable Indicates boolean Server Side if Validation validation should not occur on the business tier during a form submit. Enable Document Catalog Indicates boolean if the Documen t Catalog is enabled for the compone nt. The string alternate view attribute for use when exporting.

true

null

no

unvalidated

true

null

no

serverUnvalidated

true

admin

no

enableDocumentC atalog

Export View Attribute

null

admin

no

exportByViewAttr

Extends

A jrad:componen null reference tRef to another compone nt that

null

no

extends

148

Item Styles

creates a different instance of that compone nt at runtime. Inline Indicates boolean Attachment whether Enabled inline attachme nt capability is enabled or not. No Wrap Indicates boolean if cell contents should be wrapped. The text string label for the compone nt. Indicates boolean if the search region is rendered. Indicates boolean if the compone nt is rendered. The Base jrad:scope Packages which are allowed to reuse this compone nt. boolean (Default) admin no inlineAttachmentE nabled

false

null

no

cellNoWrapFormat

Prompt

Attachme admin nts

true

prompt

Render Search Region

true

null

no

searchRegionRen dered

Rendered

true

user

no

rendered

Scope

null

no

scope

User Indicates Personaliza if a user tion can personali

false

admin

no

userCustomizable

149

OA Extension Component Reference

ze this compone nt. View Instance The name string of the view object instance. null null no viewName

Virus Scan Indicates boolean Enabled if Virus Scan is enabled on file attachme nts. xml:lang Identifies optional the language contained within this compone nt.

false

admin

no

virusScanEnabled

null

null

no

xml:lang

Element Children
Name entityMappings 1 Quantity Description Defines the entity and item relationships.

entityMap
Name Descriptio n Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use

Attribute Set

The jrad:attributeSetR null attribute set ef for the component. null true

Comment Comments. string s Delete Allowed Indicates if boolean the user can delete attachments from the

null null

no no

comment deleteAllowe d

150

Item Styles

current object. Entity The name string of the attachment entity which defines the primary key relationship s. Indicates if boolean new attachments 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. null null no entityId

Insert Allowed

true

null

no

insertAllowed

Show All

false

null

no

showAll

Update Allowed

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 The Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use 151

Attribute

jrad:attributeSetR null

OA Extension Component Reference

Set

attribute ef set for the component . The string attachment category name. null null no categoryNam e

Category

Comment Comments. string s Secured Indicates if boolean the object is secured by grants model.

null false

null admin

no no

comment secured

primaryKey
Name Descriptio n Type Defaul Personalizabl t Value e null Translatabl e no XML Attribut e use

Attribute Set

The jrad:attributeSetRe null attribute set f for the component. Comments. string The name of the view attribute. string null null

Comment s View Attribute

null null

no no

comment viewAttr

attachmentLink
Description
An attachmentLink item style is used to display single-row attachments.

152

Item Styles 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 Type Defaul Persona Transl t lizable atable Value true admin no XML Attribute

Admin Indicates if an Personal Administrator can ization personalize this component. Attribute The attribute set for the Set component. Automati Indicates if automatic save c Save is enabled. Comme nts CSS Class Comments Overrides the default CSS class.

boolean

adminCustomiz able

jrad:attribut null eSetRef boolean string string jrad:refNa me boolean false null null null true

null null null admin null null

no no no no no no

use autoCommitEn abled comment styleClass docName unvalidated

Docume The name of the nt Name component Disable Client Side Validatio n Disable Server Side Validatio n 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.

boolean

true

null

no

serverUnvalidat ed

Enable Indicates if the Document Docume Catalog is enabled for the nt component. Catalog Extends A reference to another component that creates a different instance of that component at runtime. Inline Indicates whether inline

boolean

true

admin

no

enableDocume ntCatalog

jrad:compo null nentRef

null

no

extends

boolean

(Defaul admin

no

inlineAttachme 153

OA Extension Component Reference

Attachm attachment capability is ent enabled or not. Enabled Link Text The Text for the attachment link. string jrad:refNa me string boolean

t)

ntEnabled

View null

null admin

true no

text longTipRegion

Long Tip The fully-qualified Region reference to the long tip region. Prompt Render Search Region The Prompt for the attachment link. Indicates if the search region is rendered.

Attach user ments true null

true no

prompt searchRegionR endered rendered scope

Rendere Indicates if the component d is rendered. Scope The Base Packages which are allowed to reuse this component.

boolean jrad:scope

true .

user null

no no

Tip Messag e Appl Short Name Tip Messag e Name

The application short name string that owns the tip message.

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. View The name of the view Instance object instance. Virus Indicates if Virus Scan is Scan enabled on file Enabled attachments. xml:lang Identifies the language contained within this component. string boolean

none

admin

no

null false

null admin

no no

viewName virusScanEnabl ed xml:lang

optional

null

null

no

Element Children
Name entityMappings 154 1 Quantity Description Defines the entity and item relationships.

Item Styles

entityMap
Name Descriptio n Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use

Attribute Set

The jrad:attributeSetR null attribute set ef for the component. null true

Comment Comments. string s Delete Allowed Indicates if boolean the user can delete attachments from the current object. The name string of the attachment entity which defines the primary key relationship s. Indicates if boolean new attachments 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

null null

no no

comment deleteAllowe d

Entity

null

null

no

entityId

Insert Allowed

true

null

no

insertAllowed

Show All

false

null

no

showAll

Update Allowed

true

null

no

updateAllowe d

155

OA Extension Component Reference

content.

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 Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use

Attribute Set

The jrad:attributeSetR null attribute ef set for the component . The string attachment category name. null

Category

null

no

categoryNam e

Comment Comments. string s Secured Indicates if boolean the object is secured by grants model.

null false

null admin

no no

comment secured

primaryKey
Name Descriptio n Type Defaul Personalizabl t Value e null Translatabl e no XML Attribut e use

Attribute Set

The jrad:attributeSetRe null attribute set f for the component. Comments. string The name string null null

Comment s View 156

null null

no no

comment viewAttr

Item Styles

Attribute

of the view attribute.

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 Descriptio n Type Defau Personaliz Translata lt able ble Value true true no XML Attribute

Admin Indicates if boolean Personaliza an tion Administrat or can personalize this component. Attribute Set

adminCustomizable

The jrad:attributeS null attribute set etRef for the component. Indicates if automatic save is enabled. boolean false

null

no

use

Automatic Save

null

no

autoCommitEnable d

Comments Comments

string

null false

null admin

no no

comment copyAttachmentEna bled

Copy Indicates if boolean Attachment Copying is Enabled enabled on file attachments

157

OA Extension Component Reference

. CSS Class Overrides the default CSS class. string null admin no styleClass

Disable Indicates if boolean Client Side validation Validation should not occur on the web tier during a form submit. Disable Indicates if boolean Server Side validation Validation should not occur on the business tier during a form submit. Enable Document Catalog Indicates if boolean the Document Catalog is enabled for the component. Indicates if boolean attachments will be stored in Oracle Files.

true

null

no

unvalidated

true

null

no

serverUnvalidated

true

admin

no

enableDocumentCa talog

Enable Oracle Files

true

null

no

oracleFilesEnabled

Extends

A reference jrad:componen null to another tRef component that creates a different instance of that component at runtime. null

null

no

extends

Help Target This string Appl Short application Name will be used to construct 158

admin

no

helpTargetAppShort Name

Item Styles

URI of the "help" icon in the global menu of the page.This makes the help pages from the other applications referenceab le. Icon URI The URI for string the icon file. null (Defa ult) admin admin no no icon inlineAttachmentEn abled

Inline Indicates boolean Attachment whether Enabled inline attachment capability is enabled or not. Personaliza The region string tion Label label used for Personaliza tion. Post Initial Values Indicates if boolean rows which are made dirty only by the defaulting of Initial Values are to be posted. Indicates if Record History feature is enabled for this option. boolean

null

null

no

regionName

false

admin

no

postDefault

Record History Enabled

false

admin

no

recordHistoryEnabl ed

Rendered

Indicates if boolean the component is rendered. Indicates if boolean

true

user

no

rendered

Render

true

null

no

searchRegionRend 159

OA Extension Component Reference

Search Region Text

the search region is rendered. The text string label for the component. The name of the view object instance. string null admin yes

ered

text

View Instance

null

null

no

viewName

Virus Scan Indicates if boolean Enabled Virus Scan is enabled on file attachments .

false

admin

no

virusScanEnabled

Element Children
Name entityMappings 1 Quantity Description Defines the entity and item relationships.

entityMap
Name Descriptio n string Type Defau Personaliza lt ble Value null null Translata ble no XML Attribute

Approval Function Function Name for Name the approval process.

approvalFunctionN ame

Approval View string View Attribute to Attribute determine if approval process is required.

null

null

no

approvalViewAttr

Attribute The jrad:attributeSet null Set attribute Ref set for the component . Commen Comments string 160 null

null

no

use

null

no

comment

Item Styles

ts Delete Allowed

. Indicates if boolean the user can delete attachment s from the current object. The name string of the attachment entity which defines the primary key relationshi ps. Indicates if boolean new attachment s can be created for this entity. true null no deleteAllowed

Entity

null

null

no

entityId

Insert Allowed

true

null

no

insertAllowed

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

false

null

no

showAll

true

null

no

updateAllowed

Element Children
Name categoryMappings Quantity 0 through 1 Description Defines the entity and category relationships. 161

OA Extension Component Reference

primaryKeys

0 through 1

Defines the primary keys.

categoryMap
Name Descriptio n Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use

Attribute Set

The jrad:attributeSetR null attribute ef set for the component . The string attachment category name. null

Category

null

no

categoryNam e

Comment Comments. string s Secured Indicates if boolean the object is secured by grants model.

null false

null admin

no no

comment secured

primaryKey
Name Descriptio n Type Defaul Personalizabl t Value e null Translatabl e no XML Attribut e use

Attribute Set

The jrad:attributeSetRe null attribute set f for the component. Comments. string The name of the view attribute. string null null

Comment s View Attribute

null null

no no

comment viewAttr

162

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 Access Key Action Type Description The character used for quick keyboard navigation or activation. The action type to fire for the component. It should be either "fireAction", "firePartialAction" or "none." Type string Defaul Personal Transla t Value izable table null admin no XML Attribute accessKey

string

none

null

no

primaryClie ntAction

Additiona Additional help text. l Text Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

string boolean

null true

admin admin

yes no

shortDesc adminCusto mizable use comment styleClass dataType

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

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

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

163

OA Extension Component Reference

Name

Description

Type

Defaul Personal Transla t Value izable table null null no no

XML Attribute destination serverUnval idated

Destinati The destination URI. on URI

uriReferenc null e false

Disable Indicates if validation should boolean 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 View Attribute Extends The alternate view attribute for use when exporting. 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. The unique name of this component. boolean

null

null null admin

no no no

disabled docName exportByVi ewAttr extends

jrad:refNam null e string null

jrad:compo null nentRef

null

no

Horizont al Alignmen t ID Popup Enabled

string

start

null

no

hAlign

Name

null false null

null admin admin

no no no no

id popupEnabl ed popupId popupRend erEvent prompt rendered scope

Indicates whether the pop-up boolean is enabled.

Popup ID The unique name of the pop- string up. Popup Render Event Prompt Indicates on what action type string the event is to be rendered for the pop-up. The text label for the component. string boolean jrad:scope

onClick admin

null true .

admin user null

true no no

Rendere Indicates if the component is d rendered. Scope The Base Packages which are allowed to reuse this component.

Target Frame Text 164

The name of the target frame string for the link. The text label for the string

null null

admin admin

yes yes

targetFram e text

Item Styles

Name

Description component.

Type

Defaul Personal Transla t Value izable table null null true null null null no no no

XML Attribute viewAttr viewName warnAbout Changes

View Attribute

The name of the view attribute.

string string boolean

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.

optional

null

null

no

xml:lang

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.

165

OA Extension Component Reference 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 Description Type Defa Personaliz Translat ult able able Valu e null true admin admin yes no XML Attribute

Additional Text

Additional help text.

string boolean

shortDesc adminCustom izable

Admin Indicates if an Personaliz Administrator can ation personalize this component. Attribute Set The attribute set for the component.

jrad:attribute SetRef string string boolean

null null null

null null admin

no no no no

use comment styleClass unvalidated

Comments Comments 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. Disable Server Side Validation Disabled Export All Rows Indicates if validation should not occur on the business tier during a form submit. Indicates if the element is disabled.

false null

boolean

false null

no

serverUnvalid ated

boolean

false null false null

no no

disabled exportAllRow s

Indicates if all rows will boolean be exported, ignoring the maximum fetch size.

Extends

A reference to another jrad:compone null component that ntRef

null

no

extends

166

Item Styles

Name

Description

Type

Defa Personaliz Translat ult able able Valu e

XML Attribute

creates a different instance of that component at runtime. Horizontal Horizontal alignment. string Alignment The legal values are center, left, right, start, and end. No Wrap 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. boolean start null no hAlign

false null

no

cellNoWrapF ormat rendered

Rendered

boolean

true

user

no

Text View Instance

string string

null null

admin null

yes no

text viewName

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

167

OA Extension Component Reference

Name Additional Text

Description Additional help text.

Type string

Default Personaliz Translat Value able able null true admin admin yes no

XML Attribute shortDesc adminCustomiza ble

Admin Indicates if an boolean Personaliz Administrator ation can personalize this component. Appl Short The application string Name short name that owns the Flexfield. Attribute Set The attribute set for the component.

null

null

no

flexFieldAppShor tName

jrad:attributeS null etRef string string null null

null

no

use

Comments Comments CSS Class Overrides the default CSS class. Display Context Field Document Name Extends Indicates if the context field is displayed. The name of the component

null admin

no no

comment styleClass

boolean

true

null

no

displayContextFi eld docName extends

jrad:refName

null

null null

no no

A reference to jrad:compone null another ntRef component that creates a different instance of that component at runtime. The name of the Flexfield. string null null

Name Prompt

null admin

no true

flexName prompt

The text label string for the flexfield, used in the personalization window. boolean

Read Only Indicates if the value can be changed. Rendered Indicates if the component is

false

admin

no

readOnly

boolean

true

user

no

rendered

168

Item Styles

Name

Description rendered.

Type

Default Personaliz Translat Value able able . null no

XML Attribute

Scope

The Base Packages which are allowed to reuse this component. The limited list of flexfield segments.

jrad:scope

scope

Segment List Type

string

null

admin

no

segmentList

The type of the string Flexfield. The legal values are key, and descri ptive.

descript null ive

no

flexStyle

User Indicates if a boolean Personaliz user can ation personalize this component. View Instance xml:lang The name of the view object instance. Identifies the language contained within this component. string

false

admin

no

userCustomizabl e

null

null

no

viewName

optional

null

null

no

xml:lang

Element Children
Name flexMaps 1 Quantity Description Defines the external references for a flexfield.

flexMap
Name Descriptio n The attribute set for the Type Defaul Personalizabl Translatabl t e e Value null no XML Attribute use

Attribute Set

jrad:attributeSetR null ef

169

OA Extension Component Reference

component . Comment Comments. string s Name Referenc e Value Specify the string name. Value to be string set on the named parameter. Indicates boolean whether the value refers to the context field. null null null null null null no no no comment name referenceValu e

Refers Context

false

null

no

refersContext

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 Type Defau Personaliz Translat lt able able Value true admin no XML Attribute adminCustomi zable

Admin Indicates if an Personaliz Administrator can ation personalize this component. Attribute 170 The attribute set for

boolean

jrad:attributeS null

null

no

use

Item Styles

Name

Description

Type

Defau Personaliz Translat lt able able Value null null null null null no no no

XML Attribute

Set

the component.

etRef string jrad:refName comment docName extends

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.

jrad:compone null ntRef

ID Rendered

The unique name of Name this component. Indicates if the component is rendered. boolean

null true

null user

no no

id rendered

Scope

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. Identifies the language contained within this component. optional

null

no

scope

Security Mode

stand null ard

no

securityMode

xml:lang

null

null

no

xml:lang

formattedText
Description
171

OA Extension Component Reference 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

Properties
Name Description Type Defaul Personal Transla t Value izable table XML Attribute

172

Item Styles

Name

Description

Type string boolean

Defaul Personal Transla t Value izable table null true admin admin yes no

XML Attribute shortDesc adminCusto mizable use comment styleClass dataType

Additiona Additional help text. l Text Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

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 nt Name Export View Attribute Extends The alternate view attribute for use when exporting. A reference to another component that creates a different instance of that component at runtime. The unique name of this component.

jrad:refNam null e string null

null admin

no no

docName exportByVi ewAttr extends

jrad:compo null nentRef

null

no

ID Initial Sort Sequenc e Label

Name

null none

null null

no no

id initSortSeq

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thir d. The label for the component. string boolean boolean jrad:scope

null false true .

admin null user null

no no no no

labelTitle cellNoWrap Format rendered scope

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.

173

OA Extension Component Reference

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 des cending.

Type boolean string Also supports Expression Language (EL) syntax. string

Defaul Personal Transla t Value izable table false no admin admin no no

XML Attribute queryable sortState

Sort By View Attribute Text Total Value

The alternate view attribute name for use when sorting. The text label for the component.

null

null

no

sortByView Attr text totalValue

string

null false

admin user

yes no

Indicates if an additional field boolean should be displayed to show the total of this column. boolean

User Indicates if a user can Personali personalize this component. zation View Attribute The name of the view attribute.

false

admin

no

userCusto mizable viewAttr viewName xml:lang

string string optional

null null null

null null null

no no no

View The name of the view object Instance instance. xml:lang Identifies the language contained within this component.

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

174

Item Styles

Properties
Name Description Type Defaul Persona Transl t lizable atable Value true admin no XML Attribute adminCusto mizable use comment dataType

Admin Indicates if an Administrator Personal can personalize this ization component. Attribute The attribute set for the Set component. Commen Comments ts Data Type

boolean

jrad:attribut null eSetRef string null VARC HAR2

null null null

no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB.

Docume The name of the component jrad:refNa nt Name me Encrypt Indicates if the contents is encrypted in the HTML source. A reference to another component that creates a different instance of that component at runtime. The unique name of this component. The text label for the component. boolean

null false

null null

no no

docName encrypted

Extends

jrad:compo null nentRef

null

no

extends

ID Prompt

Name string

null null true .

null admin user null

no true no no

id prompt rendered scope

Rendere Indicates if the component is boolean d rendered. Scope 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 jrad:scope

Search Allowed Security Mode

boolean string

false

null

no no

queryable securityMode

standa null rd

175

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl t lizable atable Value

XML Attribute

developer's responsibility to handle security validation. The legal values are standard, and selfSecured. Selective Indicates if the item is part of boolean Search a group of items, one of Criteria which must be included in the search. User Indicates if a user can Personal personalize this component. ization View The name of the view Attribute attribute. boolean false admin no selectiveSear chCriteria

false

admin

no

userCustomiz able viewAttr viewName xml:lang

string

null null null

null null null

no no no

View The name of the view object string Instance instance. xml:lang Identifies the language contained within this component. optional

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

Properties
Name Description Type Defaul Persona Transl t lizable atable Value null admin no XML Attribute accessKey

Access Key Action 176

The character used for quick string keyboard navigation or activation. The action type to fire for the string

none

null

no

primaryClie

Item Styles

Name

Description

Type

Defaul Persona Transl t lizable atable Value

XML Attribute ntAction

Type

component. It should be either "fireAction" or "none." string boolean null true admin admin true no

Addition Additional help text. al Text Admin Indicates if an Administrator Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Class Data Type Comments Overrides the default CSS class.

shortDesc adminCust omizable use comment styleClass dataType

jrad:attributeS null etRef string string null null VARC HAR2

null null admin null

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

Destinati The function to invoke. on Function Destinati The destination URI. on URI

null

admin

no

invokeFunc

uriReference

null false

null null

no no

destination serverUnva lidated

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Docume The name of the component jrad:refName 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 string

null null

null admin

no no

docName exportByVi ewAttr extends

jrad:compone null ntRef

null

no

Indicates the height in pixels ui:stringExpre null or as a percentage (if % sign ssionType included).

null

no

imageHeig ht

177

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl t lizable atable Value null null none null null null no no no

XML Attribute id source initSortSeq

ID Image URI Initial Sort Sequenc e

The unique name of this component. The URI for the image file.

Name uriReference

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd. boolean boolean string string

No Wrap Indicates if cell contents should be wrapped. Popup Indicates whether the popEnabled up is enabled. Popup ID Popup Render Event Prompt The unique name of the pop-up. Indicates on what action type the event is to be rendered for the pop-up. The text label for the component.

false false null

null admin admin

no no no no

cellNoWrap Format popupEnab led popupId popupRend erEvent prompt rendered scope

onClic admin k null true . admin user null

string

true no no

Rendere Indicates if the component is boolean d rendered. Scope The Base Packages which are allowed to reuse this component. Indicates if the user can sort this column. The legal values are yes, no, ascending, and de scending. jrad:scope

Sort Allowed

string Also supports Expression Language (EL) syntax. string

no

admin

no

sortState

Sort By The alternate view attribute View name for use when sorting. Attribute

null

null

no

sortByView Attr userCusto mizable viewAttr viewName

User Indicates if a user can boolean Personal personalize this component. ization View The name of the view Attribute attribute. View 178 string

false

admin

no

null null

null null

no no

The name of the view object string

Item Styles

Name

Description

Type

Defaul Persona Transl t lizable atable Value true null no

XML Attribute

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 warnAbout Changes

On SpacerBean: Indicates ui:stringExpre null the width in pixels. On ssionType others: Indicates the width in pixels or as a percentage (if % sign included). optional null

null

no

imageWidt h

xml:lang Identifies the language contained within this component.

null

no

xml:lang

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

Properties
Name Description Type Defa Personaliza Translata ult ble ble Value null admin no XML Attribute

Access Key The character string used for quick keyboard navigation or activation. Action Type The action string type to fire for

accessKey

none

null

no

primaryClientAc tion 179

OA Extension Component Reference

Name

Description

Type

Defa Personaliza Translata ult ble ble Value

XML Attribute

the component. It should be either "fireAction", "firePartialActi on" or "none." Admin Indicates if an boolean Personalizat Administrator ion can personalize this component. Attribute Set The attribute set for the component. Comments CSS Class Comments true admin no adminCustomiz able

jrad:attributeSe null tRef string null null

null

no

use

null admin

no no

comment styleClass

Overrides the string default CSS class. The function to invoke. The destination URI. string uriReference

Destination Function Destination URI

null null

admin null

no no

invokeFunc destination

Disable Indicates if boolean Server Side validation Validation should not occur on the business tier during a form submit. Document Name Extends The name of the component jrad:refName

false

null

no

serverUnvalidat ed

null

null

no

docName

A reference jrad:component null to another Ref component that creates a different instance of that

null

no

extends

180

Item Styles

Name

Description

Type

Defa Personaliza Translata ult ble ble Value

XML Attribute

component at runtime. ID The unique name of this component. Indicates whether the pop-up is enabled. The unique name of the pop-up. Name null null no id

Popup Enabled

boolean

false

admin

no

popupEnabled

Popup ID

string

null

admin

no

popupId

Popup Render Event

Indicates on string what action type the event is to be rendered for the pop-up. Indicates if boolean the component is rendered. The Base Packages which are allowed to reuse this component. The name of the target frame for the link. jrad:scope

onCli ck

admin

no

popupRenderE vent

Rendered

true

user

no

rendered

Scope

null

no

scope

Target Frame

string

null

admin

yes

targetFrame

Text

The text label string for the component. boolean

null

admin

yes

text

User Indicates if a Personalizat user can ion personalize this component. View Attribute The name of the view

false

admin

no

userCustomiza ble

string

null

null

no

viewAttr

181

OA Extension Component Reference

Name

Description

Type

Defa Personaliza Translata ult ble ble Value null null no

XML Attribute

attribute. View Instance The name of the view object instance. string viewName

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 language contained within this component. optional

true

null

no

warnAboutCha nges

null

null

no

xml:lang

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

182

Item Styles

Name

Description

Type

Defaul Persona Transl t lizable atable Value null true admin admin yes no

XML Attribute shortDesc adminCustom izable use comment styleClass dataType

Addition al Text

Additional help text.

string boolean

Admin Indicates if an Administrator Personal can personalize this ization component. Attribute The attribute set for the Set component. Commen Comments ts CSS Class Data Type Overrides the default CSS class.

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. boolean

Disabled Indicates if the element is disabled.

false null null

null null admin

no no no

disabled docName exportByView Attr extends

Docume The name of the component jrad:refNa nt Name me 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. The unique name of this component. The display height in characters. Indicates if the list allows multiple selections. string

jrad:compo null nentRef

null

no

ID List Height MultiSelect Allowed

Name

null

null null null

no no no

id size multiple

unsignedIn null t boolean false

No Wrap Indicates if cell contents should be wrapped. Picklist The view attribute that Descripti serves as the description of on choices.

boolean string

false null

null null

no no

cellNoWrapF ormat pickListViewD escription

183

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl t lizable atable Value null null no

XML Attribute

Attribute Picklist The view attribute that Display serves as the displayed Attribute value of choices. Picklist The view attribute that Value serves as the internal value Attribute of choices. Picklist View Definitio n The fully-qualified view object name for the picklist, cached at the JVM level. string pickListDispA ttr pickListValAtt r pickListViewD ef

string

null

null

no

string

null

null

no

Picklist The view instance name for View the picklist. Instance Read Only Indicates if the value can be changed.

string

null

null

no

pickListViewN ame readOnly rendered scope

boolean

false true .

admin user null

no no no

Rendere Indicates if the component is boolean d rendered. Scope The Base Packages which are allowed to reuse this component. jrad:scope

Security Mode

Defines the security mode string 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. string

standa null rd

no

securityMode

View The name of the view Attribute attribute.

null null null

null null null

no no no

viewAttr viewName xml:lang

View The name of the view object string Instance instance. xml:lang Identifies the language contained within this component. optional

messageCheckBox
184

Item Styles

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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." string

none

null

no

primaryClientA ction

Addition Additional help text. al Text

null true

admin admin

yes no

shortDesc adminCustomiz able use checkedValue comment styleClass dataType

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Checked The value when checked. Value Comme nts CSS Class Data Type Comments Overrides the default CSS class.

jrad:attribu null teSetRef string string string null null null

null null null admin

no no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

185

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value false null no serverUnvalida ted

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. boolean

false null null

null null admin

no no no

disabled docName exportByViewA ttr extends

Docume The name of the component jrad:refNa nt Name me 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 Initial Sort Sequenc e Initial Value The unique name of this component. string

jrad:compo null nentRef

null

no

Name

null none

null null

no no

id initSortSeq

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd. The initial (default) value of the item. string boolean

null null null false null false true

admin null admin null admin admin user admin

no no no no yes no no no

defaultValue checked longTipRegion cellNoWrapFor mat prompt readOnly rendered required

Initially The initial (default) state of Checked the item.

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me No Wrap Indicates if cell contents should be wrapped. Prompt Read Only The text label for the component. boolean string

Indicates if the value can be boolean changed.

Rendere Indicates if the component is boolean d rendered. Require d Indicates if the user must enter a value and how that appears to the user. Three

ui:required no

186

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

values are allowed: "yes", "no", and "default". Scope The Base Packages which are allowed to reuse this component. jrad:scope . null no scope

Search Allowed Selectiv e Search Criteria Sort Allowed

Indicates if the item will be boolean shown in the search panels. Indicates if the item is part of boolean 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 de scending. string Also supports Expression Language (EL) syntax. string

false false

admin admin

no no

queryable selectiveSearc hCriteria

no

admin

no

sortState

Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message.

null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Uncheck The value when unchecked. string ed Value User Indicates if a user can boolean Personal personalize this component. ization Vertical Vertical alignment. Alignme Acceptable values are string

none

admin

no

null false

null admin

no no

unCheckedVal ue userCustomiza ble vAlign

null

null

no

187

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

nt

"middle", "top", and "bottom". string null null true null null null no no no viewAttr viewName warnAboutCha nges

View The name of the view Attribute attribute.

View The name of the view object string Instance instance. Warn About Change s 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. optional

xml:lang Identifies the language contained within this component.

null

null

no

xml:lang

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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."

none

null

no

primaryClientA ction

188

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value true admin no allowBlankValu e shortDesc adminCustomiz able use comment styleClass dataType

Add Blank Value

Adds an empty value to the choice list if it is not Required

boolean

Addition Additional help text. al Text

string

null true

admin admin

yes no

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Class Data Type Comments Overrides the default CSS class.

jrad:attribu null teSetRef string string null null

null null admin

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. boolean

false

null

no

serverUnvalida ted

false null null

null null admin

no no no

disabled docName exportByViewA ttr extends

Docume The name of the component jrad:refNa nt Name me 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. string

jrad:compo null nentRef

null

no

Name

null

null

no

id

189

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value none null no initSortSeq

Initial Sort Sequenc e Initial Value

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd. The initial (default) value of the item. string

null null false null

admin admin null null

no no no no

defaultValue longTipRegion cellNoWrapFor mat pickListDispAttr

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me No Wrap Indicates if cell contents should be wrapped. Picklist The view attribute that Display serves as the displayed Attribute value of choices. Picklist The view attribute that Value serves as the internal value Attribute of choices. Picklist The fully-qualified view View object name for the picklist, Definitio cached at the JVM level. n Picklist The view instance name for View the picklist. Instance Prompt Read Only The text label for the component. boolean string

string

null

null

no

pickListValAttr

string

null

null

no

pickListViewDe f

string

null

null

no

pickListViewNa me prompt readOnly rendered required

string

null false true no

admin admin user admin

yes no no no

Indicates if the value can be boolean changed.

Rendere Indicates if the component is boolean d rendered. Require d 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. string

Scope

jrad:scope .

null

no

scope

Search Allowed

Indicates if the item will be boolean shown in the search panels.

false

admin

no

queryable

190

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value standa null rd no securityMode

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 selfSecured. Selectiv e Search Criteria Sort Allowed Indicates if the item is part of boolean 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 de scending. string Also supports Expression Language (EL) syntax. string

false

admin

no

selectiveSearc hCriteria

no

admin

no

sortState

Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message.

null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Total Value Indicates if an additional field should be displayed to show the total of this column. boolean

none

admin

no

false

user

no

totalValue

User Indicates if a user can boolean Personal personalize this component. ization Vertical Vertical alignment. string

false

admin

no

userCustomiza ble vAlign 191

null

null

no

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

Alignme Acceptable values are nt "middle", "top", and "bottom". View The name of the view Attribute attribute. string null null true null null null no no no viewAttr viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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. optional

xml:lang Identifies the language contained within this component.

null

null

no

xml:lang

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 Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key 192

The character used for quick string keyboard navigation or

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value true admin no adminCustomiz able use comment dataType

activation. Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts Data Type Comments

jrad:attribu null teSetRef string null

null null

no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, CLO B, and BLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Docume The name of the component jrad:refNa nt Name me 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. File MIME Type The MIME type of the File. string

null null

null admin

no no

docName exportByViewA ttr extends

jrad:compo null nentRef

null

no

string

null

null

no

fileContentTyp e downloadFileN ame contentViewAtt ributeName rows initSortSeq

File The File Name to use Name instead of the view attribute Override text when saving the file.

string

null

null

no

File The view attribute for the file string View content. Attribute Height Initial Sort Sequenc e The display height of the Search item in characters.

null

null

no

unsignedIn null t none

null null

no no

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi

193

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null admin admin no no longTipRegion maximumLengt h

rd. Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me Maximu m Length The number of characters a user can enter as search criteria for this field in a results-based (automatic) search.

unsignedIn null t Also supports Expression Language (EL) syntax. boolean string false null true

No Wrap Indicates if cell contents should be wrapped. Prompt The text label for the component.

null admin user admin

no yes no no

cellNoWrapFor mat prompt rendered required

Rendere Indicates if the component is boolean d rendered. Require d Indicates if the user must enter a value and how that appears to the user. Three values are allowed: "yes", "no", "default". The Base Packages which are allowed to reuse this component.

ui:required no

Scope

jrad:scope .

null

no

scope

Search Allowed Selectiv e Search Criteria Sort Allowed

Indicates if the item will be boolean shown in the search panels. Indicates if the item is part of boolean 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 de scending. string Also supports Expression Language (EL) syntax. string

false false

admin admin

no no

queryable selectiveSearc hCriteria

no

admin

no

sortState

Sort By 194

The alternate view attribute

null

null

no

sortByViewAttr

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message. string null admin no tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. User Indicates if a user can boolean Personal personalize this component. ization Vertical Vertical alignment. Alignme nt View The name of the view Attribute attribute. string

none

admin

no

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null null true

null null null

no no no

viewAttr viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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. The display length of the Search item in characters.

Width

unsignedIn null t optional null

null null

no no

columns xml:lang

xml:lang Identifies the language contained within this component.

messageFileUpload
195

OA Extension Component Reference

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 Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key

The character used for quick string keyboard navigation or activation. string

Addition Additional help text. al Text

null true

admin admin

yes no

shortDesc adminCustomiz able use comment styleClass dataType

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Class Data Type Comments Overrides the default CSS class.

jrad:attribu null teSetRef string string null null

null null admin

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, CLO B, and BLOB.

VARC null HAR2

Docume The name of the component jrad:refNa nt Name me Extends A reference to another component that creates a different instance of that component at runtime. ID The unique name of this component.

null

null null

no no

docName extends

jrad:compo null nentRef

Name

null

null

no

id

196

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null admin null admin user admin no no no yes no no columns longTipRegion cellNoWrapFor mat prompt rendered required

Length

The display length in characters.

unsignedIn null t null false null true

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me No Wrap Indicates if cell contents should be wrapped. Prompt The text label for the component. boolean string

Rendere Indicates if the component is boolean d rendered. Require d 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.

ui:required no

Scope

jrad:scope .

null

no

scope

Tip Messag e Appl Short Name Tip Messag e Name

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. User Indicates if a user can boolean 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. string

none

admin

no

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null null

null null

no no

viewAttr viewName

View The name of the view object string Instance instance.

197

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value false admin no virusScanEnab led xml:lang

Virus Indicates if Virus Scan is boolean Scan enabled on file attachments. Enabled xml:lang Identifies the language contained within this component. optional

null

null

no

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

Properties
Name Description Type Defaul Persona Transl t lizable atable Value true admin no XML Attribute

Admin Indicates if an Persona Administrator can lization personalize this component. Attribute The attribute set for the Set component.

boolean

adminCustomiza ble

jrad:attribut null eSetRef false null null true

null null null admin null

no no no no no

use autoCommitEna bled comment styleClass unvalidated

Automat Indicates if automatic save boolean ic Save is enabled. Comme Comments. nts CSS Class Disable Client Side Validatio 198 string

Overrides the default CSS string class. Indicates if validation should not occur on the web tier during a form submit. boolean

Item Styles

n Disable Server Side Validatio n Indicates if validation boolean should not occur on the business tier during a form submit. boolean true null no serverUnvalidate d

Enable Indicates if the Document Docume Catalog is enabled for the nt component. Catalog Extends A reference to another component that creates a different instance of that component at runtime. ID The unique name of this component.

true

admin

no

enableDocument Catalog

jrad:compo null nentRef

null

no

extends

Name boolean

null null

null admin

no no

id inlineAttachment Enabled

Inline Indicates whether inline Attachm attachment capability is ent enabled or not. Enabled Links The number of Displaye attachments links d displayed inline. Default value is 5 if not defined. Long Tip The fully-qualified Region reference to the long tip region. Prompt Render Search Region The text label for the component. Indicates if the search region is rendered.

nonNegati veInteger

admin

no

numberAttachme ntsDisplayed

jrad:refNa me string boolean

null

admin

no

longTipRegion

Attach admin ments true null

yes no

prompt searchRegionRe ndered rendered required

Rendere Indicates if the component boolean d is rendered.

true

user admin

no no

Require Indicates if the user must ui:required no d enter a value and how that appears to the user. Three values are allowed: "yes", "no", and "default". Tip The application short Messag name that owns the tip e Appl message. Short Name string null

admin

no

tipMessageAppS hortName

199

OA Extension Component Reference

Tip The name of the tip Messag message. e Name

string

null

admin

no

tipMessageNam e tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. View The name of the view Instance object instance. string

none

admin

no

null

null

no

viewName

Element Children
Name entityMappings 1 Quantity Description Defines the entity and item relationships.

entityMap
Name Descriptio n string Type Defau Personaliza lt ble Value null null Translata ble no XML Attribute

Approval Function Function Name for Name the approval process.

approvalFunctionN ame

Approval View string View Attribute to Attribute determine if approval process is required.

null

null

no

approvalViewAttr

Attribute The jrad:attributeSet null Set attribute Ref set for the component . Commen Comments string ts . Delete Allowed Indicates if boolean the user can delete attachment s from the current null true

null

no

use

null null

no no

comment deleteAllowed

200

Item Styles

object. Entity The name string of the attachment entity which defines the primary key relationshi ps. Indicates if boolean new attachment s can be created for this entity. null null no entityId

Insert Allowed

true

null

no

insertAllowed

Show All Indicates if boolean the user can view any attachment for the current object, regardless of category. Update Allowed Indicates if boolean 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 Type Defaul Personalizabl Translatabl t e e XML Attribute 201

OA Extension Component Reference

Value Attribute Set The jrad:attributeSetR null attribute ef set for the component . The string attachment category name. null null no use

Category

null

no

categoryNam e

Comment Comments. string s Secured Indicates if boolean the object is secured by grants model.

null false

null admin

no no

comment secured

primaryKey
Name Descriptio n Type Defaul Personalizabl t Value e null Translatabl e no XML Attribut e use

Attribute Set

The jrad:attributeSetRe null attribute set f for the component. Comments. string The name of the view attribute. string null null

Comment s View Attribute

null null

no no

comment viewAttr

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. 202

Item Styles Corresponding web bean: OAMessageLovChoiceBean

Properties
Name Description Type Defau Person Transl lt alizable atable Value null admin no XML Attribute accessKey

Access Key Action Type

The character used for quick keyboard navigation or activation. The action type to fire for the component. It should be either "fireAction", "firePartialAction" or "none."

string

string

none

null

no

primaryClient Action

Addition Additional help text. al Text

string

null true

admin admin

yes no

shortDesc adminCustomi zable use comment styleClass dataType

Admin Indicates if an Administrator can boolean Persona personalize this component. lization Attribute The attribute set for the Set component. Comme Comments nts CSS Class Data Type Overrides the default CSS class.

jrad:attrib null uteSetRef string string null null

null null admin

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATETIME , NUMBER, BIGDECIMAL, BOOLEAN, and CLOB. string

VARC null HAR2

Destinat The function to invoke. ion Functio n

null

admin

no

invokeFunc

Disable Indicates if validation should not boolean Validati occur on the web tier during a on form submit. Disable Indicates if the element is d disabled. Export The alternate view attribute for View use when exporting. Attribute boolean string

false

null

no

unvalidated

false null

null admin

no no

disabled exportByView Attr

203

OA Extension Component Reference

External The name of the external List of jrad:comp null LOV Values region. onentRef Initial Sort Sequen ce Initial Value Indicates the initial sort string sequence for each search. The legal values are none, first, second, and third. The initial (default) value of the item. string none

null null

no no

externalListOf Values initSortSeq

null false

admin null

no no

defaultValue userEditableLi st cellNoWrapFo rmat pickListDispAt tr pickListValAttr

List Indicates if the user can boolean Persona personalize the LOV Choice list. lization No Wrap Indicates if cell contents should boolean be wrapped. string

false null

null null

no no

Picklist The view attribute that serves Display as the displayed value of Attribute choices.

Picklist The view attribute that serves string Value as the internal value of choices. Attribute Prompt Read Only Render ed The text label for the component. Indicates if the value can be changed. Indicates if the component is rendered. string boolean boolean

null

null

no

null false true no

admin admin user admin

yes no no no

prompt readOnly rendered required

Require Indicates if the user must enter string d a value and how that appears to the user. Two values are allowed: "yes", "no". Search Indicates if the item will be Allowed shown in the search panels. boolean

false false

admin admin

no no

queryable selectiveSearc hCriteria

Selectiv Indicates if the item is part of a boolean e group of items, one of which Search must be included in the search. Criteria Sort Indicates if the user can sort Allowed this column. The legal values are yes, no, ascending, and descen ding. string Also supports Expressio n Language (EL) syntax.

no

admin

no

sortState

204

Item Styles

Sort By The alternate view attribute View name for use when sorting. Attribute

string

null

null

no

sortByViewAtt r tipMessageAp pShortName

Tip The application short name that string Messag owns the tip message. e Appl Short Name Tip The name of the tip message. Messag e Name Tip Type string

null

admin

no

null

admin

no

tipMessageNa me tipType

The type of tip. The legal values string are dateFormat, longMessage, shor tTip, and none. Indicates if an additional field boolean should be displayed to show the total of this column. boolean

none

admin

no

Total Value

false

user

no

totalValue

User Indicates if a user can Persona personalize this component. lization Vertical Vertical alignment. Acceptable Alignme values are "middle", "top", and nt "bottom". View The name of the view attribute. Attribute View Instanc e Warn About Change s The name of the view object instance.

false

admin

no

userCustomiz able vAlign

string

null

null

no

string string

null null

null null

no no

viewAttr viewName

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. optional

true

null

no

warnAboutCh anges

xml:lang Identifies the language contained within this component.

null

null

no

xml:lang

lovMap
Name Description Type Defa Personaliza Translata XML Attribute ult ble ble Value 205

OA Extension Component Reference

Attribute Set

The attribute set for the component.

jrad:attributeSe null tRef string null null

null

no

use

Comments Comments. Criteria Item

null null

no no

comment criteriaFrom

The ID of the jrad:localRef item in the base page that provides the criteria for the LOV. The name of the item in the List Of Values region.

LOV Region Item

jrad:localRefStr null ing

null

no

lovItem

Programm Indicates if the boolean atic Query Criteria Item value will not be automatically applied to the LOV. Required Indicates if the boolean item specified in the Criteria Item property must have a value. The name of the item in the base page that receives the result from the LOV Region Item. jrad:localRef

false

null

no

programmaticQ uery

false

null

no

requiredForLO V

Return Item

null

null

no

resultTo

Use for Validation

Indicates if the string return item will always contain a value if a row from the LOV is selected. The legal values are default, yes, an d no.

defau null lt

no

useForValidatio n

messageLovInput
206

Item Styles

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 Type Defau Person Transl lt alizable atable Value null admin no XML Attribute

Access The character used for quick Key keyboard navigation or activation. Additio Additional help text. nal Text Admin Indicates if an Administrator Person can personalize this alizatio component. n Attribut The attribute set for the e Set component. Comme Comments nts CSS Class Data Type Overrides the default CSS class.

string

accessKey

string boolean

null true

admin admin

yes no

shortDesc adminCustomiza ble

jrad:attrib null uteSetRef string string null null

null null admin

no no no no

use comment styleClass dataType

The type of data. The legal string values are VARCHAR2, DATE, DATETIM E, NUMBER, BIGDECIMAL, BOOLEAN, and CLOB. boolean

VARC null HAR2

Disable Indicates if validation should Validati not occur on the web tier on during a form submit. Disable Indicates if the element is

false

null

no

unvalidated

boolean

false

null

no

disabled 207

OA Extension Component Reference

disabled. jrad:refNa null me null null no docName

Docum The name of the component ent Name

Export The alternate view attribute for string View use when exporting. Attribut e Extend s A reference to another component that creates a different instance of that component at runtime.

admin

no

exportByViewAttr

jrad:comp null onentRef

null

no

extends

Externa The name of the external List l LOV of Values region. Height ID Initial Sort Sequen ce Initial Value Length The display height in characters. The unique name of this component. Indicates the initial sort sequence for each search. The legal values are none, first, second, and third.

jrad:comp null onentRef unsignedI 1 nt Name string null none

null null null null

no no no no

externalListOfVal ues rows id initSortSeq

The initial (default) value of the string item. The display length in characters.

null

admin null admin

true no no

translatableDefau ltValue columns longTipRegion

unsignedI null nt

Long The fully-qualified reference to jrad:refNa null Tip the long tip region. me Region Look Ahead Enable d Whether look-ahead capability boolean is enabled or not. null

admin

no

lookAheadEnable d

Look Maximum number of records Ahead displayed in the look ahead Record window. s Display ed Look Ahead Record s Visible 208

unsignedI 50 nt

admin

no

lookAheadRecor dsDisplayed

The maximum number of unsignedI 10 records visible to a user in the nt look ahead window at any point in time.

admin

no

lookAheadRecor dsVisible

Item Styles

Look Type of search to be Ahead performed. Search Type Look Whether server-side event to Ahead be generated on value Selectio selection. n Event Enable d

anySimpl starts admin eType With

no

lookAheadSearc hType

boolean

true

null

no

lookAheadSelecti onEventEnabled

Maximu The maximum number of unsignedI null m characters per line that can be nt Length entered. Also supports Expressio n Language (EL) syntax. Minimu Minimum number of m characters required to initiate Charact look ahead. ers For Look Ahead No Wrap Indicates if cell contents should be wrapped. unsignedI null nt

null

no

maximumLength

admin

no

lookAheadMinCh ars

boolean string boolean boolean

false null false true

null admin admin user admin

no yes no no no

cellNoWrapForm at prompt readOnly rendered required

Prompt The text label for the component. Read Only Indicates if the value can be changed.

Render Indicates if the component is ed rendered.

Require Indicates if the user must enter ui:require no d a value and how that appears d to the user. Three values are allowed: "yes", "no", and "validaterOnly". Scope The Base Packages which are jrad:scop . allowed to reuse this e component. boolean false false

null

no

scope

Search Indicates if the item will be Allowed shown in the search panels.

admin admin

no no

queryable selectiveSearchC 209

Selectiv Indicates if the item is part of a boolean

OA Extension Component Reference

e group of items, one of which Search must be included in the Criteria search. showR equired Sort Indicates if the user can sort Allowed this column. The legal values are yes, no, ascending, and desce nding. boolean string Also supports Expressio n Language (EL) syntax. string null null no false no null admin no no

riteria

showRequired sortState

Sort By The alternate view attribute View name for use when sorting. Attribut e Tip The application short name Messag that owns the tip message. e Appl Short Name Tip The name of the tip message. Messag e Name Tip Type The type of tip. The legal values are dateFormat, longMessage, sh ortTip, and none.

sortByViewAttr

string

null

admin

no

tipMessageAppS hortName

string

null

admin

no

tipMessageName

string

none

admin

no

tipType

User Indicates if a user can Person personalize this component. alizatio n

boolean

false

admin

no

userCustomizabl e

Vertical Vertical alignment. Acceptable string Alignm values are "middle", "top", and ent "bottom". View The name of the view Attribut attribute. e View The name of the view object Instanc instance. e Warn About 210 Warns the user if there are pending changes that will be string

null

null

no

vAlign

null

null

no

viewAttr

string

null

null

no

viewName

boolean

true

null

no

warnAboutChang es

Item Styles

Change lost, and allows them to cancel s the current action or discard the changes and continue with the current action. xml:lan Identifies the language g contained within this component. optional null null no xml:lang

lovMap
Name Description Type Defa Personaliza Translata XML Attribute ult ble ble Value null no use

Attribute Set

The attribute set for the component.

jrad:attributeSe null tRef string null null

Comments Comments. Criteria Item

null null

no no

comment criteriaFrom

The ID of the jrad:localRef item in the base page that provides the criteria for the LOV. The name of the item in the List Of Values region.

LOV Region Item

jrad:localRefStr null ing

null

no

lovItem

Programm Indicates if the boolean atic Query Criteria Item value will not be automatically applied to the LOV. Required Indicates if the boolean item specified in the Criteria Item property must have a value. The name of the item in the base page that receives the result from the LOV Region Item. jrad:localRef

false

null

no

programmaticQ uery

false

null

no

requiredForLO V

Return Item

null

null

no

resultTo

211

OA Extension Component Reference

Use for Validation

Indicates if the string return item will always contain a value if a row from the LOV is selected. The legal values are default, yes, an d no.

defau null lt

no

useForValidatio n

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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." string

none

null

no

primaryClientA ction

Addition Additional help text. al Text

null true

admin admin

yes no

shortDesc adminCustomiz able use

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. 212

jrad:attribu null teSetRef

null

no

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null null null null admin no no no no checkedValue comment styleClass dataType

Checked The value when checked. Value Comme nts CSS Class Data Type Comments Overrides the default CSS class.

string string string

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. boolean

false

null

no

serverUnvalida ted

false null

null null null

no no no

disabled docName extends

Docume The name of the component jrad:refNa nt Name me Extends A reference to another component that creates a different instance of that component at runtime. Group Name ID Initial Value The name of the Radio Group. The unique name of this component. The initial (default) value of the item.

jrad:compo null nentRef

string Name string

null null null null null false

null null admin admin admin admin

no no no no yes no

name id defaultValue longTipRegion prompt readOnly

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me Prompt Read Only The text label for the component. string

Indicates if the value can be boolean changed.

213

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value true user admin no no rendered required

Rendere Indicates if the component is boolean d rendered. Require d 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.

ui:required no

Scope

jrad:scope .

null

no

scope

Selectiv e Search Criteria Tip Messag e Appl Short Name Tip Messag e Name

Indicates if the item is part of boolean a group of items, one of which must be included in the search. The application short name that owns the tip message. string

false

admin

no

selectiveSearc hCriteria

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Uncheck The value when unchecked. string ed Value Vertical Vertical alignment. Alignme Acceptable values are nt "middle", "top", and "bottom". View The name of the view Attribute attribute. string

none

admin

no

null null

null null

no no

unCheckedVal ue vAlign

string

null null true

null null null

no no no

viewAttr viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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

214

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null no xml:lang

action. xml:lang Identifies the language contained within this component. optional

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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." string

none

null

no

primaryClientA ction

Addition Additional help text. al Text

null true

admin admin

yes no

shortDesc adminCustomiz able use comment styleClass 215

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Comments Overrides the default CSS

jrad:attribu null teSetRef string string null null

null null admin

no no no

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value VARC null HAR2 no dataType

Class Data Type

class. The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. boolean

false

null

no

serverUnvalida ted

false null null

null null admin

no no no

disabled docName exportByViewA ttr extends

Docume The name of the component jrad:refNa nt Name me 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 Initial Sort Sequenc e Initial Value The unique name of this component. string

jrad:compo null nentRef

null

no

Name

null none

null null

no no

id initSortSeq

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd. The initial (default) value of the item. string

null null false null

admin admin null null

no no no no

defaultValue longTipRegion cellNoWrapFor mat pickListDispAttr

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me No Wrap Indicates if cell contents should be wrapped. Picklist Display 216 The view attribute that serves as the displayed boolean string

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null no pickListValAttr

Attribute value of choices. Picklist The view attribute that Value serves as the internal value Attribute of choices. Picklist The fully-qualified view View object name for the picklist, Definitio cached at the JVM level. n Picklist The view instance name for View the picklist. Instance Prompt Read Only The text label for the component. string

string

null

null

no

pickListViewDe f

string

null

null

no

pickListViewNa me prompt readOnly rendered required

string

null false true no

admin admin user admin

yes no no no

Indicates if the value can be boolean changed.

Rendere Indicates if the component is boolean d rendered. Require d 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. string

Scope

jrad:scope .

null

no

scope

Search Allowed

Indicates if the item will be boolean shown in the search panels.

false

admin

no no

queryable securityMode

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 selfSecured. Selectiv e Search Criteria Sort Allowed Indicates if the item is part of boolean a group of items, one of which must be included in the search. Indicates if the user can sort string this column. The legal values are Also

standa null rd

false

admin

no

selectiveSearc hCriteria

no

admin

no

sortState

217

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

yes, no, ascending, and de supports scending. Expression Language (EL) syntax. Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message. string null null no sortByViewAttr

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. User Indicates if a user can boolean 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. string

none

admin

no

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null null true

null null null

no no no

viewAttr viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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. optional

xml:lang Identifies the language contained within this component.

null

null

no

xml:lang

218

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 Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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 choice list if it is not Required boolean

none

null

no

primaryClientA ction

Add Blank Value (In Release 12.2.2, this property is not impleme nted.)

true

admin

no

allowBlankValu e

Addition Additional help text. al Text

string

null true

admin admin

yes no

shortDesc adminCustomiz able use 219

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the

jrad:attribu null

null

no

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null null admin no no no comment styleClass dataType

Set Comme nts CSS Class Data Type

component. Comments Overrides the default CSS class.

teSetRef string string

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. 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 Initial Sort Sequenc e Initial Value The unique name of this component. boolean string

false

null

no

serverUnvalida ted

false null

null admin

no no

disabled exportByViewA ttr extends

jrad:compo null nentRef

null

no

Name

null none

null null

no no

id initSortSeq

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd. The initial (default) value of the item. string

null null false

admin admin null

no no no

defaultValue longTipRegion cellNoWrapFor mat

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me No Wrap Indicates if cell contents should be wrapped. 220 boolean

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null no pickListDispAttr

Picklist The view attribute that Display serves as the displayed Attribute value of choices. Picklist The view attribute that Value serves as the internal value Attribute of choices. Picklist The fully-qualified view View object name for the picklist, Definitio cached at the JVM level. n Picklist The view instance name for View the picklist. Instance Prompt Read Only The text label for the component.

string

string

null

null

no

pickListValAttr

string

null

null

no

pickListViewDe f

string

null

null

no

pickListViewNa me prompt readOnly rendered required

string

null false true no

admin admin user admin

yes no no no

Indicates if the value can be boolean changed.

Rendere Indicates if the component is boolean d rendered. Require d Indicates if the user must enter a value and how that appears to the user. Two values are allowed: "yes", "no". string

Search Allowed

Indicates if the item will be boolean shown in the search panels.

false

admin

no no

queryable securityMode

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 selfSecured. Selectiv e Search Criteria Sort Allowed Indicates if the item is part of boolean a group of items, one of which must be included in the search. Indicates if the user can sort string this column. The legal values are Also yes, no, ascending, and de supports scending.

standa null rd

false

admin

no

selectiveSearc hCriteria

no

admin

no

sortState

221

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

Expression Language (EL) syntax. Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message. string null null no sortByViewAttr

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Total Value Indicates if an additional field should be displayed to show the total of this column. boolean

none

admin

no

false

user

no

totalValue

User Indicates if a user can boolean 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. string

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null null true

null null null

no no no

viewAttr viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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.

222

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 Description Type string boolean Default Personali Translat Value zable able null true admin admin yes no XML Attribute shortDesc adminCustomizabl e

Additional Additional help Text text. Admin Indicates if an Personaliz Administrator ation can personalize this component. Alignment Indicates if the Icons left, center, and right alignment icons are displayed. Attribute Set Bullet Icons

boolean

false

null

no

alignmentGroup

The attribute set jrad:attribute null for the SetRef component. Indicates if the bullet icons are displayed. boolean true

null

no

use

null

no

bulletGroup

ClickThru The URI string Destinatio launched from n URI the "Click Thru Destination" icon. If empty, no icon is shown.

null

null

no

clickThruDestinatio nUri

223

OA Extension Component Reference

Name

Description

Type string

Default Personali Translat Value zable able null false null null no no

XML Attribute comment hyperlinkButton

Comment Comments s Create Hyperlink Icon

Indicates if the boolean create hyperlink icon is displayed.

Data Type The type of data. string The legal values are VARCHAR2, an d CLOB. Disable Server Side Validation Indicates if boolean validation should not occur on the business tier during a form submit. boolean

VARCH null AR2

no

dataType

false

null

no

serverUnvalidated

Edit Icons Indicates if the cut, copy and paste icons are displayed. Extends

true

null

no

editGroup

A reference to jrad:compon null another entRef component that creates a different instance of that component at runtime. Indicates if the font bar is displayed. boolean false

null

no

extends

Font Bar

null

no

fontBar

Image Upload URl

The URI string launched from the insert image icon. If empty, no icon is shown.

null

null

no

imageUploadUri

Indentatio Indicates if the boolean n Icons indentation icons are displayed. Long Tip Region The fullyqualified reference to the long tip region. string

false

null

no

indentationGroup

null

admin

no

longTipRegion

224

Item Styles

Name

Description

Type unsignedInt Also supports Expression Language (EL) syntax.

Default Personali Translat Value zable able null null no

XML Attribute maximumLength

Maximum The maximum Length number of characters that can be entered in the editor.

Plain Text The display unsignedInt Mode height of the text Height mode editor in characters. Plain Text The display unsignedInt Mode length of the text Length mode editor in characters. Prompt Read Only The text label for string the component. Indicates if the value can be changed. boolean

null

admin

no

textModeDisplayH eight

null

admin

no

textModeDisplayL ength

null false

admin admin

yes no

prompt readOnly

Rendered Indicates if the component is rendered. Required

boolean

true

user

no

rendered

Indicates if the string user must enter a value, and how that appears to the user. The display string height of the rich text editor in pixels or % of the container. The display string length of the rich text editor in pixels or % of the container. boolean Indicates if the bold, italic and underline icons boolean

no

admin

no

required

Rich Text Mode Height

null

admin

no

richTextModeDispl ayHeight

Rich Text Mode Length

null

admin

no

richTextModeDispl ayLength

showReq uired Style Icons

false true

null null

no no

showRequired styleGroup

225

OA Extension Component Reference

Name

Description are displayed.

Type

Default Personali Translat Value zable able null admin no

XML Attribute

Tip Message Appl Short Name Tip Message Name Tip Type

The application short name that owns the tip message.

string

tipMessageAppSh ortName

The name of the string tip message. The type of tip. string boolean

null

admin

no

tipMessageName

none false

admin admin

no no

tipType userCustomizable

User Indicates if a Personaliz user can ation personalize this component. Vertical Aligment View Attribute View Instance Vertical alignment

string

null null null

null null null

no no no

vAlign viewAttr viewName

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

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key 226

The character used for quick string keyboard navigation or

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value none null no primaryClientA ction shortDesc adminCustomiz able use comment styleClass dataType

activation. Action Type The action type to fire for the string component. It should be either "fireAction" or "none." string

Addition Additional help text. al Text

null true

admin admin

true no

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Class Data Type Comments Overrides the default CSS class.

jrad:attribu null teSetRef string string null null

null null admin

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function Destinati The destination URI. on URI

null

admin

no

invokeFunc

uriReferen null ce false

null null

no no

destination serverUnvalida ted

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Docume The name of the component jrad:refNa nt Name me 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. string

null null

null admin

no no

docName exportByViewA ttr extends

jrad:compo null nentRef

null

no

227

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null null null no no no rows id initSortSeq

Height ID Initial Sort Sequenc e

The display height of the Search item in characters. The unique name of this component.

unsignedIn null t Name null none

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thi rd.

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me Maximu m Length The number of characters a user can enter as search criteria for this field in a results-based (automatic) search.

null

admin admin

no no

longTipRegion maximumLengt h

unsignedIn null t Also supports Expression Language (EL) syntax. boolean boolean string string false false null

No Wrap Indicates if cell contents should be wrapped. Popup Indicates whether the popEnabled up is enabled. Popup ID Popup Render Event Prompt The unique name of the pop-up. Indicates on what action type the event is to be rendered for the pop-up. The text label for the component.

null admin admin

no no no no

cellNoWrapFor mat popupEnabled popupId popupRenderE vent prompt rendered required

onClic admin k null true admin user admin

string

yes no no

Rendere Indicates if the component is boolean d rendered. Require d Indicates if the user must enter a value and how that appears to the user. Three values are allowed: "yes", "no", "default". The Base Packages which are allowed to reuse this component.

ui:required no

Scope

jrad:scope .

null

no

scope

228

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value false false admin admin no no queryable selectiveSearc hCriteria

Search Allowed Selectiv e Search Criteria Sort Allowed

Indicates if the item will be boolean shown in the search panels. Indicates if the item is part of boolean 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 de scending. string Also supports Expression Language (EL) syntax. string

no

admin

no

sortState

Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message.

null

null

no

sortByViewAttr

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Total Value Indicates if an additional field should be displayed to show the total of this column. boolean

none

admin

no

false

user

no

totalValue

User Indicates if a user can boolean 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. string

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null

null

no

viewAttr

229

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value null true null null no no viewName warnAboutCha nges

View The name of the view object string Instance instance. Warn About Change s 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. The display length of the Search item in characters.

Width

unsignedIn null t optional null

null null

no no

columns xml:lang

xml:lang Identifies the language contained within this component.

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

Properties
Name Description Type Defaul Persona Transl XML Attribute t lizable atable Value null admin no accessKey

Access Key Action 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." string

none

null

no

primaryClientA ction

Addition Additional help text. al Text 230

null

admin

yes

shortDesc

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value true admin no adminCustomiz able use comment styleClass dataType

Admin Indicates if an Administrator boolean Personal can personalize this ization component. Attribute The attribute set for the Set component. Comme nts CSS Class Data Type Comments Overrides the default CSS class.

jrad:attribu null teSetRef string string null null

null null admin

no no no no

The type of data. The legal string values are VARCHAR2, DATE, DATET IME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

VARC null HAR2

Destinati The function to invoke. on Function

null

admin

no

invokeFunc

Disable Indicates if validation should boolean Server not occur on the business Side tier during a form submit. Validatio n Disabled Indicates if the element is disabled. boolean

false

null

no

serverUnvalida ted

false null null

null null admin

no no no

disabled docName exportByViewA ttr extends

Docume The name of the component jrad:refNa nt Name me 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 ID The display height in characters. The unique name of this component. string

jrad:compo null nentRef

null

no

unsignedIn 1 t Name string null none

null null null

no no no

rows id initSortSeq

Initial Indicates the initial sort Sort sequence for each search. Sequenc The legal values are

231

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value

e Initial Value Length

none, first, second, and thi rd. The initial (default) value of the item. The display length in characters. string null admin admin admin null true no no no translatableDef aultValue columns longTipRegion maximumLengt h

unsignedIn null t null

Long Tip The fully-qualified reference jrad:refNa Region to the long tip region. me Maximu m Length The maximum number of characters per line that can be entered.

unsignedIn null t Also supports Expression Language (EL) syntax.

No Wrap Indicates if cell contents should be wrapped. Prompt Read Only The text label for the component.

boolean string

false null false true

null admin admin user admin

no yes no no no

cellNoWrapFor mat prompt readOnly rendered required

Indicates if the value can be boolean changed.

Rendere Indicates if the component is boolean d rendered. Require d Indicates if the user must enter a value and how that appears to the user. Three values are allowed: "yes", "no", and "validaterOnly". The Base Packages which are allowed to reuse this component.

ui:required no

Scope

jrad:scope .

null

no

scope

Search Allowed Secret Selectiv e Search 232

Indicates if the item will be boolean shown in the search panels. Indicates if the value is visually concealed. boolean

false false false

admin no admin

no no no

queryable secret selectiveSearc hCriteria

Indicates if the item is part of boolean a group of items, one of which must be included in

Item Styles

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value false no null admin no no showRequired sortState

Criteria showRe quired Sort Allowed

the search. boolean Indicates if the user can sort this column. The legal values are yes, no, ascending, and de scending. string Also supports Expression Language (EL) syntax. string null null no sortByViewAttr

Sort By The alternate view attribute View name for use when sorting. Attribute Tip Messag e Appl Short Name Tip Messag e Name The application short name that owns the tip message.

string

null

admin

no

tipMessageApp ShortName

The name of the tip message.

string

null

admin

no

tipMessageNa me tipType

Tip Type The type of tip. The legal string values are dateFormat, longMessage, shortTip, and none. Total Value Indicates if an additional field should be displayed to show the total of this column. boolean

none

admin

no

false

user

no

totalValue

User Indicates if a user can boolean 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. string

false

admin

no

userCustomiza ble vAlign

null

null

no

string

null null

null null

no no

viewAttr viewName

View The name of the view object string Instance instance.

233

OA Extension Component Reference

Name

Description

Type

Defaul Persona Transl XML Attribute t lizable atable Value true null no warnAboutCha nges

Warn About Change s

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. optional

xml:lang Identifies the language contained within this component.

null

null

no

xml:lang

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 boolean Defaul Personal Transla t Value izable table true admin no XML Attribute adminCusto mizable use comment styleClass dataType

Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

jrad:attribut null eSetRef string string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type 234 Overrides the default CSS class. The type of data. The legal values are

Item Styles

Name

Description VARCHAR2, DATE, DATETI ME, BIGDECIMAL, NUMBER, BOOLEAN, and C LOB.

Type

Defaul Personal Transla t Value izable table

XML Attribute

Docume The name of the component nt Name Export View Attribute Extends The alternate view attribute for use when exporting. A reference to another component that creates a different instance of that component at runtime. The unique name of this component.

jrad:refNam null e string null

null admin

no no

docName exportByVi ewAttr extends

jrad:compo null nentRef

null

no

ID Initial Sort Sequenc e

Name

null none

null null

no no

id initSortSeq

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thir d. boolean string boolean jrad:scope

No Wrap Indicates if cell contents should be wrapped. Prompt The text label for the component.

false null true .

null admin user null

no true no no

cellNoWrap Format prompt rendered scope

Rendere Indicates if the component is d rendered. Scope The Base Packages which are allowed to reuse this 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 des cending.

Search Allowed Sort Allowed

boolean string Also supports Expression Language (EL) syntax. string

false no

admin admin

no no

queryable sortState

Sort By View Attribute

The alternate view attribute name for use when sorting.

null

null

no

sortByView Attr

235

OA Extension Component Reference

Name Text Total Value

Description The text label for the component.

Type string

Defaul Personal Transla t Value izable table null false admin user yes no

XML Attribute text totalValue

Indicates if an additional field boolean should be displayed to show the total of this column. boolean

User Indicates if a user can Personali personalize this component. zation View Attribute The name of the view attribute.

false

admin

no

userCusto mizable viewAttr viewName xml:lang

string string optional

null null null

null null null

no no no

View The name of the view object Instance instance. xml:lang Identifies the language contained within this component.

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

Properties
Name Description Type Defa Personali Translat ult zable able Valu e null null no XML Attribute

Action Type

The action type to fire for the component. It should be either "fireAction", "firePartialAction" or "none."

string

primaryClient Action

Additional Additional help text. 236

string

null

admin

yes

shortDesc

Item Styles

Name

Description

Type

Defa Personali Translat ult zable able Valu e true admin no

XML Attribute

Text Admin Indicates if an Personaliz Administrator can ation personalize this component. Attribute Set Comment s CSS Class Disable Server Side Validation boolean adminCustom izable

The attribute set for the jrad:attribute component. SetRef Comments Overrides the default CSS class. string string

null null null

null null admin

no no no no

use comment styleClass serverUnvalid ated

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

false null

Document The name of the Name component Extends

jrad:refName null

null null

no no

docName extends

A reference to another jrad:compone null component that creates ntRef a different instance of that component at runtime.

Horizontal Horizontal alignment. string Alignment The legal values are center, left, right, start , and end. ID The unique name of this component. Name

start null

no

hAlign

null true .

null user null

no no no

id rendered scope

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

Text xml:lang

string optional

null null

admin null

yes no

text xml:lang

237

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 Type Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

adminCustomiz able

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments Content Type Comments string null Indicates anySimpleType OBIE the type of E content to

null

no

use

null admin

no no

comment richContentType

238

Item Styles

Name

Descriptio n embed.

Type

Defau Personaliza Translata lt ble ble Value null admin no

XML Attribute

Destination Function

The anyURI developer name of the FND function used to secure the embedded content or widget. The display height in pixels. string

invokeFunc

Height

null

admin

no

height

ID

The Name unique name of this component . The display name of the content. string

null

null

no

id

Name

null

admin

yes

name

Parameters

The string parameter s that can be passed to the embedded content as a list of commaseparated, namevalue pairs. The name string of the view object instance.

null

admin

yes

richParameters

View Instance

null

null

no

viewName

239

OA Extension Component Reference

Name

Descriptio n Indicates string the width in pixels or as a percentag e (if % sign included).

Type

Defau Personaliza Translata lt ble ble Value null null no

XML Attribute

Width

width

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 Description Type string boolean Default Personali Translat Value zable able null true admin admin yes no XML Attribute shortDesc adminCustomizabl e

Additional Additional help Text text. Admin Indicates if an Personaliz Administrator ation can personalize this component. 240

Item Styles

Name

Description

Type boolean

Default Personali Translat Value zable able false null no

XML Attribute alignmentIcons

Alignment Indicates if the Icons left, center, and right alignment icons are displayed. Attribute Set Bullet Icons

The attribute set jrad:attribute null for the SetRef component. Indicates if the bullet icons are displayed. boolean true

null

no

use

null

no

bulletIcons

ClickThru The URI string Destinatio launched from n URI the "Click Thru Destination" icon. If empty, no icon is shown. Comment Comments s Create Hyperlink Icon string

null

null

no

clickThruDestinatio nUri

null false

null null

no no

comment hyperlinkIcon

Indicates if the boolean create hyperlink icon is displayed.

Data Type The type of data. string The legal values are VARCHAR2, an d CLOB. Edit Icons Indicates if the cut, copy and paste icons are displayed. Extends boolean

VARCH null AR2

no

dataType

true

null

no

editIcons

A reference to jrad:compon null another entRef component that creates a different instance of that component at runtime. Indicates if the font bar is displayed. The URI boolean false

null

no

extends

Font Bar

null

no

fontBar

Image

string

null

null

no

imageUploadUri 241

OA Extension Component Reference

Name Upload URl

Description launched from the insert image icon. If empty, no icon is shown.

Type

Default Personali Translat Value zable able

XML Attribute

Indentatio Indicates if the boolean n Icons indentation icons are displayed. Initial Value Long Tip Region The initial string (default) value of the item. The fullyqualified reference to the long tip region. string

false

null

no

indentationIcons

null

admin

yes

translatableDefault Value longTipRegion

null

admin

no

Maximum The maximum Length number of characters that can be entered in the editor.

unsignedInt Also supports Expression Language (EL) syntax.

null

null

no

maximumLength

Plain Text The display unsignedInt Mode height of the text Height mode editor in characters. Plain Text The display unsignedInt Mode length of the text Length mode editor in characters. Read Only Indicates if the value can be changed. boolean

null

null

no

textModeDisplayH eight

null

null

no

textModeDisplayL ength

false

admin

no

readOnly

Rendered Indicates if the component is rendered. Required

boolean

true

user

no

rendered

Indicates if the string user must enter a value, and how that appears to the user. The display string height of the rich text editor in

no

admin

no

required

Rich Text Mode Height 242

null

null

no

richTextModeDispl ayHeight

Item Styles

Name

Description pixels or % of the container.

Type

Default Personali Translat Value zable able

XML Attribute

Rich Text Mode Length

The display string length of the rich text editor in pixels or % of the container. boolean Indicates if the bold, italic and underline icons are displayed. The application short name that owns the tip message. boolean

null

null

no

richTextModeDispl ayLength

showReq uired Style Icons

false true

null null

no no

showRequired styleIcons

Tip Message Appl Short Name Tip Message Name Tip Type Vertical Aligment View Attribute View Instance

string

null

admin

no

tipMessageAppSh ortName

The name of the string tip message. The type of tip. Vertical alignment string string

null

admin

no

tipMessageName

none null null null

admin null null null

no no no no

tipType vAlign viewAttr viewName

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

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 243

OA Extension Component Reference

Properties
Name Action Type Description Type Defaul Personal Transla t Value izable table none null no XML Attribute primaryClie ntAction

The action type to fire for the string component. It should be either "fireAction", "firePartialAction" or "none." string boolean

Additiona Additional help text. l Text Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

null true

admin admin

yes no

shortDesc adminCusto mizable use comment styleClass dataType

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

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

Destinati The function to invoke. on Function Disable Indicates if validation should Client not occur on the web tier Side during a form submit. Validatio n

null

admin

no

invokeFunc

boolean

false

null

no

unvalidated

Disable Indicates if validation should boolean 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 244 boolean

false

null

no

serverUnval idated

false

null null

no no

disabled docName

jrad:refNam null e

Item Styles

Name Extends

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

Type

Defaul Personal Transla t Value izable table null no

XML Attribute extends

jrad:compo null nentRef

Horizont al Alignmen t ID

Horizontal alignment. The string legal values are center, left, right, start, and e nd. The unique name of this component. Name boolean

start

null

no

hAlign

null false true .

null null user null

no no no no

id cellNoWrap Format rendered scope

No Wrap Indicates if cell contents should be wrapped.

Rendere Indicates if the component is boolean d rendered. Scope The Base Packages which are allowed to reuse this component. The text label for the component. jrad:scope

Text

string boolean

null false

admin admin

yes no

text userCustom izable

User Indicates if a user can Personali personalize this component. zation

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

Properties
Name Descriptio n Type Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin

Indicates if boolean

adminCustomiz 245

OA Extension Component Reference

Name

Descriptio n

Type

Defau Personaliza Translata lt ble ble Value

XML Attribute

Personalizati an on Administra tor can personaliz e this component . Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments CSS Class Comments string Overrides string the default CSS class. The name jrad:refName of the component null null null no

able

use

null admin

no no

comment styleClass

Document Name Extends

null

null

no

docName

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime. The Name unique name of this component . Indicates if boolean the component is rendered. The Base Packages jrad:scope null

null

no

extends

ID

null

no

id

Rendered

true

user

no

rendered

Scope

null

no

scope

246

Item Styles

Name

Descriptio n which are allowed to reuse this component .

Type

Defau Personaliza Translata lt ble ble Value

XML Attribute

xml:lang

Identifies optional the language contained within this component .

null

null

no

xml:lang

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 Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component . Attribute Set The attribute set for the

adminCustomiz able

jrad:attributeSet null Ref

null

no

use

247

OA Extension Component Reference

Name

Descriptio n component .

Type

Defau Personaliza Translata lt ble ble Value

XML Attribute

Comments Extends

Comments string

null

null null

no no

comment extends

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime. The Name unique name of this component . Indicates if boolean the component is rendered. The relative servlet URI. uriReference null

ID

null

no

id

Rendered

true

user

no

rendered

Source URI

null

admin

no

source

xml:lang

Identifies optional the language contained within this component .

null

null

no

xml:lang

spacer
Description
248

Item Styles 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 Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizati an on Administra tor can personaliz e this component .

adminCustomiz able

Attribute Set The jrad:attributeSet null attribute Ref set for the component . Comments CSS Class Comments string Overrides string the default CSS class. The name jrad:refName of the component null null

null

no

use

null admin

no no

comment styleClass

Document Name Extends

null

null

no

docName

A jrad:component null reference Ref to another component that creates a different instance of that component at runtime. The display height in pixels. The string 1

null

no

extends

Height

null

no

height

ID

Name

null

null

no

id 249

OA Extension Component Reference

Name

Descriptio n unique name of this component .

Type

Defau Personaliza Translata lt ble ble Value

XML Attribute

Rendered

Indicates if boolean the component is rendered. The Base jrad:scope Packages which are allowed to reuse this component . Indicates the width in pixels. string

true

user

no

rendered

Scope

null

no

scope

Width

null

null

no

width

xml:lang

Identifies optional the language contained within this component .

null

null

no

xml:lang

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

250

Item Styles

Properties
Name Action Type Description The action type to fire for the component. It should be either "fireAction" or "none." Type string Default Personal Transla XML Attribute Value izable table none null no primaryClientA ction

Admin Indicates if an Personali Administrator can zation personalize this component. Attribute Set The attribute set for the component.

boolean

true

admin

no

adminCustomiz able

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

use comment styleClass dataType

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

The type of data. The string legal values are VARCHAR2, DATE, DA TETIME, BIGDECIMAL, NUMBER, BOOLEAN, and CLOB. string

Destinati The function to invoke. on Function Destinati The destination URI. on URI Disable Server Side Validatio n Export View Attribute Extends Indicates if validation should not occur on the business tier during a form submit. The alternate view attribute for use when exporting. A reference to another component that creates a different instance of that component at runtime.

null

admin

no

invokeFunc

uriReferenc null e boolean false

null null

no no

destination serverUnvalida ted

string

null

admin

no

exportByViewA ttr extends

jrad:compo nentRef

null

null

no

ID

The unique name of this Name

null

null

no

id 251

OA Extension Component Reference

Name

Description component.

Type

Default Personal Transla XML Attribute Value izable table none null no initSortSeq

Initial Sort Sequenc e

Indicates the initial sort string sequence for each search. The legal values are none, first, second, an d third. string

Message The application short Appl name that owns the Short message. Name Message The name of the Name message.

null

admin

no

messageAppS hortName

string

null false null false

admin null admin admin

no no true no

messageName cellNoWrapFor mat prompt queryable

No Wrap Indicates if cell contents boolean should be wrapped. Prompt Search Allowed Sort Allowed 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, an d descending. string boolean

string Also supports Expression Language (EL) syntax.

no

admin

no

sortState

Total Value

Indicates if an additional boolean field should be displayed to show the total of this column. boolean

false

user

no

totalValue

User Indicates if a user can Personali personalize this zation component.

false

admin

no

userCustomiza ble warnAboutCha nges

Warn Warns the user if there boolean About 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.

true

null

no

252

Item Styles

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

Properties
Name Description Type string boolean Defaul Personal Transla t Value izable table null true admin admin yes no XML Attribute shortDesc adminCusto mizable use comment styleClass dataType

Additiona Additional help text. l Text Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

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

Destinati The function to invoke. on Function Destinati The destination URI. on URI Docume The name of the component nt Name Extends A reference to another component that creates a different instance of that

null

admin

no

invokeFunc

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

null null null

no no no

destination docName extends

253

OA Extension Component Reference

Name

Description component at runtime.

Type

Defaul Personal Transla t Value izable table null none null null no no

XML Attribute id initSortSeq

ID Initial Sort Sequenc e

The unique name of this component.

Name

Indicates the initial sort string sequence for each search. The legal values are none, first, second, and thir d. boolean jrad:scope

Rendere Indicates if the component is d rendered. Scope The Base Packages which are allowed to reuse this component. Indicates if the user can sort this column. The legal values are yes, no, ascending, and des cending.

null .

user null

no no

rendered scope

Sort Allowed

string Also supports Expression Language (EL) syntax. string

no

admin

no

sortState

Sort By View Attribute Text Total Value View Attribute

The alternate view attribute name for use when sorting. The text label for the component.

null

null

no

sortByView Attr text totalValue

string

null false

admin user

yes no

Indicates if an additional field boolean should be displayed to show the total of this column. The name of the view attribute. string string optional

null null null

null null null

no no no

viewAttr viewName xml:lang

View The name of the view object Instance instance. xml:lang Identifies the language contained within this component.

submitButton
254

Item Styles

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 Action Type Description Type Defaul Personal Transla t Value izable table null admin no XML Attribute accessKey

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." string boolean

none

null

no

primaryClie ntAction

Additiona Additional help text. l Text Admin Indicates if an Administrator Personali can personalize this zation component. Attribute Set The attribute set for the component.

null true

admin admin

yes no

shortDesc adminCusto mizable use comment styleClass dataType

jrad:attribut null eSetRef string string null null VARC HAR2

null null admin null

no no no no

Commen Comments ts CSS Class Data Type Overrides the default CSS class.

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

Destinati The function to invoke. on Function Disable Indicates if validation should Client not occur on the web tier Side during a form submit. Validatio

null

admin

no

invokeFunc

boolean

false

null

no

unvalidated

255

OA Extension Component Reference

n Disable Indicates if validation should boolean 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 Event Extends Name of the event. A reference to another component that creates a different instance of that component at runtime. boolean false null no serverUnval idated

false

null null null null

no no no no

disabled docName event extends

jrad:refNam null e string null jrad:compo null nentRef

Horizont al Alignmen t ID

Horizontal alignment. The string legal values are center, left, right, start, and e nd. The unique name of this component. Name boolean string

start

null

no

hAlign

null false null true .

null null admin user null

no no true no no

id cellNoWrap Format prompt rendered scope

No Wrap Indicates if cell contents should be wrapped. Prompt The text label for the component.

Rendere Indicates if the component is boolean d rendered. Scope The Base Packages which are allowed to reuse this component. The text label for the component. jrad:scope

Text

string boolean

null false

admin admin

yes no

text userCustom izable viewName warnAbout Changes

User Indicates if a user can Personali personalize this component. zation 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 256

string boolean

null false

null null

no no

Item Styles

action. xml:lang Identifies the language contained within this component. optional null null no xml:lang

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 Defa Personaliz Translata ult able ble Value true admin no XML Attribute

Admin Indicates boolean Personaliza if an tion Administr ator can personaliz e this compone nt. Attribute Set

adminCustomizable

The jrad:attributeSe null attribute tRef set for the compone nt. Comment string s Overrides string the default CSS null null

null

no

use

Comments CSS Class

null admin

no no

comment styleClass

257

OA Extension Component Reference

Name

Descripti on class.

Type

Defa Personaliz Translata ult able ble Value null null no

XML Attribute

Document Name

The name jrad:refName of the compone nt

docName

Extends

A jrad:componen null reference tRef to another compone nt that creates a different instance of that compone nt at runtime. The unique name of this compone nt. Name null

null

no

extends

ID

null

no

id

Rendered

Indicates boolean if the compone nt is rendered. The Base jrad:scope Packages which are allowed to reuse this compone nt. The text label for the compone nt. string

true

user

no

rendered

Scope

null

no

scope

Text

null

admin

true

text

Tip Message Appl Short 258

The string applicatio n short

null

admin

no

tipMessageAppShort Name

Item Styles

Name

Descripti on name that owns the tip message.

Type

Defa Personaliz Translata ult able ble Value

XML Attribute

Name

Tip Message Name xml:lang

The name string of the tip message. Identifies optional the language contained within this compone nt.

null

admin

no

tipMessageName

null

null

no

xml:lang

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 Type Defau Personaliza Translata lt ble ble Value true admin no XML Attribute

Admin Indicates if boolean Personalizat an ion Administrator can personalize this component.

adminCustomiz able

Attribute Set The attribute jrad:attributeSet null

null

no

use 259

OA Extension Component Reference

Name

Description

Type

Defau Personaliza Translata lt ble ble Value

XML Attribute

set for the component. Comments Extends Comments A reference to another component that creates a different instance of that component at runtime. The unique name of this component.

Ref string null null null no no comment extends

jrad:component null Ref

ID

Name

null

null

no

id

Rendered

Indicates if boolean the component is rendered.

true

user

no

rendered

Source URI The uriReference relative/absol ute URI. xml:lang Identifies the optional language contained within this component.

null

admin

no

source

null

null

no

xml:lang

260

Você também pode gostar