Download - OA Component

Transcript
  • 5/26/2018 OA Component

    1/266

    OA Component Reference

    Release 12.2

    July 2013

  • 5/26/2018 OA Component

    2/266

  • 5/26/2018 OA Component

    3/266

    iii

    Table of Contents

    OACOMPONENT 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

  • 5/26/2018 OA Component

    4/266

    OA Component Reference

    iv

    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

  • 5/26/2018 OA Component

    5/266

    Table of Contents

    v

    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

  • 5/26/2018 OA Component

    6/266

    OA Component Reference

    vi

    richTextEditor ........................................................................................................................ 240

    selectionButton ...................................................................................................................... 243

    separator ............................................................................................................................... 245

    servletInclude ........................................................................................................................ 247

    spacer .................................................................................................................................... 248

    staticStyledText ..................................................................................................................... 250

    styledText .............................................................................................................................. 253

    submitButton ......................................................................................................................... 254

    tip ........................................................................................................................................... 257

    urlInclude ............................................................................................................................... 259

  • 5/26/2018 OA Component

    7/266

    1

    OA Component Reference

    package

    Description

    A package file contains attributeSets. AttributeSets are a collection of properties that can be re-used in OA components.

    Properties

    Name Descr iption Type DefaultValue

    Personalizable Translatable XMLAt tr ibute

    Comments Comments string null null no comment

    DocumentationComment

    Formattedtext for usewithJavadoc.

    string fromtemplatefile

    null no notapplicable

    File Version The versionof the file.

    string null null no file-version

    OA ExtensionVersion

    The OracleApplicationsExtensionversion with

    which thefile wascreated orupdated.

    jrad:version null null no version

    page

    Description

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

    Properties

    Name Descriptio Type Defaul Personalizabl Translatabl XML

  • 5/26/2018 OA Component

    8/266

    OA Extension Component Reference

    2

    n t Value e e Attr ibute

    AttributeSet

    Theattribute setfor the

    component.

    jrad:attributeSetRef

    null null no use

    Comments

    Comments. string null null no comment

    FileVersion

    The versionof the file.

    string null null no file-version

    OAExtensionVersion

    The OracleApplicationsExtensionversion withwhich thefile wascreated orupdated.

    jrad:version null null no version

    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 OAcomponent, including regions, items, and other attribute sets. They are designed to facilitate thereuse of these components throughout Oracle Applications, which yields a significant costsavings to both Oracle and its customers.

    In general terms, attribute sets are organized into OA component packages (individual XMLpackage 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; itincludes the union of all properties available on all components.

  • 5/26/2018 OA Component

    9/266

    OA Component Reference

    3

    Name Description Type DefaultValue

    Personalizable Translatable XMLAt tr ibute

    DocumentName

    The name ofthe component

    jrad:refName null null no docName

    Scope The BasePackages whichare allowed toreuse thiscomponent.

    jrad:scope .(public)

    null no scope

  • 5/26/2018 OA Component

    10/266

    OA Extension Component Reference

    4

  • 5/26/2018 OA Component

    11/266

    5

    Region Styles

    advancedSearch

    Description

    The advancedSearch region extends UIX's StackLayoutBean. This is a very complicated layoutused for rendering search pages which allow an end-user to specify a criteria for performing asearch.

    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, andbuttonBar. The staticText grouping contains a set of messageStyledText beans. The criteragrouping will contain criteriaRow elements. The buttonBar grouping will contain a set of submitbeans. The metadata for criteriaRow shows only two elements -- a messageStyledText elementfor displaying the label, and an input (messageTextInput, messageLovInput, messageChoice)element. Internally, the framework creates a messageChoice bean that gets rendered betweenthe 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 attributesspecific to this region style are required. See the section onstackLayoutfor a list of attributesand child elements available for the stackLayout element.

    Child ElementsIn addition to inheriting the named children defined for the OA Extension, the extension will havethe following groupings:

    Name Description Type DefaultValue

    Personalizable Translatable XML Att ribute

    Intermedia Indicates if the boolean false null no intermediaStyle

  • 5/26/2018 OA Component

    12/266

    OA Extension Component Reference

    6

    Style advancedsearch will useintermediastyle queries.

    Element Children

    Name Quantity Descr iption

    buttonBar 0 through 1 This element contains a group of buttons that are rendered at thebottom of the search region. A developer can add as many buttonsinside 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 (bothsingle and multiple), sorting, record navigation, totaling and detail-disclosure. advancedTablealso provides declarative support for grouping of column headers. This includes support forcolumn formats, column header, column header data and column header formats.

    Support for both column bean and column group beans is provided. These are container beanswith the ability to hold other regions and items. Support for formValue beans is also provided.See the section onformValuefor a list of attributes and child elements available on theformValue element.

    advancedTable supports column beans and columnGroup beans only as indexed children; themix of both is not supported.

    Declarative specification is possible for the following advancedTablefeatures/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

  • 5/26/2018 OA Component

    13/266

    Region Styles

    7

    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, thenumber 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 Accessibi li ty Support

    To support accessibility for screen readers, you must specify a column in an advanced table asa row header. Every row in the table must refer to a column as the row header that uniquelyidentifies 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 ReaderOptimized.

    The underlying UIX or acl e. cabo. ui . beans. t abl e. Tabl eBeansupports accessibility by

    defaulting a table's first column as the row header. However, you can set a different column asthe row header, especially if a user is likely to personalize the table by turning off rendering ofthe 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, specifya column ID (String) for the Row Header Col umnproperty (XML attribute: r owheadercol ) of

    the advanced table region.

    To programmatically set a column as a row header, use the following API on

    OAAdvancedTabl eBean:

    set RowHeader Col umn( ) ;

    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 Default Value

    Personalizable

    Translatable

    XML Attribute

    Additional Additional help string null admin yes shortDesc

  • 5/26/2018 OA Component

    14/266

    OA Extension Component Reference

    8

    Text text.

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplicationmodule.

    string null null no amDefName

    AMInstance

    The instancename of anapplicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute setfor thecomponent.

    jrad:attributeSetRef

    null null no use

    BandingInterval

    The number ofrows or columnsto group with thesame shade.

    unsignedInt 1 user no bandingInterval

    BandingType

    The type ofbanding on thetable.

    ui:tableBandingRule

    noBanding

    user no tableBanding

    ChildView

    Attribute

    The name of thechild viewattribute.

    string null null no childViewAttrName

    Comments

    Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    DetailView

    Attribute

    The view attributethat determines ifthat particular rowis to be stampedwith the detailchild.

    string null null no detailViewAttr

    Dirty RowSortEnabled

    Indicates ifmiddle-tier sortshould beperformed on thetable.

    boolean false null no dirtyRowSortEnabled

    DisableClientSide

    Indicates ifvalidation shouldnot occur on the

    boolean false null no unvalidated

  • 5/26/2018 OA Component

    15/266

    Region Styles

    9

    Validation web tier during aform submit.

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    DocumentationComment

    Formatted text foruse with Javadoc.

    string fromtemplate file

    null no not applicable

    EmptyTableText

    The text to displayinside an emptytable.

    string null null no alternateText

    EnableColumnReorder

    Enable columns tobe reordered byend users

    boolean true admin no colReorderEnabled

    EnableColumn

    Resize

    Enable columns tobe resized by end

    users.

    boolean true admin no colResizeEnabled

    EnableDetach

    Enable the tableto be detachedand maximized inthe browser.

    boolean true admin no detachEnabled

    EnableHorizontalScroll

    Enable horizontalscroll bars in thetable.

    boolean true admin no horizontalScrollEnabled

    Extends A reference toanothercomponent that

    creates a differentinstance of thatcomponent atruntime.

    jrad:componentRef

    null null no extends

    FileVersion

    The version of thefile.

    string null null no file-version

    HelpTarget

    The target namefor the pageonline help.

    string null null no helpTarget

    HelpTarget

    Appl ShortName

    This applicationwill be used toconstruct URI ofthe "help" icon inthe global menuof the page.Thismakes the helppages from theother applicationsreferenceable.

    string null null no helpTargetAppShortName

  • 5/26/2018 OA Component

    16/266

    OA Extension Component Reference

    10

    ID The unique nameof this component.

    Name null null no id

    OAExtensionVersion

    The OracleApplicationsExtension version

    with which the filewas created orupdated.

    jrad:version null null no version

    PersonalizationLabel

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to be

    posted.

    boolean false null no postDefault

    RecordHistoryEnabled

    Indicates ifRecord Historyfeature isenabled.

    boolean false admin no recordHistoryEnabled

    RecordsDisplayed

    The maximumnumber of rows todisplay.

    unsignedInt 10 admin no blockSize

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    RowHeaderCol

    Indicates if Scopeattribute is to beadded to Table.

    string null admin no rowheadercol

    RowHeaderView

    Attribute

    The view attributefor the rowheader.

    string null null no rowHeaderViewAttr

    Scope The BasePackages whichare allowed to

    reuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines thesecurity modeused to securethe region. If setto selfSecured it isthe developer'sresponsibility to

    string standard

    null no securityMode

  • 5/26/2018 OA Component

    17/266

    Region Styles

    11

    handle securityvalidation. Thelegal values arestandard, and selfSecured.

    Standalone

    Indicates if thisregion can berendered on itsown.

    boolean false null no standalone

    Text The text label forthe component.

    string null admin no text

    UserPersonalization

    Indicates if a usercan personalizethis component.

    boolean false admin no userCustomizable

    ViewInstance

    The name of theview object

    instance.

    string null null no viewName

    View LinkInstance

    The name of theView LinkInstanceestablishingmaster-detailrelationshipbetween outerand innerrepeatingcontainers.

    string null null no viewLinkName

    Width Indicates thewidth in pixels oras a percentage(if the % sign isincluded).

    string null null no width

    xml:lang Identifies thelanguagecontained withinthis component.

    optional null null no xml:lang

    Element Children

    Name Quantity Description

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

    footer 0 through 1 Node used to render the table footer.

    tableActions 0 through 1 Component used for performing table actions that are independentof row selection.

  • 5/26/2018 OA Component

    18/266

    OA Extension Component Reference

    12

    tableSelection 0 through 1 SingleSelectionBean or MultipleSelectionBean to render with thetable.

    columnGroup

    Name Description

    Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminPersonalization

    Indicates ifan

    Administrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    Attribute Set Theattributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments Comments string null null no comment

    DocumentName

    The nameof thecomponent

    jrad:refName null null no docName

    Extends Areferenceto anothercomponentthatcreates adifferentinstance ofthatcomponentat runtime.

    jrad:componentRef

    null null no extends

    Rendered Indicates if

    thecomponentisrendered.

    boolean null user no rendered

    Scope The BasePackageswhich areallowed to

    jrad:scope . null no scope

  • 5/26/2018 OA Component

    19/266

    Region Styles

    13

    reuse thiscomponent.

    UserPersonalizati

    on

    Indicates ifa user can

    personalize thiscomponent. Valid onlywhen usedin tableregion.

    boolean false admin no userCustomizable

    xml:lang Identifiesthelanguagecontainedwithin thiscomponent.

    optional null null no xml:lang

    Column

    Name Descr iption Type DefaultValue

    Personalizable

    Translatable

    XMLAt tr ibute

    AdminPersonalization

    Indicates if anAdministratorcan

    personalizethiscomponent.

    boolean true admin no adminCustomizable

    Alignment columnDataFormat

    ui:tableColumnDataFormat

    textFormat

    user no columnDataFormat

    AttributeSet

    The attributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    BandingShade

    The shade ofbanding usedfor the column.The legalvalues arenone, dark, and light.

    string none user no bandingShade

    Comments Comments string null null no comment

    DocumentName

    The name ofthe component

    jrad:refName null null no docName

  • 5/26/2018 OA Component

    20/266

    OA Extension Component Reference

    14

    Extends A reference toanothercomponentthat creates adifferentinstance ofthatcomponent atruntime.

    jrad:componentRef null null no extends

    GridDisplayed

    Indicates if agridline beforethe columnshould appear.

    boolean true user no displayGrid

    No Wrap Indicates if cellcontentsshould bewrapped. Validonly whenused in tableregion.

    boolean false user no cellNoWrapFormat

    Rendered Indicates if thecomponent isrendered.

    boolean null user no rendered

    Scope The BasePackageswhich areallowed toreuse this

    component.

    jrad:scope . null no scope

    TotalValue

    Indicates if anadditional fieldshould bedisplayed toshow the totalof this column.

    boolean false user no totalValue

    UserPersonalization

    Indicates if auser canpersonalizethis

    component.Valid onlywhen used intable region.

    boolean false admin no userCustomizable

    Width column width. string null user no width

    xml:lang Identifies thelanguage

    optional null null no xml:lang

  • 5/26/2018 OA Component

    21/266

    Region Styles

    15

    containedwithin thiscomponent.

    sortableHeader

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XMLAt tr ibute

    Abbreviation

    The value for thisproperty acts as anabbreviation for thecolumn header text, andis read whenever a valuefor the column is read

    out. Use this property toavoid long tableheadings being readrepetitively by a screenreader.

    string null null no abbreviation

    AdditionalText

    Additional help text. string null admin yes shortDesc

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AttributeSet

    The attribute set for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments

    Comments string null null no comment

    CSSClass

    Overrides the defaultCSS class.

    string null admin no styleClass

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    Extends A reference to anothercomponent that createsa different instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    Initial SortSequence

    Indicates the initial sortsequence for eachsearch. The legal valuesarenone, first, second, and t

    string none null no initSortSeq

  • 5/26/2018 OA Component

    22/266

    OA Extension Component Reference

    16

    hird.

    No Wrap Indicates if cell contentsshould be wrapped. Validonly when used in tableregion.

    boolean false null no cellNoWrapFormat

    Prompt The text label for thecomponent.

    string null admin yes prompt

    Rendered Indicates if thecomponent is rendered.

    boolean null user no rendered

    RequiredIndicator

    Indicates if the requiredindicator is shown on thecolumn header. Validvalues are "no," "uiOnly,""validaterOnly" and"yes."

    ui:required no admin no required

    Scope The Base Packageswhich are allowed toreuse this component.

    jrad:scope . null no scope

    SortAllowed

    Indicates if the user cansort this column. Validonly when used in tableregion. The legal valuesareyes, no, ascending, anddescending.

    string no admin no sortState

    Sort By

    ViewAttribute

    The alternate view

    attribute name for usewhen sorting. Valid onlywhen used in tableregion.

    string null user no sortByViewAt

    tr

    UserPersonalization

    Indicates if a user canpersonalize thiscomponent. Valid onlywhen used in tableregion.

    boolean false admin no userCustomizable

    xml:lang Identifies the languagecontained within this

    component.

    optional null null no xml:lang

    tableFooter

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XMLAt tr ibute

  • 5/26/2018 OA Component

    23/266

    Region Styles

    17

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    Attribute

    Set

    The attribute set for

    the component.

    jrad:attributeS

    etRef

    null null no use

    Comments Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    Extends A reference toanother componentthat creates a

    different instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    Personalization Label

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to be

    posted.

    boolean false null no postDefault

    Rendered Indicates if thecomponent isrendered.

    boolean null user no rendered

    Scope The BasePackages whichare allowed toreuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used to

    secure the region. Ifset to selfSecured itis the developer'sresponsibility tohandle securityvalidation. Thelegal values arestandard, and selfSecured.

    string standard

    null no securityMode

  • 5/26/2018 OA Component

    24/266

    OA Extension Component Reference

    18

    xml:lang Identifies thelanguage containedwithin thiscomponent.

    optional null null no xml:lang

    addTableRow

    Name Description

    Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Add RowsLabel

    Overridesthe defaulttext of the

    Add Rowsbutton.

    string null admin true text

    AdditionalText Additionalhelp text. string null admin yes shortDesc

    AdminPersonalization

    Indicates ifan

    Administrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    Attribute Set Theattributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments Comments string null null no comment

    DocumentName

    The nameof thecomponent

    jrad:refName null null no docName

    Extends Areferenceto another

    componentthatcreates adifferentinstance ofthatcomponentat runtime.

    jrad:componentRef

    null null no extends

  • 5/26/2018 OA Component

    25/266

    Region Styles

    19

    Insert RowsAutomatically

    Indicates ifrows willbe addedautomatically whenthe AddRowsbutton ispressed,or if thedevelopermustrespond tothe event.

    boolean true null no autoInsertion

    Rendered Indicates ifthecomponent

    isrendered.

    boolean null user no rendered

    Rows to Add Thenumber ofrows toadd whenthe buttonis pressed.

    unsignedInt null admin no rows

    Scope The BasePackageswhich are

    allowed toreuse thiscomponent.

    jrad:scope . null no scope

    xml:lang Identifiesthelanguagecontainedwithin thiscomponent.

    optional null null no xml:lang

    totalRow

    Name Description

    Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdditionalText

    Additionalhelp text.

    string null admin yes shortDesc

  • 5/26/2018 OA Component

    26/266

    OA Extension Component Reference

    20

    AdminPersonalization

    Indicates ifan

    Administrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    Attribute Set Theattributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments Comments string null null no comment

    DisableTotal

    Recalculation

    Indicates ifthe button

    used toupdatetotalsshould notberendered.

    boolean false admin no readOnly

    DocumentName

    The nameof thecomponent

    jrad:refName null null no docName

    Extends Areference

    to anothercomponentthatcreates adifferentinstance ofthatcomponentat runtime.

    jrad:componentRef

    null null no extends

    RecalculateTotals Label

    Overridesthe defaulttext of the

    UpdateTotalsbutton.

    string null admin true text

    Rendered Indicates ifthecomponentisrendered.

    boolean true user no rendered

  • 5/26/2018 OA Component

    27/266

    Region Styles

    21

    Scope The BasePackageswhich areallowed toreuse thiscomponent.

    jrad:scope . null no scope

    xml:lang Identifiesthelanguagecontainedwithin thiscomponent.

    optional null null no xml:lang

    lovActionButton

    Name Description

    Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdditionalText

    Additionalhelp text.

    string null admin yes shortDesc

    AdminPersonalization

    Indicates ifan

    Administrator canpersonaliz

    e thiscomponent.

    boolean true admin no adminCustomizable

    Attribute Set Theattributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments Comments string null null no comment

    CSS Class Overridesthe defaultCSS class.

    string null admin no styleClass

    DocumentName

    The nameof thecomponent

    jrad:refName null null no docName

    Extends Areference

    jrad:componentRef

    null null no extends

  • 5/26/2018 OA Component

    28/266

    OA Extension Component Reference

    22

    to anothercomponent thatcreates adifferentinstance ofthatcomponent atruntime.

    ExternalLOV

    The nameof theexternalList ofValuesregion.

    jrad:componentRef

    null null no externalListOfValues

    Prompt The textlabel forthecomponent.

    string null admin true prompt

    Rendered Indicates ifthecomponent isrendered.

    boolean null user no rendered

    Scope The BasePackages

    which areallowed toreuse thiscomponent.

    jrad:scope . null no scope

    xml:lang Identifiesthelanguagecontainedwithin thiscomponen

    t.

    optional null null no xml:lang

    lovActionMap

    Name Description

    Type Default Value

    Personalizable

    Translatable

    XMLAt tr ibute

    Additiona Additional string null admin yes shortDes

  • 5/26/2018 OA Component

    29/266

    Region Styles

    23

    l Text help text. c

    AttributeSet

    Theattribute setfor thecomponent.

    jrad:attributeSetRef

    null null no use

    LOVRegionItem

    The nameof the itemin the ListOf Valuesregion.

    jrad:localRefString null null no lovItem

    Rendered

    Indicates ifthecomponentis rendered.

    boolean null user no rendered

    ReturnItem

    The nameof the item

    in the basepage thatreceives theresult fromthe LOVRegionItem.

    jrad:localRef 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 multipleof 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, therewould 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.

  • 5/26/2018 OA Component

    30/266

    OA Extension Component Reference

    24

    The maximum number of columns is 3, so if there are 100 visible indexed children, there will stillbe only 3 columns. The default split is set to 10. The split is based solely on the number ofvisible indexed children and not on their size.

    The bulletedList region extends the UIX counterpart and inherits all theattributes and the named children. The only child that supports is the standard

    contents element for the indexed children.

    Corresponding web bean: OABulletedListBean

    Properties

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Add

    IndexedChildren

    Indicates if indexed

    children will beautomaticallyadded to this UInode tree.

    boolean true null no addChildren

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each row

    in the ViewInstance.

    string null null no childViewUsageName

    Comments

    Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSS Overrides the string null admin no styleClass

  • 5/26/2018 OA Component

    31/266

    Region Styles

    25

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Class default CSS class.

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    DocumentationComment

    Formatted text foruse with Javadoc.

    string fromtemplatefile

    null no not applicable

    Extends A reference toanother componentthat creates adifferent instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    FileVersion

    The version of thefile.

    string null null no file-version

    Height The display heightin characters.

    string null null no height

    HelpTarget

    The target name forthe page onlinehelp.

    string null null no helpTarget

    HelpTarget

    Appl Short

    Name

    This application willbe used toconstruct URI of

    the "help" icon inthe global menu ofthe page.Thismakes the helppages from theother applicationsreferenceable.

    string null null no helpTargetAppShortName

    ID The unique nameof this component.

    Name null null no id

    OAExtension

    Version

    The OracleApplications

    Extension versionwith which the filewas created orupdated.

    jrad:version null null no version

    PersonalizationLabel

    The region labelused forPersonalization.

    string null null no regionName

    Post Initial Indicates if rows boolean false null no postDefault

  • 5/26/2018 OA Component

    32/266

    OA Extension Component Reference

    26

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Values which are madedirty only by the

    defaulting of InitialValues are to beposted.

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    Scope The BasePackages whichare allowed toreuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used tosecure the region.If set toselfSecured it is thedeveloper'sresponsibility tohandle securityvalidation. Thelegal values arestandard, and selfSecured .

    string standard

    null no securityMode

    Standalone

    Indicates if thisregion can berendered on itsown.

    boolean false null no standalone

    View LinkInstance

    The name of theView Link Instanceestablishingmaster-detailrelationshipbetween outer andinner repeating

    containers.

    string null null no viewLinkName

    xml:lang Identifies thelanguage containedwithin thiscomponent.

    optional null null no xml:lang

  • 5/26/2018 OA Component

    33/266

    Region Styles

    27

    cellFormat

    Description

    The cellFormat region is used to format cells in a Row Layout region. The UIX UINode element 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 additionalformatting such as width, colspan, or vertical alignment.

    cellFormat extends the UIX counterpart and inherits all the attributes and thenamed children. The only named child that supports is the standard contentselement for the indexed children.

    Corresponding web bean: OACellFormatBean

    Properties

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AddIndexedChildren

    Indicates if indexedchildren will beautomatically addedto this UI node tree.

    boolean true null no addChildren

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

  • 5/26/2018 OA Component

    34/266

    OA Extension Component Reference

    28

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Child ViewInstance

    Renders aninstance of the

    object for each rowin the ViewInstance.

    string null null no childViewUsageName

    ColumnSpan

    The number ofcolumns spannedby the cell.

    string (if notset): 1

    null no columnSpan

    Comments Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSS Class Overrides thedefault CSS class.

    string null admin no styleClass

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    DocumentationComment

    Formatted text foruse with Javadoc.

    string fromtemplatefile

    null no not applicable

    Extends A reference toanother componentthat creates a

    different instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    FileVersion

    The version of thefile.

    string null null no file-version

    Height The display heightin pixels.

    string null null no height

    HorizontalAlignment

    Horizontalalignment.

    Acceptable values

    are "center", "left","right", "start", and"end".

    string null null no hAlign

    ID The unique name ofthis component.

    Name null null no id

    OAExtensionVersion

    The OracleApplicationsExtension version

    jrad:version null null no version

  • 5/26/2018 OA Component

    35/266

    Region Styles

    29

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    with which the filewas created or

    updated.

    Personalization Label

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to beposted.

    boolean false null no postDefault

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    Row Span The number of rowsspanned by the cell.

    string (if notset): 1

    null no rowSpan

    Scope The Base Packageswhich are allowed toreuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used to

    secure the region. Ifset to selfSecured itis the developer'sresponsibility tohandle securityvalidation. The legalvalues arestandard, and selfSecured.

    string standard

    null no securityMode

    VerticalAlignment

    Vertical aligmnet.Acceptable valuesare "middle", "top",

    and "bottom".

    string null null no vAlign

    View LinkInstance

    The name of theView Link Instanceestablishing master-detail relationshipbetween outer andinner repeatingcontainers.

    string null null no viewLinkName

  • 5/26/2018 OA Component

    36/266

    OA Extension Component Reference

    30

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Width Indicates the widthin pixels or as a

    percentage (if %sign included).

    string null null no width

    xml:lang Identifies thelanguage containedwithin thiscomponent.

    optional null null no xml:lang

    contentContainer

    Description

    The contentContainer region is used to place ancillary information on a page, offset by a certaincolor.

    contentContainer extends and inherits all the attributes and the namedchildren from it.

    Corresponding web bean: OAContentContainerBean

    Properties

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AddIndexedChildren

    Indicates if indexedchildren will beautomatically addedto this UI node tree.

    boolean true null no addChildren

    AdminPersonaliz

    Indicates if anAdministrator can

    boolean true admin no adminCustomizable

  • 5/26/2018 OA Component

    37/266

    Region Styles

    31

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    ation personalize thiscomponent.

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Background Shade

    The backgroundshade of the content

    container. It shouldbe one of "light","medium", "dark", or"transparent".

    ui:backgroundType

    null null no background

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the ViewInstance.

    string null null no childViewUsageName

    Comments Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSS Class Overrides thedefault CSS class.

    string null admin no styleClass

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    Documentation

    Comment

    Formatted text foruse with Javadoc.

    string fromtempl

    atefile

    null no not applicable

    Extends A reference toanother componentthat creates adifferent instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

  • 5/26/2018 OA Component

    38/266

    OA Extension Component Reference

    32

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    FileVersion

    The version of thefile.

    string null null no file-version

    Icon URI the URI for the iconfile.

    anyURI null admin no icon

    ID The unique name ofthis component.

    Name null null no id

    OAExtensionVersion

    The OracleApplicationsExtension versionwith which the filewas created orupdated.

    jrad:version null null no version

    Personalization Label

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to beposted.

    boolean false null no postDefault

    Rendered Indicates if thecomponent is

    rendered.

    boolean true user no rendered

    Scope The Base Packageswhich are allowed toreuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used tosecure the region. Ifset to selfSecured itis the developer'sresponsibility to

    handle securityvalidation. The legalvalues arestandard, and selfSecured.

    string standard

    null no securityMode

    Text The text label forthe component.

    string null admin no text

    View Link The name of the string null null no viewLinkName

  • 5/26/2018 OA Component

    39/266

    Region Styles

    33

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Instance View Link Instanceestablishing master-

    detail relationshipbetween outer andinner repeatingcontainers.

    Width Indicates the widthin pixels or as apercentage (if %sign included).

    string null null no width

    xml:lang Identifies thelanguage containedwithin this

    component.

    optional null null no xml:lang

    contentFooter

    Description

    The contentFooter region is used to create a horizontal separator with a curved corner todistinguish page level action/navigation buttons from the page content.

    This component is always embedded directly inside the top level pageLayout component.contentFooter extends and inherits all the attributes and the namedchildren from it.

    Corresponding web bean: OAContentFooterBean

    Note: contentFooter is deprecated as a style. You should use page buttons instead.

    Properties

  • 5/26/2018 OA Component

    40/266

    OA Extension Component Reference

    34

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminPersonaliz

    ation

    Indicates if anAdministrator can

    personalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the ViewInstance.

    string null null no childViewUsageName

    Comments Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSS Class Overrides thedefault CSS class.

    string null admin no styleClass

    DocumentName

    The name of thecomponent

    jrad:refName null null no docName

    DocumentationComment

    Formatted text foruse with Javadoc.

    string fromtemplatefile

    null no not applicable

    Extends A reference toanother component

    that creates adifferent instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    FileVersion

    The version of thefile.

    string null null no file-version

    ID The unique name ofthis component.

    Name null null no id

  • 5/26/2018 OA Component

    41/266

    Region Styles

    35

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    OAExtension

    Version

    The OracleApplications

    Extension versionwith which the filewas created orupdated.

    jrad:version null null no version

    Personalization Label

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of Initial

    Values are to beposted.

    boolean false null no postDefault

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    Scope The Base Packageswhich are allowed toreuse thiscomponent.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used to

    secure the region. Ifset to selfSecured itis the developer'sresponsibility tohandle securityvalidation. The legalvalues arestandard, and selfSecured.

    string standard

    null no securityMode

    View LinkInstance

    The name of theView Link Instance

    establishing master-detail relationshipbetween outer andinner repeatingcontainers.

    string null null no viewLinkName

    xml:lang Identifies thelanguage containedwithin this

    optional null null no xml:lang

  • 5/26/2018 OA Component

    42/266

    OA Extension Component Reference

    36

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    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 butnot identical to UIX's labeledFieldLayout. Since OADefaultDoubleColumnBean extendsOAHeaderBean, the defaultDoubleColumn element extends the header element.

    defaultDoubleColumn extends header and inherits all the attributes and named children. Seethe section onheaderfor 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 usemessageComponentLayout instead.

    Properties

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

  • 5/26/2018 OA Component

    43/266

    Region Styles

    37

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the ViewInstance.

    string null null no childViewUsageName

    Comments

    Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSSClass

    Overrides thedefault CSS class.

    string null admin no styleClass

    Extends A reference toanother componentthat creates adifferent instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    HelpTarget

    The target name forthe page onlinehelp.

    string null null no helpTarget

    HelpTarget

    Appl ShortName

    This application willbe used toconstruct URI ofthe "help" icon inthe global menu ofthe page.Thismakes the helppages from theother applicationsreferenceable.

    string null null no helpTargetAppShortName

    Hide

    Header

    Indicates if the

    region header isrendered.

    boolean false null no headerDisabled

    Icon URI the URI for the iconfile.

    anyURI null admin no icon

    PersonalizationLabel

    The region labelused forPersonalization.

    string null null no regionName

    Post Initial Indicates if rows boolean false null no postDefault

  • 5/26/2018 OA Component

    44/266

    OA Extension Component Reference

    38

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Values which are madedirty only by the

    defaulting of InitialValues are to beposted.

    RecordHistoryEnabled

    Indicates if RecordHistory feature isenabled.

    boolean false admin no recordHistoryEnabled

    Rendered Indicates if thecomponent isrendered.

    boolean null user no rendered

    SecurityMode

    Defines the securitymode used tosecure the region.If set toselfSecured it is thedeveloper'sresponsibility tohandle securityvalidation. Thelegal values arestandard, and selfSecured .

    string standard

    null no securityMode

    Standalon

    e

    Indicates if this

    region can berendered on itsown.

    boolean false null no standalone

    Text The text label forthe component.

    string null admin yes text

    View LinkInstance

    The name of theView Link Instanceestablishingmaster-detailrelationshipbetween outer and

    inner repeatingcontainers.

    string null null no viewLinkName

    defaultFormStack

  • 5/26/2018 OA Component

    45/266

    Region Styles

    39

    Description

    The defaultFormStack region extends header and inherits all the attributes and named children.See the section onheaderfor a list of attributes and child elements available on the headerelement.

    Since OADefaultFormStackBean extends OAHeaderBean, defaultFormStack element extendsthe header element.

    Corresponding web bean: OADefaultFormStackBean

    Note: defaultFormStack is deprecated as a style. You should use messageComponentLayoutinstead.

    Properties

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML At tribute

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for the

    applicationmodule.

    string null null no amDefName

    AMInstance

    The instancename of anapplicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute setfor the component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild viewattribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the ViewInstance.

    string null null no childViewUsageName

    Comments

    Comments string null null no comment

  • 5/26/2018 OA Component

    46/266

    OA Extension Component Reference

    40

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML At tribute

    ControllerClass

    The fully-qualifiedclass name for the

    controller object.

    string null admin no controllerClass

    CSSClass

    Overrides thedefault CSS class.

    string null admin no styleClass

    Extends A reference toanothercomponent thatcreates a differentinstance of thatcomponent atruntime.

    jrad:componentRef

    null null no extends

    HelpTarget

    The target namefor the page onlinehelp.

    string null null no helpTarget

    HelpTarget

    Appl ShortName

    This applicationwill be used toconstruct URI ofthe "help" icon inthe global menu ofthe page.Thismakes the helppages from theother applications

    referenceable.

    string null null no helpTargetAppShortName

    Icon URI the URI for theicon file.

    anyURI null admin no icon

    PersonalizationLabel

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to be

    posted.

    boolean false null no postDefault

    RecordHistoryEnabled

    Indicates if RecordHistory feature isenabled.

    boolean false admin no recordHistoryEnabled

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

  • 5/26/2018 OA Component

    47/266

    Region Styles

    41

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML At tribute

    SecurityMode

    Defines thesecurity mode

    used to secure theregion. If set toselfSecured it isthe developer'sresponsibility tohandle securityvalidation. Thelegal values arestandard, and selfSecure.

    string standard

    null no securityMode

    Standalone

    Indicates if thisregion can berendered on itsown.

    boolean false null no standalone

    Text The text label forthe component.

    string null admin yes text

    View LinkInstance

    The name of theView Link Instanceestablishingmaster-detailrelationshipbetween outer andinner repeating

    containers.

    string null null no viewLinkName

    defaultSingleColumn

    Description

    The defaultSingleColumn region lays out region items in one column. The labels are aligned tothe end and the input fields are aligned to the start. This is similar, but not identical, to UIX'slabeledFieldLayout.

    defaultSingleColumn extends header and inherits all the attributes and named children. See thesection onheaderfor a list of attributes and child elements available on the header element.

    Corresponding web bean: OADefaultSingleColumnBean

  • 5/26/2018 OA Component

    48/266

    OA Extension Component Reference

    42

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

    instead.

    Properties

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance The instance nameof an applicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the View

    Instance.

    string null null no childViewUsageName

    Comments

    Comments string null null no comment

    ControllerClass

    The fully-qualifiedclass name for thecontroller object.

    string null admin no controllerClass

    CSSClass

    Overrides thedefault CSS class.

    string null admin no styleClass

    Extends A reference toanother component

    that creates adifferent instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    HelpTarget

    The target name forthe page onlinehelp.

    string null null no helpTarget

    Help This application will string null null no helpTargetAppSh

  • 5/26/2018 OA Component

    49/266

    Region Styles

    43

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    TargetAppl Short

    Name

    be used toconstruct URI of

    the "help" icon inthe global menu ofthe page.Thismakes the helppages from theother applicationsreferenceable.

    ortName

    HideHeader

    Indicates if theregion header isrendered.

    boolean false null no headerDisabled

    Icon URI The URI for the

    icon file.

    string null admin no icon

    PersonalizationLabel

    The region labelused forPersonalization.

    string null null no regionName

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to beposted.

    boolean false null no postDefault

    Record

    HistoryEnabled

    Indicates if Record

    History feature isenabled.

    boolean false admin no recordHistoryEna

    bled

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    SecurityMode

    Defines the securitymode used tosecure the region.If set toselfSecured it is thedeveloper's

    responsibility tohandle securityvalidation. Thelegal values arestandard, and selfSecured .

    string standard

    null no securityMode

    Standalone

    Indicates if thisregion can be

    boolean false null no standalone

  • 5/26/2018 OA Component

    50/266

    OA Extension Component Reference

    44

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    rendered on itsown.

    Text The text label forthe component.

    string null admin yes text

    View LinkInstance

    The name of theView Link Instanceestablishingmaster-detailrelationshipbetween outer andinner repeatingcontainers.

    string null null no viewLinkName

    defaultStack

    Description

    The defaultStack region extends header and inherits all the attributes and named children. Seethe section onheaderfor 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 Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminPersonaliz

    ation

    Indicates if anAdministrator can

    personalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an applicationmodule.

    string null null no amUsageName

  • 5/26/2018 OA Component

    51/266

    Region Styles

    45

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AttributeSet

    The attribute set forthe component.

    jrad:attributeSetRef

    null null no use

    Child ViewAttribute

    The name of thechild view attribute.

    string null null no childViewAttrName

    Child ViewInstance

    Renders aninstance of theobject for each rowin the ViewInstance.

    string null null no childViewUsageName

    Comments

    Comments string null null no comment

    Controller

    Class

    The fully-qualified

    class name for thecontroller object.

    string null admin no controllerClass

    CSSClass

    Overrides thedefault CSS class.

    string null admin no styleClass

    DocumentationComment

    Formatted text foruse with Javadoc.

    string fromtemplatefile

    null no not applicable

    Extends A reference toanother componentthat creates a

    different instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    HelpTarget

    The target name forthe page onlinehelp.

    string null null no helpTarget

    HelpTarget

    Appl ShortName

    This application willbe used toconstruct URI ofthe "help" icon inthe global menu of

    the page.Thismakes the helppages from theother applicationsreferenceable.

    string null null no helpTargetAppShortName

    Icon URI The URI for theicon file.

    string null admin no icon

    Personaliz The region label string null null no regionName

  • 5/26/2018 OA Component

    52/266

    OA Extension Component Reference

    46

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    ationLabel

    used forPersonalization.

    Post InitialValues

    Indicates if rowswhich are madedirty only by thedefaulting of InitialValues are to beposted.

    boolean false null no postDefault

    RecordHistoryEnabled

    Indicates if RecordHistory feature isenabled.

    boolean false admin no recordHistoryEnabled

    Rendered Indicates if thecomponent isrendered.

    boolean true user no rendered

    SecurityMode

    Defines the securitymode used tosecure the region.If set toselfSecured it is thedeveloper'sresponsibility tohandle securityvalidation. Thelegal values are

    standard, and selfSecured .

    string standard

    null no securityMode

    Standalone

    Indicates if thisregion can berendered on itsown.

    boolean false null no standalone

    Text The text label forthe component.

    string null admin yes text

    View LinkInstance

    The name of theView Link Instanceestablishing

    master-detailrelationshipbetween outer andinner repeatingcontainers.

    string null null no viewLinkName

  • 5/26/2018 OA Component

    53/266

    Region Styles

    47

    flexibleContent

    Description

    The flexibleContent region is used to identify content that can be placed in a flexibleLayoutregion. The content can also be specified by referring to it. It represents available content whichmay or may not be made use of; and thus acts as a resource to the page designer.

    Corresponding web bean: OAFlexibleContentBean

    Properties

    Name Descr iption Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminOperations

    Indicates thepersonalizationoperations anadministratorcan perform onthe componentif AdminPersonalizationis set to True.The legalvalues are:null and

    remove. If setto remove, an

    Administratorcan removeflexibleContentso that it doesnot render onthe page, whenpersonalizingthe page. If setto null, noflexibleContent

    can beremoved.

    string remove

    null no adminOperations

    AdminPersonalization

    Indicates if anAdministratorcanpersonalize thiscomponent.

    boolean true null no adminCustomizable

    AM The fully- string null null no amDefName

  • 5/26/2018 OA Component

    54/266

    OA Extension Component Reference

    48

    Definition qualified classname for theapplicationmodule.

    AM

    Instance

    The instance

    name of anapplicationmodule.

    string null null no amUsageName

    AttributeSet

    The attributeset for thecomponent.

    jrad:attributeSetRef

    null null no use

    Comments Comments string null null no comment

    Description A shortdescription ofthe itemscontained in

    the element.This attribute istranslatableand will belisted/used inResourceCatalog. Asearch basedon descriptionmay beperformed bythe user.

    string null admin true description

    Disclosed The initialdisclosurestate. Whennot-disclosed,only an outlineof thecomponent isshown alongwith an icon torestore to thedisclosed state.

    boolean true null no disclosed

    DocumentName

    The name ofthe component

    jrad:refName null null no docName

    DocumentationComment

    Formatted textfor use withJavadoc.

    string fromtemplate file

    null no not applicable

    Extends A reference toanother

    jrad:componentRef

    null null no extends

  • 5/26/2018 OA Component

    55/266

    Region Styles

    49

    component thatcreates adifferentinstance of thatcomponent atruntime.

    FlexibleLayoutReference

    A reference totheoa:flexibleLayout that theflexibleContentwill berendered in. Novalue indicatesthat theflexibleContentwill not be

    renderedanywhere inthe page evenifrendered="true" is set. Thedifferencebetweenrendered="false" andflexibleLayoutRef="" is that

    flexibleContent(s) withflexibleLayoutRef="" will onlybe listed in thecatalog ascontent thatcan be added.

    string null null no flexibleLayoutRef

    ID Inherited from.The page-wideunique client ID

    of this node.

    Name null null no id

    Rendered Whether theflexibleContentis rendered.

    boolean true admin no rendered

    ShowBorder

    Whether theborder aroundthe layout is

    boolean false null no showBorder

  • 5/26/2018 OA Component

    56/266

    OA Extension Component Reference

    50

    shown.

    ShowHeader

    Whether theheader of thislayout isshown.

    boolean true null no showHeader

    Title The title todisplay abovethe flexiblecontent.

    string null null no title

    UserOperations

    Indicates thepersonalizationoperations auser canperform on thecomponent, ifUser

    Personalizationis set to True.The legalvaluesare: (Default)and disclose. Ifset to (Default),thecollapse/disclose operationcannot beperformed by

    the user on thisflexibleContent.If set todisclose, theuser can eitherdisclose orcollapse theflexibleContentregion in therendered page.

    string null user no userOperations

    UserPersonaliza

    tion

    Indicates if auser can

    personalize thiscomponent.

    boolean true user no userCustomizable

    ViewSourceRegion ID

    Specifies ID ofthe region(within theflexibleContent)on whichpersonalization

    string null null no viewSourceRegionId

  • 5/26/2018 OA Component

    57/266

    Region Styles

    51

    views havebeen defined.

    View TargetRegion ID

    Specifies ID ofthe region onwhich the

    personalizationview should beapplied.

    string null null no viewTargetRegionId

    flexibleLayout

    Description

    The flexibleLayout region is used to define a customizable layout, separate from content, wherecontent will be placed. flexibleLayout regions can be nested to form a customizable layout andcan 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 Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AdminOperations

    Indicates thepersonalizationoperations anadministratorcan perform onthe component if

    AdminPersonalizationis set to True.The legal valuesare: null andadd. If set toadd, an

    Administratorcan addpredefinedflexibleContentto theflexibleLayout

    string add null no adminOperations

  • 5/26/2018 OA Component

    58/266

    OA Extension Component Reference

    52

    region whenpersonalizing thepage. If set tonull, no flexiblecontent can beadded to thisflexiblelayout duringpersonalization.

    AdminPersonalization

    Indicates if anAdministratorcan personalizethis component.

    boolean true null no adminCustomizable

    AMDefinition

    The fully-qualified classname for theapplicationmodule.

    string null null no amDefName

    AMInstance

    The instancename of anapplicationmodule.

    string null null no amUsageName

    AttributeSet

    The attribute setfor thecomponent.

    jrad:attributeSetRef

    null null no use

    Columns The number ofcolumns the

    flexibleLayoutwill have. UselayoutStyle=horizontal tohorizontallylayout thecontents.

    string 1 null no columns

    Comments Comments string null null no comment

    Disclosed The initialdisclosure state.When not-

    disclosed, onlyan outline of thecomponent isshown alongwith an icon torestore to thedisclosed state.

    boolean true null no disclosed

    Document The name of the jrad:refName null null no docName

  • 5/26/2018 OA Component

    59/266

    Region Styles

    53

    Name component

    DocumentationComment

    Formatted textfor use withJavadoc.

    string fromtemplate file

    null no not applicable

    Extends A reference toanothercomponent thatcreates adifferentinstance of thatcomponent atruntime.

    jrad:componentRef

    null null no extends

    Height The pixels orpercentage 'hint'to the browserfor the

    flexibleLayout.

    string null null no height

    ID Inherited from. Thepage-wideunique client IDof this node.

    Name null null no id

    LayoutStyle

    The Contentlayout style. Thelegal values arevertical, andhorizontal. If

    vertical, contentswill be laid outvertically. If"horizontal"contents will belaid outhorizontally.

    string vertical

    null no layoutStyle

    Rendered Whether theflexibleLayout isrendered.

    boolean true admin no rendered

    Rows The number of

    rows theflexibleLayoutwill have. UselayoutStyle=vertical to verticallylay out thecontents.

    string 1 null no rows

    Show Whether the boolean false null no showBorder

  • 5/26/2018 OA Component

    60/266

    OA Extension Component Reference

    54

    Border border aroundthe layout isshown.

    ShowHeader

    Whether theheader of this

    layout is shown.

    boolean false null no showHeader

    Title The title todisplay abovethe flexiblelayout.

    string null null no title

    UserOperations

    Indicates thepersonalizationoperations auser can performon thecomponent, if

    UserPersonalizationis set to True.The legal valuesare: (Default)and disclose. Ifset to (Default),thecollapse/discloseoperation cannotbe performed bythe user on this

    flexible layout. Ifset to disclose,the user caneither disclose orcollapse theflexibleLayoutregion in therendered page.

    string null user no userOperations

    UserPersonalization

    Indicates if auser canpersonalize thiscomponent.

    boolean true user no userCustomizable

    Width Provides a widthhint to thebrowser.

    string null admin no width

  • 5/26/2018 OA Component

    61/266

    Region Styles

    55

    flowLayout

    Description

    The flowLayout region lays out its indexed children horizontally, wrapping as needed. Each pairof adjacent children will be separated by an optional separator child.

    When a flowLayout region is created under a footer named child of a messageComponentregion, the flowLayout region can only include button and spacer items.

    Corresponding web bean: OAFlowLayoutBean

    Properties

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    AddIndexedChildren

    Indicates if indexedchildren will beautomatically added tothis UI node tree.

    boolean true null no addChildren

    AdminPersonali

    zation

    Indicates if anAdministrator can

    personalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualified classname for the applicationmodule.

    string null null no amDefName

    AMInstance

    The instance name of anapplication module.

    string null null no amUsageName

    AttributeSet

    The attribute set for thecomponent.

    jrad:attributeSetRef

    null null no use

    Child

    ViewAttribute

    The name of the child

    view attribute. Valid onlywhen used in tableregion.

    string null null no childViewAttrNa

    me

    ChildViewInstance

    Renders an instance ofthe object for each rowin the View Instance.Valid only when used intable region.

    string null null no childViewUsageName

  • 5/26/2018 OA Component

    62/266

    OA Extension Component Reference

    56

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Comment

    s

    Comments string null null no comment

    ControllerClass

    The fully-qualified classname for the controllerobject.

    string null admin no controllerClass

    CSSClass

    Overrides the defaultCSS class.

    string null admin no styleClass

    Document Name

    The name of thecomponent

    jrad:refName

    null null no docName

    Documentation

    Comment

    Formatted text for usewith Javadoc.

    string fromtempl

    atefile

    null no not applicable

    Extends A reference to anothercomponent that createsa different instance ofthat component atruntime.

    jrad:componentRef

    null null no extends

    FileVersion

    The version of the file. string null null no file-version

    HelpTarget

    The target name for thepage online help.

    string null null no helpTarget

    HelpTarget

    ApplShortName

    This application will beused to construct URI ofthe "help" icon in theglobal menu of thepage.This makes thehelp pages from theother applicationsreferenceable.

    string null null no helpTargetAppShortName

    ID The unique name of thiscomponent.

    Name null null no id

    InitialSortSequence

    Indicates the initial sortsequence for eachsearch. The legal valuesarenone, first, second, and third.

    string none null no initSortSeq

    No Wrap Indicates if cell contentsshould be wrapped.Valid only when used in

    boolean false null no cellNoWrapFormat

  • 5/26/2018 OA Component

    63/266

    Region Styles

    57

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    table region.

    OAExtensionVersion

    The Oracle ApplicationsExtension version withwhich the file wascreated or updated.

    jrad:version null null no version

    PersonalizationLabel

    The region label used forPersonalization.

    string null null no regionName

    PostInitialValues

    Indicates if rows whichare made dirty only bythe defaulting of InitialValues are to be posted.

    boolean false null no postDefault

    Prompt The text label for thecomponent.

    string null admin true prompt

    Rendered Indicates if thecomponent is rendered.

    boolean true user no rendered

    Scope The Base Packageswhich are allowed toreuse this component.

    jrad:scope . null no scope

    SecurityMode

    Defines the securitymode used to secure theregion. If set to

    selfSecured it is thedeveloper'sresponsibility to handlesecurity validation. Thelegal values arestandard, and selfSecured .

    string standard

    null no securityMode

    SortAllowed

    Indicates if the user cansort this column. Validonly when used in tableregion. The legal values

    areyes, no, ascending, and descending.

    string no admin no sortState

    Sort ByView

    Attribute

    The alternate viewattribute name for usewhen sorting. Valid onlywhen used in tableregion.

    string null user no sortByViewAttr

  • 5/26/2018 OA Component

    64/266

    OA Extension Component Reference

    58

    Name Description Type Default

    Value

    Personalizable

    Translatable

    XML Attribute

    Standalo

    ne

    Indicates if this region

    can be rendered on itsown.

    boolean false null no standalone

    UserPersonalization

    Indicates if a user canpersonalize thiscomponent. Valid onlywhen used in tableregion.

    boolean false admin no userCustomizable

    xml:lang Identifies the languagecontained within thiscomponent.

    optional null null no xml:lang

    footer

    Description

    The footer region is designed to contain the copyright, privacy information, and any othercontent that should be at the bottom of the page.

    footer extends 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 Default

    Value

    Personalizable

    Translatable

    XMLAt tr ibute

    AdminPersonalization

    Indicates if anAdministrator canpersonalize thiscomponent.

    boolean true admin no adminCustomizable

    AMDefinition

    The fully-qualifiedclass name for theapplication module.

    string null null no amDefName

    AMInstance

    The instance nameof an application

    string null null no amUsageName

  • 5/26/2018 OA Component

    65/266

    Region Styles

    59

    Name Description Type Default

    Value

    Personalizable


Top Related