Region–OAF Region is a part of an Oracle Apps Framework page which acts as a container for the items or components. By default the top most level of an OA Framework page has to be of the "page Layout" region type. n OA Framework or OAF the regions can be nested so as to provide the desired layout to the OAF page. !ach region is a ava bean which acts as a container for the sub#regions or items in any Oracle Application Framework page. Regions which are parallel in the bean hierarchy$ in an OAF page$ are called as %iblings and the regions inside a region in an OAF page are called &hild regions. r egions. 'he same nomenclature is also applied for tems in OAF. (ence$ by default all the regions that you create become the child regions of the page Layout region as mentioned earlier that the page Layout region is the top most region in any OA Framework page. Also every region in OAF has specific properties which can be given some values while creation of the OA Framework page e.g. rendered property which allows the region to be displayed onto the OAF page$ as per Oracle Application Framework guidelines )called as OAF standards* this rendered property can have + values namely true)visible* or false)hidden*. f the region in an OAF page is set to be hidden then all the children regions,items will by default be rendered false once that OAF page is rendered on to screen. !ven these properties can be changed at runtime using a -ava controller$ controller$ but that needs an understanding on how to import the region beans and then how to create handle of the bean and then how to set properties. (owever this is not so much difficult to do but still some -ava concept and -ava /
programming knowledge is needed to achieve this. 'his is called as runtime control of the bean in OAF and is e0plained in detail for every region in the corresponding region type. !very region has a specific way of representing the data onto the screen once the OA Framework page is rendered. (ence while creation of a OAF page we have to very cautious in choosing the type of regions. !.g. a default1ouble&olumn type of region will create two columns and will automatically render all the components created inside it in these two columns once the OAF page is rendered to screen. 'here are various types of regions available in OA Framework.
'he complete list of all the regions re gions provided by Oracle Application Framework is given below.
advanced'able bulletedList cellFormat content&ontainer contentFooter default1ouble&olumn defaultForm%tack default%ingle&olumn default%tack fle0ible&ontent fle0ibleLayout flowLayout footer 2antt graph'able header (2rid hide%how hide%how(eader labeledFieldLayout listOf3alues message&omponentLayout navigationBar pageButtonBar pageLayout 4uery rowLayout shuttle stackLayout sub'abLayout switcher table tableLayout train tree
advancedTable: t was earlier that OA Framework used OA'ableBean OA'ableBean to render tables but now things have changed and OAAdvanced'abl OAAdvanced'ableBean eBean e0tends OA'able OA'ableBean. Bean. 'he best part of this is that with advancedtable provides declarative support for the functionalities which re4uired programming with simple table.
column span in a table column header were not available with OA'ableBean but is now declaratively supported by OAAdvanced'ableBean. Advanced table has many rich features$ some of which can be like a table can now have an instruction te0t and even a tip$ also table can have a navigation bar$ selection column$ add rows button$ control bar$ recalculate and many more. Advanced table even allows you to brand the table so that it looks more beautiful once it7s displayed. 'he branding options include8 . RowBranding +. &olumnBranding /. 9oBranding By default7 9oBranding7 Option will be active. Row Branding: Once you set the branding style in the property palette of advanced'able region and run the page$ you will note that the alternative rows of the table are in grey bands of color. !ven you have the option to choose the branding interval$ by default the branding interval is and hence alternative row is displayed in grey brand color$ if you choose + as branding interval then the grey band row will appear after every + rows. Column Branding: 'his is similar to row banding e0cept that now rather that rows the columns of your advanced table will be in the grey band branding style. No Branding: 'his is the default branding style that5s selected if you don5t choose other styles$ in this style neither rows nor columns will be branded and all the rows and tables of the advanced table will be displayed as mentioned in Oracle BLAF. %ome more features of advanced table are8 'e0t8 'his is the te0t that will be displayed on the top of the table once the OA Framework page is rendered. Records Displayed: 'his property can limit the number of records that can be displayed on the screen once the advanced table is rendered. Be default the number of records displayed is :.
Width: this is another important property of advancedtable. (ere as the name suggests you can enter the width of the table once the table is rendered. ;ou can either enter the width in pi0els or in percentage. n order to enter the width of the table in pi0el enter <:: or =:: in the property palette. n order to enter the width of the table in per centage enter >:? or @:? in the palette. Once you enter the width of table to be ::? the navigation links )9e0t and revious* will be displayed on top of the table. 'hese links allow you to navigate to the other rows$ apart from those being displayed on the OA Framework page currently. Controller Class: 'his is an optional property. f you want to perform some runtime action then only you need to create a controller class where you will be handling the events and navigations performed on the advanced'able. Admin Personalization: %et to true if you want the admin to be able to personalie the advanced'able region else false. User Personalization: %et to true if you want the user to be able to personalie the advanced'able region else false.
bulletedList: n oracle application framework page the OAF BulletedList appears with a bullet prefi0ed to any item present in this region. For eample # %uppose you have / items placed inside the BulletedList region type in an Oracle Application Framework page$ then all the / items will have a bullet attached as prefi0 when the OA Framework page renders. But the only condition that OAF applies for making the bullet as prefi0 is that each of the items should have its Rendered property set as true. (ence$ if bullet region is having 6 items in an Oracle Application Framework page and out of these 6 items$ + items have the rendered property as false then you will find only + items with bullet attached to it once the Oracle Apps Framework page renders on the browser. 2enerally$ Oracle Application Framework uses BulletedList to hold plain te0ts or links$ but this doesnCt means that it cannot hold other regions or items. Oracle Apps Framework gives you the freedom to add any other regions or items inside the BulletedList region style. Oracle Application Framework allows you to specify the whether you want to show all the items in columns or in the apps framework you can also set the number of rows that you e0pect to be displayed at runtime. 'o achieve the above mentioned functionality Oracle Application Framework provides you the (eight attribute property of the BulletedList. LetCs consider one more e0ample # %uppose you have : items that have to be displayed in + columns when the Oracle Apps Framework page is rendered. 'o make this happen all you need to do is to ust set the height property value as + in the -1eveloper 'ool property palette. 'his makes the items #< to come in one column and the items =#: to be displayed in the second column. But there is a restriction to the number of columns that you can create with the above approach. As per Oracle Application Framework you cannot e0ceed the number of columns by /$ this means that you cannot have more than three columns for a BulletedList region in an OAF page. &orresponding web bean8 OABulletedListBean !ow to create Bulleted"ist #tem in $AF page%& &reating a BulletedList on an Oracle Apps Framework page is simple. -ust follow the steps given below. . &reate a region on an OAF page using -1eveloper +. %et the style property to BulletedList. /. %et the properties of the newly created BulletedList region according to the re4uirement and the standards of Oracle Apps Framework. 6. &reate items of any item style as children in this region. cellFormat: n oracle application framework page the OAF &ellFormat region is used inside RowLayout region. &ellFormat region is a container of regions or items. t imparts the properties like column%pan$ row%pan$ vAlign$ hAlign$ e tc. %uppose you have / rows and + columns in a table. 9ow you want to merge + columns of first row. For this you can use row%pan property of cell and will get the first of resulting in only one column$ i.e. now when you run OAF page$ table will have total of < cells in it. &ellFormat allows you to control the vertical and horiontal alignment of item present in it. ;ou can achieve the same using vAlign and hAlign. %uppose there is cell consisting of message'e0tnput in it$ message'e0tnput should be top ustified and at the end of the cell in the Oracle application framework page. For this$ set the vAlign )3ertical alignment* property of cellFormat as top and hAlign )(oriontal Alignment*
Note - t will not take care the alignment of the te0t of the webbean present in it. Like$ in a message'e0tnput there is a te0t of 3AR&(AR data type$ it will be only left aligned. &orresponding web bean8 OA&ellFormatBean !ow to create cell Format Region in $AF page% &reating a cellFormat region on an Oracle Apps Framework page is simple. -ust follow the steps given below. . &reate a region on an OAF page using -1eveloper +. %et the style property to cellFormat. /. %et the properties of the newly created cellFormat region according to the re4uirement and the standards of Oracle Apps Framework. 6. &reate items or regions of any style as children in this region. contentContainer: n oracle application framework page the OAF &ontent&ontainer region is used to display additional information of the OAF page in Oracle BLAF ) Browser Look and Feel*. &ontent&ontainer is having special features which will help it to differentiate from other content of the OAF page. 'ample: t can have different background color which can be different from the standard background color of oracle apps framework page. 'his can be done by using Background %hade property of the &ontent&ontainer. t can have border to it to identify it as a separate region. &ontent &ontainer can have items and regions of any style in it.
'o add this into oracle application framework page$ create a shared r egion in the OAF page for &ontent&ontainer. 2enerally$ BulletList region is placed in it$ as we use &ontent&ontainer to display additional information$ and that will be displayed pointwise. n the B ulletList we can add further items or regions in it as per the re4uirement. &ontent&ontainer will be generally displayed at the end )right side* of the Oracle Apps Framework page. &orresponding web bean8 OA&ontent&ontainerBean !ow to create contentContainer Region in $AF page% &reating a content&ontainer region on an Oracle Apps Framework page is simple. -ust follow the steps given below. . &reate a shared region for the content&ontainer +. &reate a region on an OAF page using -1eveloper /. %et the style property to content&ontainer 6. %et the properties of the newly created content&ontainer region according to the re4uirement and the standards of Oracle Apps Framework. <. &reate items or regions of any style as children in this region. ContentFooter: n oracle application framework page the OAF &ontentFooter region was used to hold buttons )links* at the bottom level of the Oracle Apps Framework page. t displays as a bottom line which is separated from the page footer with the content of the oracle application framework page and also known as "ski". t is deprecated style. age buttons should be used instead of &ontentFooter to hold buttons in it. &orresponding web bean8 OA&ontentFooterBean )deprecated*
defaultDoubleColumn: n oracle application framework page the OAF 1efault1ouble&olumn region was used to hold items in two columns. rompt of items will be right ustified and the input fields will be left ustified. But it was not fulfilling the Oracle BLAF )Browser Look and Feel* D re4uirement,guidelines. (ence$ it is deprecated and message&omponentLayout should be used for better serving the purpose of placing items in OAF page along with header region which is called before message&omponentLayout in the OAF page. Along with 1efault1ouble&olumn layout$ there was one more region known as 1efault%ingle&olumn layout was present. 1efault%ingle&olumn severs the re4uirement of placing items in one columnE it is also deprecated due to the same reason of not serving the purpose of Oracle BLAF D.
&orresponding web bean8 OA1efault1ouble&olumnBean )deprecated* defaultFormStac: n oracle application framework page the OAF 1efaultForm%tack region was used to hold regions or items in a stack format i.e. it was used when each region or items needs to come in Oracle apps framework page one under another )stacked* either to the left side of the page or right or center as per the re4uirement. t is a deprecated region style. stackLayout should be used instead of 1efaultForm%tack in current scenarios. &orresponding web bean8 OA1efaultForm%tackLayoutBean )deprecated* defaultSingleColumn: n oracle application framework page the OAF 1efault%ingle&olumn region was used to hold items in a single column. rompt of items will be right ustified and the input fields will be left ustified. But it was not fulfilling the Oracle BLAF )Browser Look and Feel* D re4uirement,guidelines. (ence$ it is deprecated and message&omponentLayout should be used for better serving the purpose of placing items in OAF page along with header region which is called before message&omponentLayout in the OAF page. Along with 1efault%ingle&olumn layout$ there was one more region known as 1efault1ouble&olumn layout was present. 1efault1ouble&olumn severs the re4uirement of placing items in two columnsE it is also deprecated due to the same reason of not serving the purpose of Oracle BLAF D. &orresponding web bean8 OA1efault%ingle&olumnBean )deprecated* defaultStac: n oracle application framework page the OAF 1efault%tack region was used to hold regions or items in a stack format i.e. it was used w hen each region or item needs to come in Oracle apps framework page one under another )stacked* either to the left side of the page or right or center as per the re4uirement. t is a deprecated region style. %tackLayout should be used instead of 1efault%tack in current scenarios. &orresponding web bean8 OA1efault%tackLayoutBean )deprecated*
fle!ibleContent: Fle0ible&ontent region is used to identify content that can be placed in a fle0ibleLayout region. 'he content can also be specified by referring to it. t represents available content which may or may not be made use ofE and thus acts as a resource to the page designer. &orresponding web bean8 OAFle0ible&ontentBean fle!ibleLa"out: 'he fle0ibleLayout region can be used to define a customiable layout$ as fle0ibleLayout regions can be nested to form a customiable layout and can be positioned anywhere in the page.
A page can have a number of Ctop#levelC fle0ible LayoutsE they do not have to be nested. &orresponding web bean8 OAFle0ibleLayoutBean flo#La"out: n oracle application framework page the OAF 1efault %tack region is used to hold buttons or images in a horiontal line. %uppose you have a table or advanced 'able in oracle application framework page and you want to define table actions to the table region$ as soon as you create table action by default flow Layout gets created as a child of table actions. Region style can be changed to row Layout or can have the same flow Layout attached to it. n case you want table actions to be performed only by using buttons then itCs better to use flowLayout instead of row Layout. f table action involves other item style i.e. OAessage&hoiceBean or OAessage'e0tBean then use rowLayout$ because if you use flowLayout is used then Oracle BLAF )Browser Look and Feel* of D will get hampered$ i.e. alignment wonCt be proper. Ghenever you create page %tatus region in pageLayout region flowLayout will also be get created automatically in it as a child. n flowLayout region there can be any region or item attached to it as child of it. &orresponding web bean8 OAFlowLayoutBean !ow to create (low"ayout Region in $AF page% &reating a flowLayout region on an Oracle Apps Framework page is simple. -ust follow the steps given below. . &reate a region on an OAF page using -1eveloper +. %et the style property to flowLayout. /. %et the properties of the newly created flowLayout region according to the re4uirement and the standards of Oracle Apps Framework. 6. &reate items or regions of any style as children in this region footer: n oracle application framework page the OAF Footer region is used to hold links which are for top#level applications$ buttons )global*$ copyright information$ privacy information )optional* and About this page link )optional* components in it. t is a child of pageLayout region. t is shown at the end of the OA Framework page in the BLAF D. f we want to attach a "Return to7" link i.e. a back navigation it will also get added in the footer region. &orresponding web bean8 OAFooterBean
$rantt: n oracle application framework page the OAF 2antt region is used to hold create 2antt charts. t retrieves the data from the B&6- obects. t is mostly used for the proect planning and scheduling information. t is like a matri0 i.e. it is having a vertical a0is and a horiontal a0is.
%uppose you want to use 2antt for proect planning then roect will be at the vertical a0is and the time period will be placed in an horiontal a0is. t inherits the properties of the (2rid region by e0tending it$ only the width property of (2rid we cannot change thru the 2antt region. &orresponding web bean8 OA2anttBean gra%&Table: n oracle application framework page$ through OAF 2raph'able region you can draw graphs. 2raph'able may not use all the columns present in the 2raph'able to plot the graph. f there are multiple graphs depending on one 2raph'able then each graph may use different set of columns to plot in the OAF page. 2raph'able is based on the tableLayout region and inherits all their property. Ge need to set a property of 2raph'able named as 2raph Render %tyle property as either graph or both. Ghen we set the value as graph that time we can view one or more graph elements. And when we set the property as both then we can view both the table data and the corresponding graph below the table$ and if you have multiple graphs then below the table there will be poplist item in the OAF page from which we need to choose the graph which we want to display.
&orresponding web bean8 OA2raph'ableBean &eader: n oracle application framework page we create an OAF (eader region to give separate title of the page to give the information of the page functionality to the user. By using (eader region$ page content and the header region gets seperated,partitioned for more clear information display. (eader region is also used for some important message display on the Oracle application framework page like !rror$ Garning$ nformation$ etc at the top of the page. By use of (eader region$ the page level action buttons,links will be displayed both at the top of the page and the bottom of the OAF page. 9ote8 (eader element does not support style &lass attribute. &orresponding web bean8 OA(eaderBean '$rid: As from the name (2rid itself$ it suggests hierarchy grid. n an oracle application page OAF (2rid region is used when the data needs to be represented in a hierarchical,tree structure. ;ou can use the 'ree region to represent the tree structure but tree region in OAF emphasis on the relationship of the obects of the hierarchy. ;ou can use (2rid to display the hierarchical structure along with the detail information of each row,node. t gives the privilege of modifying the hierarchy by performing the action as add$ delete$ update$ etc. (2rid has + special columns8 . Focus &olumn. +. Obect (ierarchy &olumn
&ideS&o#8 n oracle application framework page$ to provide the functionality to hide and show the items and )or* regions we use (ide%how region$ i.e. all the items or region$ which should be displayed or hidden$ should be a child of a region which will have a hide,show control. By using hode,show control we can hide or show a part of the section of information or the entire section. %uppose you want to hide or show details of a particular obect in an OA framework page$ hide,show region can be used. ;ou can use hide,show region when you want to hide or show the graph$ which is present in an OAF page. ;ou can use this even when a row of a table needs to hide and shown on some action on OAF page. (ide,show region can only provide its functionality on a single page at multiple parts. 9esting can also be done. &orresponding web bean8 OA(ide%howBean &ideS&o#'eader: n oracle application framework page$ to provide the functionality to hide and show the items under a header we use (ide%how(eader region. n both the case of toggling i.e. hidden or shown header te0t will remain as it is. n (ide%how(eader region we can add items as we add in (eader region. lease refer (eader region for more information on the properties of (eader region. &orresponding web bean8 OA(ide%how(eaderBean labeledFieldLa"out: 'he labeledFieldLayout region lays out its children in columnsE one column is for the "labels" and the other for the "fields"$ with a gap in between. 'he children are laid out across and down$ the first child in each row takes the "label" position and the second child takes the "field" position. 'he contents of each row are centered in the available space. 'he "labels" are always right aligned$ and the "fields" left aligned. Gith multiple columns$ the children continue to be layed out across and down. For e0ample$ with two columns$ the third child will be used as the label for the first row and second column. t also has support for the inline messaging beans where each inline messaging bean will automatically occupy both a "label" and "field" position. &orresponding web bean8 OALabeledFieldLayoutBean Note8 'he labeledFieldLayout component has been deprecatedE use the message&omponentLayout component instead. lease refer to the message&omponentLayout section for information about message&omponentLayout listOf(alues: A listOf3alues region is rendered in a separate modal dialog containing a comple0 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 messageLovnput section for information on the properties of messageLovnput. A listOf3alues region is rendered as a popup of separate OAF page region containing a list of possible values$ any of which can be selected as a valid value for an entry field on a transaction page or a field within a table.
messageCom%onentLa"out: n oracle application framework page OAF message&omponentLayout is the most widely used region to hold components. t is restricted to message components$ and it does not allow other regions to become its child. 'he components$ which are child of OAF message&omponentLayout region$ will have$ prompt of the component will be right )end* aligned and the te0t field will be left aligned. t serves the multiple column display of components in an OA framework page and also satisfies the standard D guidelines. t is recommended that we should not display more than / columns in respect to follow the D guidelines. n the OAF message&omponentLayout the spacing between the components are according to the Oracle BLAF D guidelines. &orresponding web bean8 essage&omponentLayoutBean navigation)ar: n oracle application framework OAF 9avigationBar is used to navigate to the ne0t or previous set of records. ;ou might have mostly saw 9avigationBar attached with the table or advance table. %uppose you have run a B&6- 3O 4uery that retrieved more than : records to be displayed in a table. 'hen a 9avigationBar will appear at the top and bottom of the table. By using the 9avigationBar link you can display the ne0t : records$ which are retrieved from the 4uer y. 9avigationBar can also be seen in the (2rid region$ in case we e0pand a node and the child retrieved are more than the record limit$ that time we have to use 9avigationBar link. 9ote8 9o need to declare 9avigationBar functionality e0plicitely. &orresponding web bean8 OA9avigationBarBean %age)utton)ar: n oracle application framework$ OAF pageButtonBar is used when a set of buttons,action links needs to be created at the page layout level. ageButtonBar is the child of pageLayout region. Buttons,action links will be displayed both at the top of the page ust below the page title and below the page footer line. &orresponding web bean8 OAageButtonBarBean %ageLa"out: 'he pageLayout region is the highest#level layout element. t acts as a template for the entire page. t$ by default$ has to be the top most region of the page. t supports several other regions and navigation areas so as to maintain the Oracle Application Framework %tandards. &orresponding web bean8 OAageLayoutBean *uer"8 A 4uery region is basically an e0tension of the stackLayout region. A 4uery region can contain the following8 . %imple search panel +. Advanced search panel /. a results table 6. Other elements as inde0ed children %imple search panel can contain any of the following
b* 1efault1ouble&olumn c* 1efault%tack d* 1efaultForm%tack elements. 'he advanced search panel can contain a* Advanced %earch element. 'he results of a 4uery are rendered using either a (2rid or a table. 'he table or (2rid elements are added as inde0ed children of the 4uery region. A 4uery region can have three types of search panels as listed below. %imple Advanced &ustomie Also the 4uery region runs in three modes8 . 1efault mode +. Results Based %earch )RB%* mode /. Auto &ustomiation &riteria )A&&* mode. De(ault mode: 1eveloper is responsible for defining the search panels and binding the results of the search to the results table,(2rid. Results Based )earch *RB)+ mode: %earch panel is created dynamically using the 4uer yable property of the region items inside the nested table or (2rid inde0ed children Auto Customization Criteria *ACC+ mode: ;ou have the fle0ibility of defining your own D 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,(2rid. %et the Dser ersonaliation property of the table,(2rid re gion )under the 4uery region* to 'rue if you want to support user#personaliable searches which are surfaced in a 3iews panel. &orresponding web bean8 OAIueryBean ro#La"out: n oracle application framework page the OAF RowLayout region is used which will hold &ellFormat inside i.e. as a child to it. RowLayout region can be defined as an independent region or it can be a child of a tableLayout, advance'able region to create a row of a table,advance'able. RowLayout provides horiontal alignment of items or regions as these items or regions will be under cellFormat and rowLayout holds cellFormat in a horiontal line. (ence row contains cell and cell in#turn contains items to it. Ge use rowLayout only when other layouts are not supporting the re4uirement in a standard way i.e. not following the Oracle BLAF D guidelines. &orresponding web bean8 OARowLayoutBean !ow to create row"ayout Region in $AF page% &reating a rowLayout region on an Oracle Apps Framework page is simple. -ust follow the steps given below. . &reate a region on an OAF page using -1eveloper +. %et the style property to rowLayout. /. %et the properties of the newly created rowLayout region according to the re4uirement and the standards of Oracle Apps Framework. 6. &reate cellFormat region as a child of rowLayout.
s&uttle: 'he shuttle region provides a means 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. &orresponding web bean8 OA%huttleBean stacLa"out: 'he stackLayout region is a layout element that lays out each of its children vertically. &orresponding web bean8 OA%tackLayoutBean subTabLa"out8 'he sub'abLayout region has a child called "sub'abs" that takes a sub'abBar bean. sub'abBar bean contains link elements as its inde0ed children. sub'abBar is rendered once on top. 'he number of inde0ed children of sub'abBar$ which are the link elements$ should be e4ual to the number of inde0ed children of the parent sub'abLayout. 'he link elements are used to switch between the inde0ed children of the sub'abLayout. &orresponding web bean8 OA%ub'abLayoutBean s#itc&er: 'he switcher region is used in typical business re4uirements e.g. supopose we want to show an LO3 when one of the value of the defined attribute of the 3O is selected and an OAessage'e0tnputBean when another value is selected in the 3O i.e. it has a property$ "child9ame"$ which is used to render the named child under this name. 'he item to be displayed on the OA Framework page is decided at runtime. A view name and a view attribute have to be specifed to a switcher. &orresponding web bean8 OA%witcherBean table: As the name suggests a table region is used to display tabular data and also supports selection )both single and multiple*$ sorting$ record navigation$ detail#disclosure and totaling but totaling can be enabled for any column e0cept for the first column in a table. &orresponding web bean8 OA'ableBean tableLa"out: 'he tableLayout region is also of table type only and acts as a thin wrapper around the ('LCs table element. t contains a series of rowL ayout elements for embedding other regions and items. &orresponding web bean8 OA'ableLayoutBean train: 'he train region is used to signify the in progress page of a multi#page process. 'he highlighted "step" indicates the currently active page. 'he train has one property$ "selectednde0"$ which is the inde0 of the selected "step". &orresponding web bean8 OA'rainBean
tree: As the name suggests that a tree region is used to display obects in a hierarchical format. t segregates data into child,leaf nodes and parent nodes which can be either e0panded or collapsed. 'he purpose of tree is to allow users to promptly browse through composite sets of hierarchical obects and access detailed information for a record by highlighting it in the tree. 'he visual representation of the hierarchy using the tree also depicts the relationship between obects with respect to one another. &orresponding web bean8 OA'reeBean
+T,S - OAF An item in OAF is a ava bean which allows a user to interact with the Oracle Apps Framework page e.g. a te0t bo0 or a choice bo0 etc. &omponents or items are always placed inside some region so that they are always displayed as per the Oracle Application Framework standards. !very item or component has specific properties which can be given some values while creation of the OA Framework page e.g. rendered property which allows the bean to be displayed onto the screen it can be true)visible* or false)hidden*. tems get rendered on the Oracle Apps Framework page in the fashion as described by the region in which that item has been placed either at declarative,design time or at runtime. !ven these properties can be changed at runtime$ but that needs an understanding on how to import the beans and then how to create handle of the bean and then how to set properties. (owever this is not so much difficult to achieve but still some programming knowledge is needed to achieve this. 'his is called as runtime control of the bean and is e0plained in detail for every item in the corresponding item type. A complete list of all the items provided by Oracle Application Framework is given below.
button e0portButton fle0 formatted'e0t formarameter form3alue image link message&heckBo0 message&hoice message1ownload messageFileDpload messagenlineAttachment messageLov&hoice messageLovnput messageRadioButton messageRadio2roup messageRich'e0t!ditor message%tyled'e0t message'e0tnput raw'e0t
rich'e0t!ditor selectionButton separator servletnclude spacer static%tyled'e0t submitButton tip urlnclude
button: 'he button item style in Oracle Application Framework creates a push button. t allows the user to trigger certain action in response to a click. 'o do this the Oracle Apps Framework gives the property of fire action. 'he fire action property needs the name of the action to be fired e.g.
"buttonAction". 9ow$ once the button is clicked the control goes to the processFormRe4uest method to search for the buttonAction code. 'his all is handled by the OA Framework. n the buttonAction code you need to write the business logic as per the re4uirement. ;ou cannot have children to this button bean. &orresponding web bean8 OAButtonBean mport ath8 import oracle.apps.fnd.framework.webui.beans.nav.OAButtonBeanE e!%ort)utton: n Oracle Application Framework the !0portButton is used to8 !0port the displayed data of a particular region or for all regions on an OAF page to a comma separated value )csv* file. o Only the regions that are displayed on the OA Framework will be e0ported. o !ach region on the e0ported file will have a row of column names followed by the results. #n Windows8 &licking on the !0portButton will open a dialog according to which o ;ou can open the e0ported file and then save the same$ or$
o ;ou could save the file and then open it. eportButton can ,e used as (ollows: . !0porting the data of all regions on a page. +. !0porting data of a specific region on a page. . !0porting the data of all regions on a page8 A. &reate a contentFooter region under the pageLayout region of that OAF age. B. Add an "!0portButton" to the contentFooter region. &. f there is more than one button which needs to be added to the contentFooter$ then all the buttons should be put under a flowLayout region$ and this flow layout should then be added to the contentFooter. +. !0porting data of a specific region on a page8 A. &reate an "!0portButton" under the region whose data needs to be e0ported. B. 9ow$ in the container obect$ position this !0portButton and set a view usage name for this !0portButton. 'he data of the attached 3O will be e0ported to a &%3 file. t e0tends the OA FrameworkCs submitButton and inherits all the properties from it.
&orresponding web bean8 OA!0portBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OA!0portBeanE fle!: Oracle Application has two types or styles of fle0 item styles. n other words you can say that there are two types of fle0 fields in Oracle Application$ they are8 . 1escriptive fle0 field. +. Jey fle0 field. -. Descripti/e (le (ields: t provides a customiable "e0pansion space" which can be used to track additional information$ important and uni4ue to a customerCs business$ which would not otherwise be captured by the form. 0. 1ey (le (ields8 'hey are the key building block for the business group and are made up of meaningful segments identifying business entities like osition$ -ob$ and 2rade etc. By using fle0 item style$ we create the complete structure of key fle0 field and descriptive fle0 field as it is declared in Oracle Applications. &orresponding web beans8 OA1escriptiveFle0Bean$ OAJeyFle0Bean import oracle.apps.fnd.framework.webui.beans.OA1escriptiveFle0BeanE import oracle.apps.fnd.framework.webui.beans.OAJeyFle0BeanE
formattedTe!t: ;ou may have guessed from the name itself that a formatted'e0t item style will accept a string. n OAF the Formatted'e0t accepts the string in one of its attribute named as "'e0t" and contains a very limited set of ('L markup and outputs formatted results. Oracle Apps Framework developers$ who need more of ('L functionality must use the raw'e0t bean. !.g. formatted'e0t bean wonCt support the use of ('L tables or ('L linksE hence OAF developers have to use either tableLayout and link beans or use ust the raw'e0t bean.
formatted'e0t bean provides a limited ability to use a single source for translated or user# provided Formatted'e0t without parsing or filtering. t supports more attributes than the raw'e0t beanE e.g. it supports style&lass. !23" mar4ups supported ,y Formatted2et are: n the &%% attributes "class"$ "style" and "href" are the only attributes that are supportedE all the other &%% attributes others are ignored. &orresponding web bean8 OAFormatted'e0tBean mport ath8 import oracle.apps.fnd.framework.webui.beans.OAFormatted'e0tBeanE form.arameter: n Oracle Apps Framework the formarameter item style provides the functionality to act as a placeholder for submission parameters. %uppose you want a user to fill his credit card details and then you want to call a payment gateway by passing his credit card information$ then you will use the formarameter bean to hold the values of the credit card filled by the user in the OAF page.
Oracle Application Framework also provides the form3alue bean for holding the values$ but there are differences between formarameter and form3alue beans of OAF$ these are listed below. . formarameter wonCt support a "value" attribute. nstead$ the value is set only at form submission time. +. A formarameter with a particular name can be added 9 number of times to a form without ill effectsE only one instance will appear. 'his is noticeably different from the form3alue$ where reuse will cause the same value to appear multiple times in the form submission. &orresponding web bean8 OAFormarameterBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OAFormarameterBeanE form(alue: n Oracle Apps Framework the form3alue bean is used to add value that will be submitted with a form$ but the key point to mention is that value is not displayed to the user. 'o make the form3alue bean get a value the form3alueCs 3iew9ame and 3iewAttribute has to be mapped to a 3iew Obect and as soon as that 3iew Obect is e0ecuted the form3alue getCs the value of the mapped attribute. &orresponding web bean8 OAForm3alueBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OAForm3alueBeanE image: %uppose you want to show an image on to an Oracle Application Framework page then you have to use the Oracle Apps Framework provided mage bean. 'his bean has to be mapped to an image so that the image can be displayed to once the OAF page is rendered. For e0ample when we see an update column in a table$ that column uses image bean to display the image of update icon. &orresponding web bean8 OAmageBean mport ath8 import oracle.apps.fnd.framework.webui.beans.OAmageBeanE lin: 'he Oracle Application Framework provides the Link bean so that you can redirect the control to any other page once the Link bean has been clicked. 'he link bean item style creates an ('L link tag which can then be redirected to some other page as re4uired. 'o open a new browser on the click of the link bean from an OAF page you ust need to make the target property of the link bean to Kblank. &orresponding web bean8 OALinkBean mport ath8 import oracle.apps.fnd.framework.webui.beans.nav.OALinkBeanE messageC&ec)o!: n order to create a check bo0 in an Oracle Application Framework page the message&heckBo0 bean is used. t is created with the userCs defined inline te0t which acts as a prompt once the
essage&heckBo0 serves the purpose of one or multiple selection. &orresponding web bean8 OAessage&heckBo0Bean mportath8 oracle.apps.fnd.framework.webui.beans.message.OAessage&heckBo0BeanE messageC&oice: n order to make a drop down bo0 in any Oracle Application Framework page the message&hoice bean is used. 'he message&hoice bean gives the user the functionality to select a value from the drop down list in an Oracle Apps page. eople often ge t confused between the essage&hoice and the List Of 3alues )LO3*$ whereas there are huge differences between both. 3alue of the dropdown list of essage&hoice bean comes from the B&6- obect. &orresponding web bean8 OAessage&hoiceBean mport path8 import oracle.apps.fnd.framework.webui.beans.message.OAessage&hoiceBeanE messageDo#nload: 'he essage1ownload bean is a very special one in Oracle Apps Framework. tCs special because it allows the user to download a file from the middle tier to the clientCs machine directly from the OAF page. &orresponding web bean8 OAessage1ownloadBean mportath8oracle.apps.fnd.framework.webui.beans.message.OAessage1ownloadBeanE messageFile/%load: n Oracle Apps Framework the messageFileDpload item style is created as a combination of the fileDpload and inlineessage controls. 'he fileDpload control adds a widget that can be used to upload a file right from the Oracle Application Framework page. Any OAF page that contains this control must have attribute "usesDpload" set to true. &orresponding web bean8 OAessageFileDploadBean mportath8 import oracle.apps.fnd.framework.webui.beans.message.OAessageFileDploadBeanE message+nlineAttac&ment: n any Oracle Apps Framework page the messagenlineAttachment item style is used to display attachments in a message bean. &orresponding web bean8 OAessagenlineAttachmentBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessagenlineAttachmentBeanE messageLovC&oice: 'he Oracle Application Framework creates a messageLov&hoice item style as a hybrid between a messageLovnput and a message&hoice. 'he messageLO3&hoice bean appears as a torch icon on the OAF page on the right side of a message&hoice. Once the torch is clicked a new region will be opened$ this region is called as the LO3 region in Oracle Application Framework terms$ the LO3 region will allow the user to search and select a value from the available ones. Once the value is selected the region will close automatically$ the
control will return back to the base OAF page and the choice bo0 will display the value selected from the LO3 region. &orresponding web bean8 OAessageLov&hoiceBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessageLov&hoiceBeanE messageLov+n%ut: n Oracle Apps Framework the messageLovnput item style is a combination of the lovnput and inlineessage controls. 9ote8 messageLovnput can have two or more lovaps created under it$ and each of those lovaps can have the &riteria tem property set. (ow ever if you set the &riteria tem property on more than one lovap$ at runtime when the user invokes an LO3$ selects a value from the LO3$ and then re#invokes it$ both the entered criteria are used. n this case$ deleting the value from the search item will not enable the user to 4uery all records from the LO3 tableCs view obects. &orresponding web bean8 OAessageLovnputBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessageLovnputBeanE messageRadio)utton: 'he messageRadioButton item style in Oracle Application Framework is a combination of the radioButton and inlineessage controls. t is used to create a radio button using which a user can select or deselect a value in an OAF page. &orresponding web bean8 OAessageRadioButtonBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessageRadioButtonBeanE messageRadio$rou%: 'he Oracle Apps Framework creates the messageRadio2roup item style as a combination of the radio2roup and inlineessage controls. ;ou can have many radio buttons in the messageRadio2roup but only one of the radio buttons can be selected at a time. 'his is used wherever you want user to select only one value from many choices available. %uppose in your OAF page you want the user to select a payment method out of the three available options namely &redit &ard$ ay al or &ash on 1elivery )&O1*$ then either you can use message&hoice bean or you can use the messageRadio2roup to achieve the same. &orresponding web bean8 OAessageRadio2roupBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessageRadio2roupBeanE messageRic&Te!t,ditor: 'he messageRich'e0t!ditor item style in Oracle Apps Framework page provides rich te0t editing capability within the OAF page. Dsing this region the users can format the te0t same as % Gord or other word processing
format. A user can even add bullets$ numbers etc to his te0t. Also$ the user can highlight the te0t or write the te0t in different colors$ is also gives the user the functionality to copy the te0t from any word processing tools and paste the same. 'he only condition that Oracle Application Framework puts for the messageRich'e0t!ditor is that it can be placed within any region e0cept search regions or tables. Also$ the browser should support FRA!% for the rich te0t editor to work. &orresponding web bean8 OAessageRich'e0t!ditorBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message. OAessageRich'e0t!ditorBeanE messageSt"ledTe!t: n Oracle Apps Framework the message%tyled'e0t item style is a combination of the styled'e0t and inlineessage controls. t is used to display a pr ompt and a value against that prompt. For e0ample you want to display the percentage of tasks done$ then you need the name of the tasks to come as labels and the percentage of the tasks completed will be fetched from the 3iew Obect. 'ask8 H:? 'ask+8 <:? (ere in the above e0ample 'ask and 'ask+ are the labels that you give to the message%tyled'e0t and the figures H and <: are the values fetched by the 3iew Attributes of the 3iew Obect attached with the message%tyled'e0t to display the value. &orresponding web bean8 OAessage%tyled'e0tBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message. OAessage%tyled'e0tBeanE messageTe!t+n%ut: 'he message'e0tnput in Oracle Application Framework provides an item which acts as a te0t bo0 so that a user can enter the values into it and can save the same once the entered values passes the B&6- validation if any. t is a combination of the te0tnput and inlineessage controls. ;ou can also write a prompt for the te0t bo0 to specify the purpose of the te0t bo0 in the label field provided by the Oracle Apps Framework. &orresponding web bean8 OAessage'e0tnputBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OAessage'e0tnputBeanE ra#Te!t: 'he raw'e0t item style supports output of unescaped te0t. Dse of this class means assuming full responsibility for generating proper ('L. &lients should strongly consider using elements in the ('L namespace instead of this class. n particular$ this class does not attempt to encode or escape characters for 9L% or ('L compliance. &orresponding web bean8 OARaw'e0tBean
reset)utton: %uppose you want to create a button which will clear all the contents that a user has filled in the form in one shot$ in these cases you can use the ResetButton provided by Oracle Application Framework. n the push of the ResetButton all the contents placed in all the items of that OAF age will be cleared and become blank. n simple words the ResetButton is used to re set the contents of the whole OAF age. &orresponding web bean8 OAResetButtonBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OAResetButtonBeanE ric&Te!t,ditor: 'he rich'e0t!ditor item style provides rich te0t editing capability within the OA Framework. t can be placed within any region e0cept search regions or tables. 'he component allows users to author$ edit and view rich te0t content in a browser that supports FRA!s. 'he rich'e0t!ditor item style e0tends message'e0tnput and can be used to provide rich te0t editing capabilities where they are re4uired. lease refer to the message'e0tnput section for more information on all rich'e0t!ditor properties. 9ote8 'he rich'e0t!ditor item style has been deprecatedE use messageRich'e0t!ditor instead. &orresponding web bean8 OARich'e0t!ditorBean mport ath8 import oracle.apps.fnd.framework.webui.beans.message.OARich'e0t!ditorBeanE selection)utton: 'he %electionButton in Oracle Application Framework creates a button that can select the whole row of a table. 'he restriction that Oracle Apps Framework puts for the %electionButton is that it can be created only under a single%election or multiple%election named child in a table region. %electionButton inherites all the properties from submitButton hence please refer to the submitButton section for more information on all submitButton properties. &orresponding web bean8 OA%electionButtonBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OA%electionButtonBeanE se%arator: 'he separator bean creates a horiontal line on the OAF page so that there is a clear demarcation between the components placed on any Oracle Application Framework page. t is rendered as a dashed horiontal line once the OAF page is rendered. &orresponding web bean8 OA%eparatorBean mport ath8 import oracle.apps.fnd.framework.webui.beans.layout.OA%eparatorBeanE servlet+nclude: 'he servletnclude item style allows you to include ('L content loaded from a local %ervlet or -% under the parent region directly from the Oracle Application Framework page.
&orresponding web bean8 OA%ervletncludeBean mport ath8 import oracle.apps.fnd.framework.webui.beans.include.OA%ervletncludeBeanE S%acer: 'he spacer item style inserts empty space in a page. %pacer Beans occupy a fi0ed amount of space in an ('L layout. %uppose you want to have some gap in between the regions or in between the items placed in any Oracle Application Framework page then you can use the %pacer item type provided by Oracle Apps Framework. 'he spacer item style has height and width properties so that you can specify either horiontal$ vertical or even both types of spaces in the Oracle Apps Framework page. &orresponding web bean8 OA%pacerBean mport ath8 import oracle.apps.fnd.framework.webui.beans.layout.OA%pacerBeanE StaticSt"ledTe!t: 'he static%tyled'e0t item style e0tends styled 'e0t. All attributes supported by styled 'e0t are inherited by static%tyled'e0t. %ee the section on styled 'e0t for a list of attributes available on the styled 'e0t element. &orresponding web bean8 OA%tatic%tyled'e0tBean mport ath8 import oracle.apps.fnd.framework.webui.beans.OA%tatic%tyled'e0tBeanE Submit )utton: 'he %ubmit Button item style is used to submit the OAF age. 'he destination attribute of the submit Button is always ignored and in place o f it the destination of the form is used as destination by Oracle Apps Framework. t also has the fire action property that you can use to handle the validations for the values being submitted with the form. &orresponding web bean8 OA%ubmitButtonBean mport ath8 import oracle.apps.fnd.framework.webui.beans.form.OA%ubmitButtonBeanE Ti%: 'he tip item style provides page or section level hints to the user. 'his is a very essential component that Oracle Apps Framework as there is always a demand for tips to be displayed once the mouse is hovered over any component. 'ypically$ the only inde0ed child of the tip will be a 'e0t 9ode$ but as many children as necessary can be added and will be laid out as with a flowLayout. &orresponding web bean8 OA'ipBean mport ath8 import oracle.apps.fnd.framework.webui.beans.OA'ipBeanE
/rl+nclude: 'he urlnclude item style allows you to include ('L content loaded from an e0ternal source under the parent region. &orresponding web bean8 OADrlncludeBean mport ath8 import oracle.apps.fnd.framework.webui.beans.include.OADrlncludeBeanE
Lov -0List of values1 n Oracle Apps Framework the messageLovnput item style is a combination of the lovnput and inline essage controls. Lov is used to displays the list of values from data base in separate region$ when ever user clicks on torch icon. Ghere user can search the value and do the selection. 9ote8 messageLovnput can have two or more lovaps created under it$ and each of those lovaps can have the &riteria tem property set. (ow ever if you set the &riteria tem property on more than one lovap$ at runtime when the user invokes an LO3$ selects a value from the LO3$ and then re#invokes it$ both the entered criteria are used. n this case$ deleting the value from the search item will not enable the user to 4uery all records from the LO3 tableCs view obects. Ste%s to create a LO(: &reate new bc6 package imp.oracle.apps.po.student.lov.server
&reate new Application module &reate new view obect
LO3AF
LO33O
2uer": %!L!&' 3!91ORK9A!$ 3!91ORK1 FRO OK3!91OR%E
Add LO33O in LO3A &reate shared region
T"%e8 listOf3alues
&reate new table using wiard Attributes set below properties8
(endor+D: seacr&Allo#ed 8'rue Sort Allo#ed 8 Ascending Sort se*uence8 First
(endor Name:
Searc& Allo#ed8 'rue
T"%e: messageLovnput ,!ternal Lov: imp.oracle.apps.po.student.lov.webui.supplierLovR9
Lov ma%%ing: Lov Region: 3endor9ame Return: %upplier Criteria: %upplier
essage C&oice 0.iclist or .o%list 1 n order to make a drop down bo0 in any Oracle Application Framework page the message &hoice bean is used. 'he message &hoice bean gives the user the functionality to select a value from the drop down list in an Oracle Apps page. eople often get confused between the essage&hoice and the List Of 3alues )LO3*$ whereas there are huge differences between both. 3alue of the dropdown list of essage &hoice bean comes from the B&6obect. Ste%s to create a messageC&oice: &reate new bc6 package imp.oracle.apps.po.student.poplist.server
&reate new view obect
%upplier3O
2uer": %!L!&' 3!91ORK9A!$3!91ORK1 FRO OK3!91OR%E
Add it in root Application module
&reate a item in page
T"%e: OAessage&hoice
Set belo# %ro%erties: .iclist vie# definition: imp.oracle.apps.po.student.poplist.server.%upplier3O .iclist Disa%l" Attribute: 3endor9ame .iclist (alue Attribute : 3endord
.iclist .iclist .iclist .iclist
vie# definition: Automatically e0ecutes the vo 4uery on page load Disa%l" Attribute: 'he attribute name you want show in the front end (alue Attribute: 'he attribute name you want to save in the back end 1B. vie# instance: 9eed to manually e0ecute the 4uery3
