of 218
8/11/2019 Bsp Extensions
1/218
BSP Directives
BSP Extension
IS BENCHMARK
Functionality
This BSP extension facilitates performance tests on other BSP extensions and BSPs.
Note
This BSP extension is included in the test BSP application it00, see bspext_benchmark.htm.
Example
Hello World
Further information
Weitere Informationen ber BSP-Extensions finden Sie in der SAP-Bibliothe unter der Internetadressehelp.sap.com!n"#$ -% SAP &etWea'er -%Application Platform (SAP Web Application Server) -> ABAP-Technologie -> UI-Technologie -> Web-UI-Technologie -> Business Server Pages-> Programmiermodell-> BSP-Extensions.
IS BENCHMARK DURAI!N
Functionality
This BSP element counts and prints out the number of milliseconds that are re(uired to calculate the bod).The number is output after the bod).
8/11/2019 Bsp Extensions
2/218
*or speed, )ou can surround this element "ith +datetimeformat% and assin it "ith a suitable formattinstrin in other "ords, "ith references to hours, minutes and seconds/, so that a fairl) leible duration isdispla)ed.
The return 'alue is usuall) bet"een 0### and 0#0#.
Attri"ute#
Attri"ute Man$atory De#cription
repeat &umber of recurrences default 'alue0/
o,tp,t If the 'alue 1true1 is set, the element bod) is output default 'alue/
Further information
text!irectionText or"ritindirection
2T3 predominant "ritin direction in Indo-European lanuaes/ , 3T2predominant "ritin direction in 4iddle Eastern lanuaes, for example,5ebre" and Arabic/ , I&5E3IT default 'alue, use the "ritin directionalread) set on the pae/
IS BENCHMARK E%C&UDE
Functionality
6ou use this BSP element to exclude the bod) from the benchmarin test. Some time ma) be re(uired toprocess the elements themsel'es so that tha) are not completel) transparent. &e'ertheless the) ma) beuseful for interated timin of a subset of a compound computation.
Attri"ute#
There are no attributes for this BSP element.
Example
Approximatel) 0#0# is usuall) returned as the return 'alue.
Further information
I&7289E T:;TE:T9I3E7TI
8/11/2019 Bsp Extensions
3/218
+bspbee%
IS BS' CA&&
Functionality
calls the controller defined b) the 832 and embeds the output from this controller into thisposition in the la)out.
If no instance of the specified controller exists, an instance is created and instantiated. If an instance of thespecified controller exists "ith the identical I9 attribute comp_id/, this instance is used. In this case theinformation specified in comp_idis sufficient to identif) the controller - the 832 and the e) do not ha'e tobe specified. If the keattribute is specified instead of the ,rl attribute, this refers to the na'iationspecified in the BSP application ho"e'er, this e) is seldom used/.
Parameters are transferred to the controller usin internal elements of t)pe +bspparameter%.
We recommend )ou follo" the procedure belo"
0. Initiali@e the controller )ou "ant to call in the controller main the call !_)$/ usincontroller_id.. Set the attributes of the ne" controller usin standard ABAP-
8/11/2019 Bsp Extensions
4/218
+bspfindandreplace%
IS BS' (!!
Functionality
2ie, but here onl) the output created b) the specified controller is sent. The output from thecalled controller "ith 'ie"s is reCected. This is "h) it seems as thouh )ou ha'e na'iated to the othercontroller. 5o"e'er, "ith the next re(uest the oriinal pae is returned to, that is, the bro"ser 832 does notchane.
We recommend )ou proceed as follo"s
0. Initiali@e the controller )ou "ant to call in the controller doin the callin !_)$/ "ith thecontroller_id.. Set the attributes of the ne" controller usin standard ABAP-## methods.. 7all the ne" controller in the 'ie" usin
Attri"ute#
Name Man$atory De#cription
ke >e) for the na'iation. &ote that this attribute is seldom used.
,rl Specifies the controller
Example
See BSP application bsp_model
Further information
*or more information about BSP extensions see the SAP 2ibrar) at the Internet address help.sap.com!n"#$-% SAP &etWea'er -%Application Platform (SAP Web Application Server) -> ABAP Technology -> UITechnology -> Web UI Technology ->Business Server Pages-> Programming odel ->BSP Extensions.
IS BS' HM&BE)EN
Functionality
This BSP element supports e'ent handlin if )ou are also usin nati'e 5T42 as "ell as htmlb.
Note
8/11/2019 Bsp Extensions
5/218
Name Man$atory De#cription 'o##i"le )alue#
e1ent_code
=a'aScript code enerated b) the5T42B e'ent s)stem to be usedin the bro"ser to trier thespecific 5T42B e'ent. This strincontains pure =a'aScript codeand should not be chaned. 8se
this strin directl) in an 5T42e'ent handler, for example, inon2lick. See also the examplebelo".
Strin, for example,+F 9ATA e'ent;code T6PE ST3I&?.F%+bsphtmlbE'ente'ent;definedG1m)Btn1 e'ent;codeG1+FGe'ent;codeF%1 !%+FGe'ent;codeF%
e1ent_defined
4an) e'ents need onl) a minimalstrin that contains additionalinformation for the e'ent. Insteadof usin additional parameters,)ou can also use this one strinfor this information. &ote that thisstrin has further sinificance for
the H$&3Be'ent s)stem.
Strin or &822 standard 'alue/
e1ent_tpe
8se this strin to specif) "hicht)pe of e'ent has been fired b)the control. *or example, apushbutton can fire a clic e'ent,a pae can fire e'ents forscrollin up and do"n paes, anda table can fire an e'ent for a lineselection or a header clic e'ent.&ote that this strin has no othersinificance for the
H$&3Be'ent
s)stem,
7haracter strin, for example, EHE&Tdefault 'alue/
id 8ni(ue name that identifies theBSP element.
7haracter strin, for example,m)htmlbE'ent
name
Specifies the name of the=a'aScript function. In case )ouare usin the e1ent_code
attribute, the =a'aScript code isreturned as an alternati'e, thismeans, it is placed in this strinreference and no =a'aScriptfunction is rendered.
Strin
on2lick Strin defined b) the user for thee'ent control. Example
E'ent handler, for example,ser1er'1entdefault 'alue/
8/11/2019 Bsp Extensions
6/218
.This strin can containinformation that helps the user tohandle the e'ent correctl). &otethat this strin has no othersinificance for the H$&3Be'ent
s)stem.
on2lient2lick
Strin for the on7lient7licattribute used in man) controls.This strin must contain 'alid=a'aScript code that can beexecuted later in the bro"ser. Thisstrin is not returned to the ser'er.Specif) at least one of theattributes on2lickoron2lient2lick, other"ise noe'ent handlin code "ill beenerated at all.
E'ent handler, for examplealert-4(,bmittin54/orhtmlbe1ent.cancel(,bmit = 6indo6.confirm-4(,bmit74/
p#..p8
9etermines the parameters of therendered =a'aScript function.These parameters are for"ardedto the code for the e'ent handlin.
Strin
ret,rn_1al,e
The =a'aScript code actuall)enerated is embedded in an5T42 eep inmind the peculiarities of e'enthandlin "ith 5T42. An exampleof this is the use of an anchor torender a control. If the
8/11/2019 Bsp Extensions
7/218
ABAP Technology -> UITechnology -> Web UI Technology ->Business Server Pages-> Programming odel ->BSP Extensions.
*or more information about e'ent handlin in BSP see the S9& under Web los about BSP, 1 BSP In-9epth8sin the 5T42B E'ent S)stem1 https+**6eblo5s.sdn.sap.com*p,b*6l5*?8 /.
IS BS' K*&INK
Functionality
6ou can use this element to insert a lin to documentation that is store d in the >no"lede Warehouse in)our BSP application. The lin appears either as a pushbutton or as a h)perlin on )our pae or 'ie".
&ote the follo"in
It is a prere(uisite that the documentation is installed >no"lede Ware house/
6ou need the number of the loical document 2no"lede Warehouse inthe meantime
Attri"ute#
Name Man$atory Explanation 'o##i"le )alue#
k63oio x 2oicaldocument I9 ofthedocumentationobCect in the
*or exampleB0ABE*DDJE0#######A00$#$
8/11/2019 Bsp Extensions
8/218
>no"ledeWarehouse
hei5ht 5eiht of the
displa) "indo"
&umeric 'alue, default 'alue is D##
6idth Width of thedispla) "indo"
&umeric 'alue, default 'alue is ##
k62lass
9ocument classin the>no"ledeWarehouse
IWB;ST387T info obCect displa) "ith thecorrespondin structure, default 'alue/ andIWB;E:T52P info obCect displa) "ithout structure/
lan5,a5e Specifies thedispla) lanuae
T"o-diit lanuae e), such as E& for Enlish or9E for ?erman
render;s T)pe of >W lindispla)
5T42B;2I&> h)perlin, default 'alue/ and5T42B;B8TT
textExplanator) textin front of the>W lin
Text
tooltip
Kuic info textthat appears
"hen the cursoris mo'ed o'erthe >W lin.
Text
6indo6Aeat,resa6Specifies the"indo"properties
*or exampleLheihtG##,"idthG$##,resi@ableG0,scrollbarsG0L
8/11/2019 Bsp Extensions
9/218
Example
See BSP application (B(:'$_B(:, pae k63ink.bsp.
E+ent han$lin,
&o e'ents are supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
I&7289E T:;>W98
8/11/2019 Bsp Extensions
10/218
*or more information about BSP extensions see the SAP 2ibrar) at the Internet address help.sap.com!n"#$-% SAP &etWea'er -%Application Platform (SAP Web Application Server) -> ABAP Technology -> UITechnology -> Web UI Technology ->Business Server Pages-> Programming odel ->BSP Extensions.
IS BS' '!RA&E)EN
Functionality
With this element )ou can reister for a portal e+entthat is fired from a different i)ie..
&ote the follo"in
It is not possible to unsubscribe from a portal e'ent. If an e'ent is no loner to be handled this has
to be established at the caller.
A portal e'ent transports namespace, name, databDectand so,rced. These can befetched in class 72;P ABAP Technology -> UITechnology -> Web UI Technology ->Business Server Pages-> Programming odel ->BSP Extensions.
+bspportalna1i5ationabsol,te%
+bspportalna1i5ationrelati1e%
+bspportalna1i5ationtoobDect%
+bsp'ie6%
+bsp'ie6area%
+bsptestsuite %
8/11/2019 Bsp Extensions
11/218
+bsptestsuite %
BSPE:TTEST
IS BS'E%ES
Functionality
BSP Extension 2ibrar) for test purposes
Further information
*or more information about BSP extensions see the SAP 2ibrar) at the Internet address help.sap.com!n"#$-% SAP &etWea'er -%Application Platform (SAP Web Application Server) -> ABAP Technology -> UITechnology -> Web UI Technology ->Business Server Pages-> Programming odel ->BSP Extensions.
IS BSPE:TTEST E2E4E&TWIT5ATT3IB8TES
Attribute
element;name
id
s
i
t
d
o
IS BS'E%ES E&EMEN*IH)ARIAB&ES
////////////////////////////////////////////////////
Attri"ute
element;name
id
'ar;date
8/11/2019 Bsp Extensions
12/218
'ar;time
'ar;lanuae
IS BS'E%ES E&EMENHA0HAS1D!2NAME
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES *RIERRE3UIRED
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES E&EMENHAD!N'R!CESS'A(E
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES B!D4A(DE'ENDEN
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES E&EMEN*IHRE3UIREDID
////////////////////////////////////////////////////
Attri"ute
element;name
id
8/11/2019 Bsp Extensions
13/218
IS BS'E%ES E&EMEN*IH!'I!NA&ID
////////////////////////////////////////////////////
Attri"ute
element;name
id
IS BS'E%ES B!D4!N&4BS'INNERA(S
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES IERAI!NRE3UIRED
////////////////////////////////////////////////////
Attri"ute
element;name
repeat
IS BS'E%ES B!D4BS'
////////////////////////////////////////////////////
Attri"ute
element;name
IS BS'E%ES E&EMEN&!!'IN(!)ERAB&E
////////////////////////////////////////////////////
Attri"ute
element;name
table
8/11/2019 Bsp Extensions
14/218
table;ro"
IS BS'E%ES E&EMENHAD!N'R!CESSB!D4
////////////////////////////////////////////////////
Attri"ute
element;name
+bspcomplex %
+bspcompileroptions %
IS BS'E%ES B!D4EM'4
////////////////////////////////////////////////////
Attri"ute
element;name
+bspcomposite %
IS BF
Functionality
The BT* Business Text *rame"or/ librar) pro'ides the follo"in BSP element for de'elopin Web content
W6SIW6? Editor for BT* 9ocuments
U#e
6ou can use this BSP extension in )our BSP application b) insertin the BSP element b) means of dra Mdrop from the ta bro"ser into )our BSPs.
Accordin to the definition of the pae lanuae ABAP, )ou determine the name of the BSP extension that)ou "ant to use b) means of the extensiondirecti'e. In this case, the extension is btf. 6ou can createa prefix of )our choice.
8/11/2019 Bsp Extensions
15/218
Further information
Examples for the BT* librar) are in the BSP application B$A_'$_!'&.
IS BF EDI!R
Functionality
This BSP element reali@es an editor for BT* documents "ith a W6SIW6? 'ie" What 6ou See Is What 6ou
?et/ and a source 'ie".
BT* documents can be edited formatted and so on/, or Cust displa)ed.
Attri"ute#
Name Man$atory De#cription
id x 8ni(ue name that identifies the BSP element.
doc,ment x6ou use this attribute to determine the BT* document that )ou"ant to edit or displa). The 'alue of this attribute has to bestandardi@ed "ith $:' 'A $ A_B$A_!2C&')$.
disabled
6ou use this attribute to determine "hether the BT* document canbe edited or Cust displa)ed. The 'alues for this attribute are *A2SEdefault settin/ and T38E.
6idth 6ou use this attribute to determine the "idth for the editor.
hei5ht 6ou use this attribute to determine the heiht for the editor.
on2lientnsertma5e6ou use this attribute to set a client-side e'ent handler that is calledif )ou clic 1Insert Imae1. This function is sho"n onl) if thisattribute has been set.
on2lientnsert3ink6ou use this attribute to set a client-side e'ent handler that is calledif )ou clic 1Insert 2in1. This function is sho"n onl) if this attributehas been set.
so,rceGie66ou use this attribute to determine "hether to edit or displa) theBT* document in the source 'ie". The 'alues of this attribute are*A2SE default settin/ and T38E.
Example
8/11/2019 Bsp Extensions
16/218
E+ent han$lin,
The BSP element btf_editordoes not ha'e an) e'ents.
Data Extraction for In"oun$ Re-ue#t#
If )ou "ant to read the chaned document, )ou can do so in the phase of the e'ent handlin inser1erF>re,est .
A e1entF>id = 4s,bmitB,tton4 ;)! e1entF>e1ent_tpe = 4click4.
!;$;+ data $:' 'A $ 23_B$A_B(:_'!$. data 7= 23_B$A_B(:_&;);'=>'$_!;$;- re,est = r,ntimeF>ser1erF
>re,est name = 4editor4 id = 4m'ditor#4 . A data ( )$ )$;3. doc,ment = dataF>doc,ment. ')!A.
')!A.
&ote that all restored data for an element is "ritten to the element class explicitl). In the case of thebtf+editorelement, the class 72;BT*;BSP;E9IT
8/11/2019 Bsp Extensions
17/218
ip# an$ ric5#
The W6SIW6? 'ie" is a'ailable for IE Hersion . and hiher onl). In all other bro"sers, the source 'ie" isused automaticall).
*or the function L2oad 2ocal *ileL, the element re(uires the follo"in
method="post"
encodin5$pe="m,ltipart*formFdata"
Further information
Examples for the BT* librar) are in the BSP application B$A_'$_!'&
7htmlb
+chtmlbcalendar;dail)%
+chtmlbcalendar;freebus)%
+chtmlbcalendar;monthl)%
+chtmlbcalendar;"eel)%
+chtmlbconfi%
+chtmlbconfi7ellerator%
+chtmlbconfiArea*rameSetter%
+chtmlbconfi?rid%
+chtmlbconfi?rid7ell%+chtmlbconfiTable%+chtmlbconfiToolbar%+chtmlbconfiTree%+chtmlbcontent%
+chtmlbheader%+chtmlbinputExtension%+chtmlbo'er'ie"*orm7onfi%+chtmlbo'er'ie"Table7onfi%
+chtmlbpaeT)pe%+chtmlbscriptBeforeSubmit%+chtmlbsplitter%+chtmlbsplitter7ontainer%+chtmlbsummar)?roup7onfi%+chtmlbsummar)Pae%+chtmlbsummar)Table7onfi%+chtmlbtableExtension%
crm;bsp;ic
+crmicbutton%
IS CRM/BS'/IC BU!N
Functionality
This Business Ser'er Pae BSP/ element implements the classic ?8I element, the button. When userschoose the button, the s)stem triers a predefined action.
8/11/2019 Bsp Extensions
18/218
When users choose a button, e'ent 72I7> is triered. 6ou can use the correspondin on2licke'enthandler to complete a predefined tas. The 72I7> e'ent can be acti'ated or deacti'ated d)namicall) b)usin the attribute disabled. When a button is deacti'ated, it no loner responds to user actions.A b,ttonelement has a text description attribute text/ and can also ha'e a tooltip attribute tooltip/.The appearance and total si@e of buttons are defined usin st)le sheets. The desi5nattribute allo"s aselection bet"een standard si@e and smaller si@e for buttons. 6ou can use this attribute to emphasi@e theimportance of certain buttons.
Attributes
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/ element.This attribute is used in e'ent handlin.
text 6ou use this attribute to define the descripti'e text that precedes the buttonitself.
encode
6ou use this attr ibute to define the codin. T38E and *A2SE are thepossible 'alues here. When this attribute is set to T38E, the text is "rittenas 5T42 source text. Example text G 1This text is +b%displa)ed+!b%perfectl) and has a tooltip.1 In this example, the "ord 1displa)ed1 appears inbold. When this attribute is set to *A2SE, the text appears exactl) as itstands.
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "henthe cursor mo'es o'er the button.
on2lick 6ou use this attr ibute to set the e'ent handler, "hich is called "hen userschoose the button. An e'ent is sent to the ser'er.
on2lient2lick 6ou use this attr ibute to set the client-side e'ent handler, "hich is called"hen users choose the button.
foc,s 9efines "hether there is a na'iation focus on the buttonN that is, "hetherusers can o to the button b) usin a e) combination.
priorit 9efines the priorit) of the button. If the priorit) is e(ual to 0, this button is thedefault button on the pae.
8/11/2019 Bsp Extensions
19/218
tabindex 9efines in "hich se(uence the buttons should be acti'ated.
1isible When this attribute is set to *A2SE, the button is hidden.
6idth 6ou use this attr ibute to define the "idth of the button.
desi5n6ou use this attribute to define the current desin for renderin the button.Possible 'alues are STA&9A39 standard 'alue/, E4P5ASIOE9, andS4A22.
disabled 6ou use this attribute to define "hether the button can be chosen in order totrier the 72I7> e'ent.
Example
8/11/2019 Bsp Extensions
20/218
&oteSee also BSP application (B(:'$_H$&3B, pae b,tton.bsp.
E+ent han$lin,
A BSP element can ha'e man) e'ents. The BSP element b,ttonhas onl) t"o e'ent handlers on2lick
and on2lient2lick.
&ormall), )ou implement )our user interface elements b) usin a element in the la)out of )ourBSP that refers bac to the same pae. In this standard case, )ou enerate the codin for the e'enthandlin in the e1ent_id. ... handle H$&3B e1ent... ')!A.
6ou can implement handlin of 5T42B e'ents in t"o "a)s. The first techni(ue in'ol'es retrie'in the e'entdata and subse(uentl) processin the data normall) in a lare casestatement/. The alternati'e in'ol'estrierin an e'ent at a user-instanced e'ent class.
Scenario 0 ?et the e'ent and process the data
In this case, the 5T42B manaer is called up to et a reference to a eneric e'ent obCect of t)pe23_H$&3B_'G')$. 6ou can use attributes nameand e1ent_tpein this e'ent obCect inorder to determine "hich ind of e'ent is a'ailable. If the element supports attribute id, )ou canuse the idattribute to find out "hich element triered the e'ent. *or detailed e'ent data,construct the e'ent obCect from an e'ent obCect "ith the appropriate t)pe. In this case, )ou "oulduse a b,ttone'ent. *or more information about the b,ttone'ent, see class23_H$&3B_'G')$_BC$$).
!;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e1ent = 23_H$&3B_&;);'=>5et_e1ent- r,ntimeF>ser1erF>re,est . A e1entF>name = 4b,tton4 ;)! e1entF>e1ent_tpe = 4click4. !;$;+ b,tton_e1ent $:' 'A $ 23_H$&3B_'G')$_BC$$). b,tton_e1ent 7= e1ent. ')!A.&otePlease note that for BSP element and the on2licke'ents, the correspondin e'entclass is 23_H$&3B_'G')$_BC$$).
Scenario
The interface IF/HM&B/E)EN is a'ailable for e'ent handlin. This interface contains methodsfor all BSP elements that are used in BSP extension 5T42B and that use e'ents.The e'ent can trier a user-specific e'ent handler class. In this case, the e'ent handlin class can
be an) user-defined class )ou lie, as lon as it implements interface A_H$&3B_'G')$and aninstance has been enerated. &ormall), )ou can use the application class to handle specifice'ents. The onl) prere(uisite for usin the application class is that it must implement interfaceA_H$&3B_'G')$.In the follo"in example, a separate class called 23_H$&3B_'G')$_';&:3'is used fore'ent handlin !;$;+ e1ent_handler $:' 'A $ 23_H$&3B_'G')$_';&:3'. 2';$' BK'2$ e1ent_handler. 23_H$&3B_&;);'=>dispatch_e1ent- re,est = r,ntimeF>ser1erF
8/11/2019 Bsp Extensions
21/218
>re,est e1ent_handler = e1ent_handler pa5e_context = pa5e_context .The b,ttonelement triers e'ent A_H$&3B_'G')$LBC$$)_232M, "hich also containsthe additional parameter id.The on2lickattribute is for all triered e'ents. This is the user-assined name for the e'enthandler method.&oteAll the b,tton-clic e'ents for all the buttons on the pae are triered b) this method. As theprorammer, ensure that )ou choose the correct I9 to decide "hich button is triered.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
ip# an$ ric5#
We recommend that )ou use either the on2lickor on2lient2licke'ent handler, becauseaddin a button "ithout one of these e'ent handlers is pointless.
8/11/2019 Bsp Extensions
22/218
Attri"ute#
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/ element. Thisattribute is used in e'ent handlin and data handlin.
text 6ou use this attribute to define the descripti'e text that appears next to thechecbox.
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "henthe cursor mo'es o'er the checbox.
disabled 6ou use this attr ibute to define "hether the checbox can be checedacti'ated/.
encode
6ou use this attr ibute to define the codin. T38E and *A2SE are thepossible 'alues here. When this attribute is set to T38E, the text is "rittenas 5T42 source text. Example text G 1This text is +b%displa)ed+!b%perfectl) and has a tooltip.1 In this example, the "ord 1displa)ed1 appears inbold. When this attribute is set to *A2SE, the text appears exactl) as itstands.
checked
6ou use this attribute to define the initial state of the checbox. Possible'alues are *A2SE default 'alue, not checed/ and T38E checed/.Example If )ou onl) define the I9 for a checbox id G 1m)7hecbox1/ andd)namicall) specif) checed checed G 1+FGchecedF%1/, and thechecbox appears checed, then the form fields return name G id und'alue G id. If the checbox is not checed, no form fields are returned.
ke
Halue of the checbox. If )ou i'e a e) a specific 'alue, such as 1)es1 , andthe checbox is checed checed G T38E/, the 'alue of the checbox canbe taen from the form fields b) re(uest. If )ou do not i'e a specific 'aluefor e) and lea'e it in its initial state, the default 'alue, the I9, is taen as the
name.
ke)ot2hecked 6ou use this attr ibute to manae a checbox 'alue that "as not set. 6ou canmanae this 'alue for further processin. If )ou enter a 'alue fore)&ot7heced, )ou can et the implicit 'alue of an uncheced checboxfrom form fields upon re(uest. *or example, if for attribute e), 1)es1 ischeced, 1no1 "ould be returned. If )ou do not i'e a specific 'alue fore)&ot7heced and lea'e it in its initial state, the s)stem uses the default
8/11/2019 Bsp Extensions
23/218
'alue, and this parameter remains blan. Example +crmicchecbox id G1m)7hecbox1 e) G 1:1 e)&ot7heced G 1-1 checed G 1+FGchecedF%1 !% If the checbox is checed, the form fields return nameG id and 'alue G L:L. If the checbox is not checed, the form fields for theold desin desin classic/ return nothin at all. 5o"e'er, for the ne" desindesin##/, the 'alue that is specified in e) or e)&ot7heced isreturned.
on2lick 6ou use this attr ibute to set the e'ent handler, "hich is called "hen userschec the checbox. An e'ent is sent to the ser'er.
on2lient2lick 6ou use this attribute to set an e'ent handler for checin the checbox.
foc,s 9efines "hether there is a na'iation focus on the checboxN that is,"hether users can o to the checbox b) usin a e) combination.
priorit 9efines the priorit) of the checbox. If priorit) G 0, focus is set to thischecbox.
Example
See BSP application (B(:'$_H$&3B, pae checkbox.bsp.
E+ent han$lin,
A BSP element can ha'e man) e'ents. The BSP element checkboxhas onl) t"o e'ent handlerson2lickand on2lient2lick.
&ormall), )ou implement )our user interface elements b) usin a element in the la)out of )ourBSP that refers bac to the same pae. In this standard case, )ou enerate the codin for the e'enthandlin in the e1ent_id.
... handle H$&3B e1ent... ')!A.
6ou can implement handlin of 5T42B e'ents in t"o "a)s. The first techni(ue in'ol'es retrie'in the e'entdata and subse(uentl) processin the data normall) in a lare casestatement/. The alternati'e in'ol'estrierin an e'ent at a user-instanced e'ent class.
Scenario 0 ?et the e'ent and process the data
8/11/2019 Bsp Extensions
24/218
In this case, the 5T42B manaer is called up to et a reference to a eneric e'ent obCect of t)pe23_H$&3B_'G')$. 6ou can use attributes nameand e1ent_tpein this e'ent obCect in orderto determine "hich ind of e'ent is a'ailable. If the element supports attribute id, )ou can use theidattribute to find out "hich element triered the e'ent. *or detailed e'ent data, construct thee'ent obCect from an e'ent obCect "ith the appropriate t)pe. In this case, )ou "ould use acheckboxe'ent. *or more information about the checkboxe'ent, see class23_H$&3B_'G')$_2H'2MB.
!;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e'ent G 72;5T42B;4A&A?E3G%et;e'ent runtime-%ser'er-%re(uest /. A e1entF>name = 4checkbox 4 ;)! e1entF>e1ent_tpe = 4click4. !;$;+ checkbox_e1ent $:' 'A $ 23_H$&3B_'G')$_2H'2MB. checkbox_e1ent 7= e1ent. ')!A.&otePlease note that for BSP element and the on2licke'ents, the correspondine'ent class is 23_H$&3B_'G')$_2H'2MB.
Scenario
The interface IF/HM&B/E)EN is a'ailable for e'ent handlin. This interface contains methodsfor all BSP elements that are used in BSP extension 5T42B and that use e'ents.
The e'ent can trier a user-specific e'ent handler class. In this case, the e'ent handlin class canbe an) user-defined class )ou lie, as lon as it implements interface A_H$&3B_'G')$and aninstance has been enerated. &ormall), )ou can use the application class to handle specifice'ents. The onl) prere(uisite for usin the application class is that it must implement interfaceA_H$&3B_'G')$.In the follo"in example, a separate class called 23_H$&3B_'G')$_';&:3'is used fore'ent handlin !;$;+ e1ent_handler $:' 'A $ 23_H$&3B_'G')$_';&:3'. 2';$' BK'2$ e1ent_handler. 23_H$&3B_&;);'=>dispatch_e1ent- re,est = r,ntimeF>ser1erF>re,est e1ent_handler = e1ent_handler pa5e_context = pa5e_context
.The checkboxelement triers e'ent A_H$&3B_'G')$L2H'2MB_232M, "hich alsocontains the follo"in additional parameters.
o !
I9 of the element that is usedo )_232M
&ame of the e'ent handler that "as entered b) the userThe on2lickattribute is for all triered e'ents. This is the user-assined name for the e'enthandler method.&oteAll the checkbox-clic e'ents for all the checboxes on the pae are triered b) this method. As
the prorammer, ensure that )ou choose the correct I9 to decide "hich checbox is triered.
Data Extraction for In"oun$ Re-ue#t#
If )ou "ant to read the checed status of a checbox, this happens in the e'ent handlin phase in
8/11/2019 Bsp Extensions
25/218
re,est = r,ntimeF>ser1erF>re,est name = 4checkbox4 id = 4cb#4 .A checkbox ( )$ )$;3. checked = checkboxF>checked.')!A.
&ote that all data that "as reproduced for an element is "ritten explicitl) in the element class. The class23_H$&3B_2H'2MBis used for this purpose for checkboxelements. 5T42B manaer returns aninstance of this class.
The follo"in attributes are reproduced or set
!
2H'2M'!
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC CHECKB!%(R!U'
Functionality
This Business Ser'er Pae BSP/ element arranes a roup of checboxes chec5Box/into ro"s andcolumns. The checboxes can be selected indi'iduall).
The col,mn2o,ntattribute defines ho" the checboxes are arraned in ro"s and columns. 7hecboxesthat appear one after the other are arraned in ro"s.
To include a checbox in a roup, simpl) add the correspondinchec5Boxelement tothecheckBoxro,pelement.
The internal element structure is made up of chec5Boxelements.
Attri"ute#
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/ element. This
attribute is used in e'ent handlin and data handlin.
col,mn2o,nt 6ou use this attribute to define the amount of columns for the checbox roup.
6idth 6ou use this attribute to define the "idth of the checbox roup.
8/11/2019 Bsp Extensions
26/218
Example
See BSP application (B(:'$_H$&3B, pae checkbox5ro,p.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
ip# an$ ric5#
If )ou mae more entries a'ailable than col,mn2o,ntallo"s, the s)stem inores the excess entries.5o"e'er, if there are not enouh entries a'ailable, the lefto'er cells appear as empt) cells in the roup. If)ou do not set col,mn2o,ntexplicitl), the s)stem assumes )ou "ant one sinle column.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC DR!'D!*N&ISB!%
Functionality
This Business Ser'er Pae BSP/ element is similar to the classic raphic user interface ?8I/ concept of adropdo"n list box.
6ou can use this element as a replacement for theli#tBoxelement if )ou "ant to displa) lon lists that"ould other"ise tae up too much space on the pae.
6ou can define the list entries in a drop!o6n3istBoxelement in t"o different "a)s
0. Statisticall) in the la)out section of a BSP application. B) bindin data to a table
6ou can also combine these t"o processes.
The first process is 'er) simple. 6ou add as man) listBoxtemsas necessar) to the!rop!o6n3istBoxelement. &ote that )ou must al"a)s define the attribute ke. 6ou can find acomplete list of the attributes for listBoxtemunderlistBoxItem.
The second process, data bindin to a table, is mostl) useful for applications "ritten in ABAP, since thislanuae pro'ides direct support for tables. 6ou need at least one table "ith t"o columns that contain thee) and text I9 pairs. Assin this table to the attribute tableof the drop!o6n3istBoxelement. 6oumust assin the name of the table columns to the attributes namefMe2ol,mnandnamefGal,e2ol,mn.
8/11/2019 Bsp Extensions
27/218
If the user chooses a list entr), this triers a select e'ent. 6ou can then install an on(electoron2lient(electe'ent handler to use scripts to handle this e'ent. 6ou can use the selectionattribute to et or set the currentl) selected list entr). The selected entr) is displa)ed in the first ro" of thedrop!o6n3istboxelement.
The internal element structure is made up of listBoxItemelements.
Attri"ute#
Name !"li,atory De#cription
id8ni(ue name that identifies the Business Ser'er PaeBSP/ element. This attribute is used in e'ent handlinand data handlin.
tooltip
6ou use this attribute to define a text for the tooltip.This text appears "hen the cursor mo'es o'er thedropdo"n list box. &ote that this attribute is not
a'ailable in 4icrosoft Internet Explorer.
disabled6ou use this attr ibute to define "hether the dropdo"nlist box can be chosen in order to trier the SE2E7Te'ent.
table6ou use this attribute to specif) the data source for thetable. The 'alues for the dropdo"n list box "ill be taenfrom this table.
selection 6ou use this attr ibute to define the list entr) that iscurrentl) chosen.
namefMe2ol,mn 6ou use this attr ibute to define the name of thee) column of the table.
namefGal,e2ol,mn 6ou use this attr ibute to define the name of the e)'alue of the dropdo"n list box.
on(elect 6ou use this attr ibute to set the ser'er-side e'enthandler, "hich is called "hen users select a list entr).
8/11/2019 Bsp Extensions
28/218
8/11/2019 Bsp Extensions
29/218
E+ent han$lin,
A BSP element can ha'e man) e'ents. The BSP element drop!o6n3istBoxhas onl) t"o e'enthandlers on(electand on2lient(elect.
&ormall), )ou implement )our user interface elements b) usin a element in the la)out of )our
BSP that refers bac to the same pae. In this standard case, )ou enerate the codin for the e'enthandlin in the e1ent_id. ... handle H$&3B e1ent... ')!A.
6ou can implement handlin of 5T42B e'ents in t"o "a)s. The first techni(ue in'ol'es retrie'in the e'entdata and subse(uentl) processin the data normall) in a lare casestatement/. The alternati'e in'ol'estrierin an e'ent at a user-instanced e'ent class.
Scenario 0 ?et the e'ent and process the data
In this case, the 5T42B manaer is called up to et a reference to a eneric e'ent obCect of t)pe23_H$&3B_'G')$. 6ou can use attributes nameand e1ent_tpein this e'ent obCect inorder to determine "hich ind of e'ent is a'ailable. If the element supports attribute id, )ou canuse the idattribute to find out "hich element triered the e'ent. *or detailed e'ent data,construct the e'ent obCect from an e'ent obCect "ith the appropriate t)pe. In this case, )ou "oulduse a drop!o6n3istBoxe'ent. *or more informationabout the drop!o6n3istBoxe'ent,see class 23_H$&3B_'G')$_('3'2$). 23;(( 23_H$&3B_&;);' !'A)$) 3;!. !;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e1ent = 23_H$&3B_&;);'=>5et_e1ent- r,ntimeF>ser1erF>re,est . A e1entF>name = 4dropdo6n3istBox4 ;)! e1entF>e1ent_tpe =4select4. !;$;+ dd_listbox_e1ent $:' 'A $ 23_H$&3B_'G')$_('3'2$). dd_listbox_e1ent 7= e1ent. ')!A.&otePlease note that for BSP element and the selecte'ents, thecorrespondin e'ent class is 23_H$&3B_'G')$_('3'2$).
Scenario
The interface IF/HM&B/E)EN is a'ailable for e'ent handlin. This interface contains methodsfor all BSP elements that are used in BSP extension 5T42B and that use e'ents.The e'ent can trier a user-specific e'ent handler class. In this case, the e'ent handlin class canbe an) user-defined class )ou lie, as lon as it implements interface A_H$&3B_'G')$and an
instance has been enerated. &ormall), )ou can use the application class to handle specifice'ents. The onl) prere(uisite for usin the application class is that it must implement interfaceA_H$&3B_'G')$.In the follo"in example, a separate class called 23_H$&3B_'G')$_';&:3'is used fore'ent handlin !;$;+ e1ent_handler $:' 'A $ 23_H$&3B_'G')$_';&:3'. 2';$' BK'2$ e1ent_handler. 23_H$&3B_&;);'=>dispatch_e1ent- re,est = r,ntimeF>ser1erF>re,est
8/11/2019 Bsp Extensions
30/218
e1ent_handler = e1ent_handler pa5e_context = pa5e_context .The dropdo6n3istBoxelement triers e'entA_H$&3B_'G')$L!:!W)3($B_('3'2$ , "hich contains the t"o interestinparameters idand selection. The idis the I9 of the BSP element, and selectionis theelement that is currentl) selected.&oteAll the dropdo6n3istBoxselect e'ents for all the dropdo"n list boxes on the pae aretriered b) this method. As the prorammer, ensure that )ou choose the correct I9 to decide"hich dropdo"n list box is triered.
Data Extraction for In"oun$ Re-ue#t#
If )ou "ant to read the dropdo"n list box, this happens in the e'ent handlin phase in
8/11/2019 Bsp Extensions
31/218
Functionality
This Business Ser'er Pae BSP/ element lets )ou arrane controls or 'ie"s into a table-lie format.
4an) documents can be 'ie"ed as a collection of nested boxes. *or example, the la)out of a ne"spaperconsists of multiple columns, "hich can contain articles. The articles, in turn, contain a title and a bloc of
text. Pictures ma) also appear. The text ma) be orani@ed into man) separate sections. These buildinblocs in a ne"spaper are boxesN rectanular areas that can be arraned on the pae lie a table. The5rid3ao,telement pro'ides a simple "a) to create such documents, but "ith considerabl) morefunction Each cell of a 5rid3ao,telement can accommodate one element. The element itself normall)has no 'isible desin of its o"n.
The internal element structure is made up of gridLayoutCell.
Attri"ute#
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/ element. Thisattribute is used in e'ent handlin and data handlin.
6idth 6ou use this attribute to define the "idth of the rid la)out.
hei5ht 6ou use this attribute to define the heiht of the rid la)out.
6idth:redefine
If this attribute is set to T38E, the "idth of the cells is predefined b)di'idin the "idth b) the number of columns. An approximate 'alue is thenused for each column, in order to define uniform column si@es "ithin the?rid2a)out.
blocks
&umber of blocs "ithin the rid la)out. 9efault is one bloc. If blocs areset to 11 and columnSi@e is set to 11, an additional narro" column isadded after four columns, in order to separate the blocs from one another.&ecessar) for certain la)outs.
ro6(iIe : 6ou use this attribute to define the number of ro"s.
col,mn(iIe : 6ou use this attribute to define the number of columns.
8/11/2019 Bsp Extensions
32/218
cell(pacin5 6ou use this attribute to define the spacin bet"een the indi'idual cells inthe rid.
cell:addin5 6ou use this attribute to define the spacin bet"een the cell border and cell contents.
deb,5&ode 6ou use this attribute to define "hether )ou "ant to "or in debuin mode.
stle6ou use this attribute to replace the bacround color "ith the 1standard loo M feel1.Possible 'alues include A2TE3&ATI&?, T3A&SPA3E&T, STA&9A39 default/ andW5ITE.
Example
< *crmic+5rid3ao,t2ell>
# N 9 < *crmic+5rid3ao,t2ell>
< *crmic+5rid3ao,t2ell>
9 N 9
8/11/2019 Bsp Extensions
33/218
&oteSee also BSP application (B(:'$_H$&3B, pae 5ridexample.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC (RID&A4!UCE&&
Functionality
This Business Ser'er Pae BSP/ element presents the characteristics of an indi'idual cell in agridLayoutelement. 6ou can use the attributes 6idth, horiIontal;li5nment, and1ertical;li5nmentto define the si@e and alinment for these cells. It is also possible for one cell tostretch across multiple columns. In this case, set attribute colspan.
Attri"ute#
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/element. This attribute is used in e'ent handlin and data handlin.
ro6ndex : 6ou use this attribute to define an index for the ro"s.
col,mnndex : 6ou use this attribute to define an index for the columns.
hei5ht 6ou use this attribute to define the heiht of the cell.
horiIontal;li5nment6ou use this attribute to define the hori@ontal alinment of an entr)"ithin the cell. Possible 'alues include 2E*T, 7E&TE3, 3I?5T,=8STI*6, and 75A3.
8/11/2019 Bsp Extensions
34/218
1ertical;li5nment6ou use this attribute to define the 'ertical alinment of an entr)"ithin the cell. Possible 'alues include T
8/11/2019 Bsp Extensions
35/218
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC IN'UFIE&D
Functionality
This Business Ser'er Pae BSP/ element implements the concept of a eneric, one-celled input field. Thecontent t)pe of this field is determined entirel) b) the t)pe of the correspondin data obCect, "hich createscomprehensi'e flexibilit).
The inp,tAieldelement is hihl) dependent upon the concepts of data obCects and data bindin. Alleneric data obCects are supported ($)for strins, )$''for "hole numbers, B3';)forBoolean statements, B2!binar) coded decimals/ for fixed point numbers data t)pe 1P1 in ABAP/ and also!;$'and $&'for date and time entries. The data t)pe that accepts an inp,tAieldelement can beset explicitl) "ith attribute tpe.
Attri"ute#
Name !"li,atory De#cription
id :8ni(ue name that identifies the Business Ser'er Pae BSP/ element.This attribute is used in e'ent handlin and data handlin.
desi5n
6ou use this attribute to define the font in "hich the output text shouldappear. *or example, a text can be displa)ed as the topmost headin,or in normal font. Possible 'alues are STA&9A39 standard 'alue/and S4A22.
re,ired 6ou use this attribute to define "hether an input field is a re(uiredentr) field or notN in other "ords, "hether user entr) is mandator).
6idth 8se this attribute to define the text "idth for the input field. Werecommend usin the si@e attribute instead of "idth.
siIe 6ou use this attribute to define the si@e of the input f ield.
max3en5th 6ou use this attribute to define the maximum lenth of the userentries.
8/11/2019 Bsp Extensions
36/218
sho6Help6ou use this attribute to define "hether a button, "hich can be used todispla) the input help, should appear riht next to an inputfield. Please note that this attribute can onl) be set for date fields.
1isible 6ou use this attribute to define "hether the input field should be 'isibleor hiddenN in other "ords, "hether or not the BSP element should berendered in the BSP.
disabled6ou use this attribute to define "hether the input field is a'ailable forentr) at a certain time. If the input field is currentl) not a'ailable forentr), an) content that "as entered pre'iousl) is 1ra)ed out1.
1al,e 6ou use this attribute to define the default 'alue of the input field.
description 6ou use this attribute to define the eneral description test.
pass6ord 6ou use this attribute to define "hether the input field should bepass"ord protected.
ali5nment 6ou use this attribute to define the eneral text alinment. Possible'alues include 3I?5T and 2E*T.
cellGal,e 6ou use this attribute to define "hether or not the input field is in atable 'ie". T38E and *A2SE default/ are possible 'alues here.
decimals 6ou use this attribute to define the number of decimal places. This isonl) 'alid for binar) coded decimal B79/ data.
in1alid6ou use this attribute to define "hether the input field should berendered "ith an in'alid statusN in other "ords, it indicates that apre'iousl)-entered 'alue is in'alid.
is3abeled 6ou use this attribute to define "hether the input field should ha'e a
8/11/2019 Bsp Extensions
37/218
label see also label/.
first!afWeek6ou use this attribute to define the first da) of a "ee for thedate)a1i5atorelement help. Possible 'alues are # default/, 0,
, , $, , and D.
tpe 6ou use this attribute to define the data t)pe of the input field. Possible'alues include ST3I&?, 9ATE, TI4E, B79, B
8/11/2019 Bsp Extensions
38/218
Example
&oteSee also BSP application (B(:'$_H$&3B, pae inp,tfield.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
If )ou "ant to read the input f ield, this happens in the e'ent handlin phase in
8/11/2019 Bsp Extensions
39/218
23;(( 23_H$&3B_&;);' !'A)$) 3;!. !;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e1ent 7= 23_H$&3B_&;);'=>'$_'G')$-r,ntimeF>ser1erF>re,est .
A e1entF>id = 4s,bmitB,tton4 ;)! e1entF>e1ent_tpe = 4click4.
!;$;+ data $:' 'A $ 23_H$&3B_):C$A'3!.
data 7= 23_H$&3B_&;);'=>'$_!;$;- re,est = r,ntimeF>ser1erF>re,est name = 4inp,tAield4 id = 4mnp,tAield#4 . A data ( )$ )$;3. 1al,e = dataF>1al,e. ')!A.
')!A.
&ote that all data that "as reproduced for an element is "ritten explicitl) in the element class. The class23_H$&3B_):C$A'3!is used for this purpose for inp,tAieldelements. 5T42B manaer returnsan instance of this class.
Data Bin$in, .ith C&/BS'/M!DE&
In the context of the 4odel Hie" 7ontroller 4H7/ desin pattern, basis class 72;BSP;4
8/11/2019 Bsp Extensions
40/218
the model.
in'alid 'alue 7annot be o'er"ritten
maxlenth 'alue7an onl) be o'er"ritten if it is not a'ailable in the modeldata.
onHalue5elp readin 'alue 7an be o'er"ritten
pass"ord readin -
re(uired readin -
sho"5elp 'alue 7annot be o'er"ritten
si@e 'alue7an onl) be o'er"ritten if it is not a'ailable in the model
data.
t)pe 'alue7annot be o'er"ritten. &o data con'ersion taes place inthe element durin model bindin.
'aluereadin and"ritin
-
'isible readin -
decimals 'alue
ip# an$ ric5#
8/11/2019 Bsp Extensions
41/218
Please note that the attributes in1alidand re,iredare neither set nor e'aluated b) theinp,tAieldelement itself. The application is responsible for reconi@in in'alid or missin userentries and settin the correspondin attributes, if necessar).
&ormall), )ou should not set the "idth of the inp,tAieldelement "ith the eneral attribute6idth. Instead, )ou should use the element-specific attribute siIe, "hich functions exactl) lie
the correspondin attribute of the 5T42 ta. The 'alue of siIeis specified incharacters instead of pixels and is correctl) alined "ith font si@es and units of measurement.
When the sho6Helpattribute is set, a s)mbol appears on the riht next to the inp,tAieldelement, "hich loos 'er) similar to a button for a drop!o6n3istBox. *or input fields that arebound to a data source of t)pe date, there is a built-in help function a'ailable. In this case, adialo box appears "ith a date)a1i5atorelement. 8sers can choose an) da) in the calendar'ie". The s)stem automaticall) returns the correspondin date to the input field.
Further information
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
*or more information about BSP extensions, seeBS' Exten#ion#.
IS CRM/BS'/IC &ABE&
Functionality
This Business Ser'er Pae BSP/ element maes a label a'ailable for an inputFiel$.
Attri"ute#
Name !"li,atory De#cription
id 8ni(ue name that identifies the Business Ser'er Pae BSP/ element. This attributeis used in e'ent handlin and data handlin.
for : 6ou use this attribute to specif) the input field for "hich the label should appear.
text 6ou use this attribute to specif) the text that should appear before the input field.
desi5n
6ou use this attribute to define the font in "hich the output text should appear. *orexample, a text can be displa)ed as the topmost headin, or in normal font.Possible 'alues include STA&9A39 default/, 5EA9E30, 5EA9E3, 5EA9E3,E4P5ASIOE9, 2ABE2, 2ABE2S4A22, 2E?E&9, 3E*E3E&7E.
re,ired 6ou use this attribute to define "hether the input field is a mandator) input field.
8/11/2019 Bsp Extensions
42/218
encode 6ou use this attribute to define the codin.
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "hen thecursor mo'es o'er the label in front of the input field.
6idth6ou use this attribute to define the text lenth for the label. 9ependin on "idth andthe lenth of the text, )ou can use the follo"in attribute to define "hether thes)stem should use a return to "rap the text "ithin the cell.
6rappin5 6ou use this attribute to define "hether the label text in front of the input field shouldbe "rapped or "hether it should remain on one line. *or more information, see thepre'ious attribute.
hidden 6ou use this attribute to define "hether the label should be displa)ed. ?enerall)used for accessibilit) to allo" clear assinment of labels to input fields.
Example
See BSP application (B(:'$_H$&3B, pae 3abel.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for Incomin, Re-ue#t#
Data Bin$in, .ith C&/BS'/M!DE&
In the context of the 4odel Hie" 7ontroller 4H7/ desin pattern, basis class 72;BSP;4
8/11/2019 Bsp Extensions
43/218
Attri"uteBin$in,ype
)alue fromBin$in, toAttri"ute
Comment
desin readin -
for readin -If this attribute is bound, it does not mean that the 'alue of the model fieldis used as the 1for1 attribute. It means that label and input*ield can bebound to the same model element.
id readin for 7an be o'er"ritten. If the attribute is not specified, the label I9 isenerated from the 1for1 attribute b) addin 1;01.
re(uired readin -
text readin for
7an be o'er"ritten. The text can be bound as an attribute to a modelfield. If it is not specified or bound, it is re(uired that the 1for1 attribute bebound. In this case, the text is retrie'ed from the label of the 1for1attribute. If more than one label is specified in the data dictionar), short,medium, and lon texts are possible/, the s)stem searches in these(uence 1medium -% lon -% short1 to find a label that is not blan.
tooltip readin for
See pre'ious comment. If the 'alue is to be retrie'ed from the bound 1for1
attribute, the s)stem chooses the lon label.
Further information
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
*or more information about BSP extensions, seeBS' Exten#ion#.
IS CRM/BS'/IC &INK
Functionality
This Business Ser'er Pae BSP/ element pro'ides a h)perlin function for internal elements.
Note
We recommend that )ou al"a)s use relati'e 832s in )our BSP applications.
The BSP element linki'es )ou more flexibilit) since it can include a textGie6or ima5eelement, forexample. The most important attribute, reference, defines the taret 832 for the lin in the usual
8/11/2019 Bsp Extensions
44/218
8/11/2019 Bsp Extensions
45/218
disabled 9efines "hether the lin should onl) be displa)ed, but not possessan) na'iation functions.
foc,s 9efines "hether there is a na'iation focus on the linN that is,"hether users can access the lin b) usin a e) combination.
priorit 9efines the priorit) of the lin. If priorit) G 0, focus is set to this lin.
tabindex 9efines in "hich se(uence the lins should be accessed.
6rappin5 This attribute defines "hether the text of the lin can be "rapped.
Example
Sample la)out for a lin "ith text and tooltip, as "ell as a lin "ith an imae
&oteSee also BSP application (B(:'$_H$&3B, pae link.bsp.
E+ent han$lin,
8/11/2019 Bsp Extensions
46/218
A BSP element can ha'e man) e'ents. The BSP element linkhas onl) one sinle e'ent handler,on2lick, "hich is transferred "hen users clic on a h)perlin.
&ormall), )ou implement )our user interface elements b) usin a element in the la)out of )ourBSP that refers bac to the same pae. In this standard case, )ou enerate the codin for the e'enthandlin in the e1ent_id. ... handle H$&3B e1ent... ')!A.
6ou can implement handlin of 5T42B e'ents in t"o "a)s. The first techni(ue in'ol'es retrie'in the e'entdata and subse(uentl) processinthe data normall) in a lare casestatement/. The alternati'e in'ol'estrierin an e'ent at a user-instanced e'ent class.
Scenario 0 ?et the e'ent and process the data
In this case, the 5T42B manaer is called up to et a reference to a eneric e'ent obCect of t)pe23_H$&3B_'G')$. 6ou can use attributes name and e1ent_tpein this e'ent obCect inorder to determine "hich ind of e'ent is a'ailable. If the element supports attribute id, )ou canuse the idattribute to find out "hich element triered the e'ent. *or detailed e'ent data,construct the e'ent obCect from an e'ent obCect "ith the appropriate t)pe. In this case, )ou "oulduse a linke'ent. *or more information about the linke'ent, see class23_H$&3B_'G')$_3)M. !;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e1ent = 23_H$&3B_&;);'=>5et_e1ent- r,ntimeF>ser1erF>re,est . A e1entF>name = 4 link 4 ;)! e1entF>e1ent_tpe = 4click4. !;$;+ link_e1ent $:' 'A $ 23_H$&3B_'G')$_3)M. link_e1ent 7= e1ent. " na1i5ationF>5oto_pa5e- link_e1entF>reference .
" ret,rn. ')!A.&otePlease note that for BSP element and the on2licke'ent, the correspondin e'ent classis 23_H$&3B_'G')$_3)M.
Scenario
The interface IF/HM&B/E)EN is a'ailable for e'ent handlin. This interface contains methodsfor all BSP elements that are used in BSP extension 5T42B and that use e'ents.The e'ent can trier a user-specific e'ent handler class. In this case, the e'ent handlin class canbe an) user-defined class )ou lie, as lon as it implements interface A_H$&3B_'G')$and aninstance has been enerated. &ormall), )ou can use the application class to handle specifice'ents. The onl) prere(uisite for usin the application class is that it must implement interfaceA_H$&3B_'G')$.
In the follo"in example, a separate class called 23_H$&3B_'G')$_';&:3'is used fore'ent handlin !;$;+ e1ent_handler $:' 'A $ 23_H$&3B_'G')$_';&:3'. 2';$' BK'2$ e1ent_handler. 23_H$&3B_&;);'=>dispatch_e1ent- re,est = r,ntimeF>ser1erF>re,est e1ent_handler = e1ent_handler
8/11/2019 Bsp Extensions
47/218
pa5e_context = pa5e_context .The linktriers e'ent A_H$&3B_'G')$L3)M_232M.
'arameter De#cription
! I9 of the element that is used
)_232M &ame of the e'ent handler that "as entered b) the user
'A'')2' 3eference parameter that "as oriinall) specified in the lin element that "asreturned
&oteAll the link-clic e'ents for all the h)perlins on the pae are triered b) this method. As theprorammer, ensure that )ou choose the correct I9 to decide "hich lin is triered.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
ip# an$ ric5#
If )ou "ant to displa) a lin as an imae, use an element see example/.
6ou can also use the BSP element link"ith other elements as $extGie6or ima5eascontent. &ote that due to eneral 5T42 limitations, the beha'ior of h)perlins cannot beuaranteed and is hihl) dependent on the capabilities of the bro"ser.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC &ISB!%IEM
Functionality
This Business Ser'er Pae BSP/ element maes a'ailable embedded list items for dropDownListBoxand forListBox.
This element has no internal element structure.
Attri"ute#
Name !"li,atory De#cription
ke : 6ou use this attribute to define the uni(ue e) of the list item.
selected 6ou use this attribute to define "hether the list item is selected.
8/11/2019 Bsp Extensions
48/218
1al,e : 6ou use this attribute to define the content of the list item.
back5ro,nd2olor6ou use this attribute to set the color of the bacround of an entr) in thelist box. 6ou can specif) the color usin the hexadecimal 'alue of thecolor or b) directl) enterin its name such as bro"n or dar blue/.
text2olor8se this attribute to determine the color of the text to be displa)ed. 6oucan specif) the color usin the hexadecimal 'alue of the color or b)directl) enterin its name such as bro"n or dar blue/.
Example
See the examples indropDownListBoxandListBox.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
+crmico'erflo"7ontainer%
IS CRM/BS'/IC RADI!BU!N
Functionality
6ou can use this BSP element to implement the concept of a sinle radio button. Since radio buttons al"a)s
appear in roups of loicall) related radio buttons, )ou need the roupin BSP elementradioButtonGroup.
Attri"ute#
Name !"li,atory De#cription
id :8ni(ue name that identifies the Business Ser'er Pae BSP/ element. Thisattribute is used in e'ent handlin and data handlin.
8/11/2019 Bsp Extensions
49/218
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "henthe cursor mo'es o'er the radio button.
checked6ou use this attr ibute to define "hether the radio button is selected. T38Emeans that it is selected. If )ou do not assin a 'alue to this attribute, it isnot selected.
encode
6ou use this attr ibute to define the codin. T38E and *A2SE are thepossible 'alues here. When this attribute is set to T38E, the text is "rittenas 5T42 source text. Example text G 1This text is +b%displa)ed+!b%perfectl) and has a tooltip.1 In this example, the "ord 1displa)ed1 appears inbold. When this attribute is set to *A2SE, the text appears exactl) as itstands.
text 6ou use this attribute to define the descripti'e text that precedes the radiobutton.
on2lick 6ou use this attr ibute to set the e'ent handler, "hich is called "hen usersselect the radio button. An e'ent is sent to the ser'er.
5ro,pd I9 of the button roup. If this is set, the external element radioButton?rp isno loner necessar).
on2lient2lick 6ou use this attr ibute to set the client-side e'ent handler, "hich is called"hen users select the radio button.
disabled 6ou use this attr ibute to define "hether the radio button can be chosen inorder to trier the 72I7> e'ent.
foc,s 9efines "hether there is a na'iation focus on the radio buttonN that is,"hether users can access the radio button b) usin a e) combination.
priorit 9efines the priorit) of the radio button. If priorit) G 0, focus is set to this radio
8/11/2019 Bsp Extensions
50/218
button.
Example
See example inradioButtonGroup.
&oteSee also BSP application (B(:'$_H$&3B, pae radiob,tton5ro,p.bsp.
E+ent han$lin,
A BSP element can ha'e man) e'ents. The BSP element radioB,ttonhas onl) t"o e'ent handlerson2lickand on2lient2lick.
&ormall), )ou implement )our user interface elements b) usin a element in the la)out of )ourBSP that refers bac to the same pae. In this standard case, )ou enerate the codin for the e'enthandlin in the e1ent_id. ... handle H$&3B e1ent... ')!A.
6ou can implement handlin of 5T42B e'ents in t"o "a)s. The first techni(ue in'ol'es retrie'in the e'entdata and subse(uentl) processin the data normall) in a lare casestatement/. The alternati'e in'ol'estrierin an e'ent at a user-instanced e'ent class.
Scenario 0 ?et the e'ent and process the data
In this case, the 5T42B manaer is called up to et a reference to a eneric e'ent obCect of t)pe23_H$&3B_'G')$. 6ou can use attributes nameand e1ent_tpein this e'ent obCect inorder to determine "hich ind of e'ent is a'ailable. If the element supports attribute id, )ou canuse the idattribute to find out "hich element triered the e'ent. *or detailed e'ent data,construct the e'ent obCect from an e'en t obCect "ith the appropriate t)pe. In this case, )ou "oulduse a radioB,ttone'ent. *or more information about the radioB,ttone'ent, see class23_H$&3B_'G')$_;!BC$$). !;$;+ e1ent $:' 'A $ 23_H$&3B_'G')$. e1ent = 23_H$&3B_&;);'=>5et_e1ent- r,ntimeF>ser1erF>re,est . A e1entF>name = 4radioB,tton4 ;)! e1entF>e1ent_tpe = 4click4. !;$;+ radiob,tton_e1ent $:' 'A $23_H$&3B_'G')$_;!BC$$). radiob,tton_e1ent 7= e1ent. ')!A.
&otePlease note that for BSP element and the on2lick e1ents, thecorrespondin e'ent class is 23_H$&3B_'G')$_;!BC$$).
Scenario
The interface IF/HM&B/E)EN is a'ailable for e'ent handlin. This interface contains methodsfor all BSP elements that are used in BSP extension 5T42B and that use e'ents.The e'ent can trier a user-specific e'ent handler class. In this case, the e'ent handlin class canbe an) user-defined class )ou lie, as lon as it implements interface A_H$&3B_'G')$and an
8/11/2019 Bsp Extensions
51/218
instance has been enerated. &ormall), )ou can use the application class to handle specifice'ents. The onl) prere(uisite for usin the application class is that it must implement interfaceA_H$&3B_'G')$.In the follo"in example, a separate class called 23_H$&3B_'G')$_';&:3'is used fore'ent handlin !;$;+ e1ent_handler $:' 'A $ 23_H$&3B_'G')$_';&:3'. 2';$' BK'2$ e1ent_handler.
23_H$&3B_&;);'=>dispatch_e1ent- re,est = r,ntimeF>ser1erF>re,est e1ent_handler = e1ent_handler pa5e_context = pa5e_context .The radioB,ttonelement triers e'ent A_H$&3B_'G')$L;!BC$$)_232M ,"hich also contains the follo"in additional parameters
o !
I9 of the element that is usedo )_232M
&ame of the e'ent handler that "as entered b) the userThe on2lickattribute is for all triered e'ents. This is the user-assined name for the e'enthandler method.&oteAll the radioB,tton-clic e'ents for all the radio buttons on the pae are triered b) thismethod. As the prorammer, ensure that )ou choose the correct I9 to decide "hich radio button istriered.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, see2
IS CRM/BS'/IC RADI!BU!N(R'
Functionality
This Business Ser'er Pae BSP/ element arranes a roup of radio buttons ra$ioButton/ into columns.
8/11/2019 Bsp Extensions
52/218
8/11/2019 Bsp Extensions
53/218
&oteSee also BSP application (B(:'$_H$&3B, pae radiob,tton5ro,p.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
If )ou "ant to read the selected status of a radio button, this happens in the e'ent handlin phase in'$_!;$;- re,est = r,ntimeF>ser1erF>re,est name = 4radioB,ttonro,p4 id = 4madioB,ttonro,p#4 .
A radioB,ttonro,p ( )$ )$;3. selection = radioB,ttonro,pF>selection.')!A.
&ote that all data that "as reproduced for an element is "ritten explicitl) in the element class. The class
23_H$&3B_;!BC$$)C:is used for this purpose for
radioB,ttonro,pelements. 5T42B
manaer returns an instance of this class.
The follo"in attributes are reproduced or set
('3'2$)
ip# an$ ric5#
Initiall), none of the radio buttons in the roup is selected. When )ou create this element, )ou
should al"a)s explicitl) set the selectionattribute.
If )ou do not set col,mn2o,ntexplicitl), the s)stem assumes )ou "ant one sinle column.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
8/11/2019 Bsp Extensions
54/218
IS CRM/BS'/IC AB&E)IE*
Functionality
This Business Ser'er Pae BSP/ element displa)s mass data usin a la)out similar to a table TableHie"/.
Tables are useful in man) business applications. The tableGie6element is data-orientedN in other "ords,it relies hea'il) on the concept of data bindin. Therefore, the most important attribute is table, to "hiche'er) appropriate external table must be assined. A tableGie6element "ithout a correspondin datasource is useless.
In certain cases, a tableGie6element should not displa) the entire contents of the data source, but onl)a certain number of lines in a certain area. The amount of ro"s that is 'isible can be defined or limited b)usin the attributes 1isibleAirsto6and 1isibleo62o,nt. In the former attribute, the index ofthe first 'isible line of the data source is sa'ed, "hile in the latter attribute, the total number of 'isible ro"s isdefined. Please note that the ro" area defined b) these attributes should be a subset of the data that isactuall) made a'ailable b) the data source. If the data source contains fe"er ro"s than1isibleo62o,ntre(uires, the tableGie6element displa)s the missin ro"s as blan ro"s b)default. 6ou can a'oid this b) deletin the fillCp'mpto6sattribute. If the data source contains no
data, for example due to a failed database (uer), )ou should define a text for attribute empt$able$extthat lets the user no" "hat happened.
A tableGie6element can ha'e a title bar, column headins, and a footer. The title bar onl) appears if theheader$extattribute is defined. To acti'ate the column titles or the footers, set the headerGisibleorfooterGisibleattributes. B) default, the footer contains the status displa) "ith the amount of tablero"s that are currentl) 'isible. If the na1i5ation&odeattribute is defined, buttons also appear in thefooter. These buttons allo" na'iation "ithin the tableGie6element.
A tableGie6element is made up of an internal element tableiewCols, "hich in turn ma) containone or more tableiewColumnelements.
Attri"ute#Name !"li,atory De#cription 'o##i"le )alue#
id :
8ni(ue name thatidentifies the BusinessSer'er Pae BSP/element. This attributeis used in e'enthandlin and datahandlin.
Strin, such as m)TableHie"
table :6ou use this attributeto define the table thatis to be rendered.
Table name, predefined ABAP t)pe9ATA
desi5n
6ou use this attributeto define the currentdesin for renderinthe table 'ie".
STA&9A39 default/, A2TE3&ATI&?and T3A&SPA3E&T
8/11/2019 Bsp Extensions
55/218
headerGisible6ou use this attributeto define "hether theheader is 'isible.
*A2SE default/ and T38E
col,mnHeaderGisible
6ou use this attributeto define "hethercolumn titles are'isible.
T38E default/ and *A2SE
col,mn!efinitions
Table for definin thestandard beha'ior ofcolumns.
9ISP2A6;BEE andE9IT;BEE areespeciall) effecti'e fordefinin the renderinbeha'ior for displa)and chane mode. Werecommend usin thistable, instead ofinternal elements, todefine "hich columnsare rendered.
See structure TAB2EHIEW7
8/11/2019 Bsp Extensions
56/218
deacti'ate theautomatic population ofblan table ro"s if thenumber of currentl)'isible table ro"s isless than the numberof the counted 'isible
table ro"s see'isible3o"7ount/.
filter 6ou use this attributeto define a filter.
&
8/11/2019 Bsp Extensions
57/218
ro"s and dependinon "hich ro" "asselected. In this "a),)ou define that, after acertain ro" anddependin on this ro",somethin should
happen. 6ou candefine "hat shouldhappen usincolumn9efinitions oro'erWrite9efinitions.
keep(electedo6
6ou use this attributeto define that theselection should beept 'isible if thisattribute is set to T38Eand the application
taes on the sortinfunction.
*A2SE default 'alue, "hich means thatthe 'isible*irst3o" attribute is notchaned/ and T38E
ke2ol,mn
8ni(ue e) columnname/ in the table thatlets )ou use the fullcapabilities of thetable, such asautomatic filterin andsortin.
7olumn name of the table
o1erWrite!efinitions
8/11/2019 Bsp Extensions
58/218
na1i5ation&ode
9efinition of ho" thetable 'ie" responds toscrollin commands. Ifthe footer is 'isible, theinformation that isdispla)ed there
includes either therane of 'isible ro"s orthe rane of 'isiblepae numbers,dependin on thena'iation mode.
B6PA?E default/ and B62I&E
selection&ode Selection options forthe user
&
8/11/2019 Bsp Extensions
59/218
side e'ent handler thatis called up "hen atable ro" is selected.
1isibleAirsto66ou can use thisattribute to define"hich ro" should bethe first ro" dispa)ed.
0 default/, or an) numeric 'alue
1isibleo62o,nt
Specification of ho"man) table ro"sshould be 'isible. B)default, all table ro"sare 'isible "hen thetable is created.
&umeric 'alue
ro62o,nt6ou use this attributeto define the number ofro"s in the table.
&umeric 'alue
empt$able$ext
6ou use this attributeto define the text thatappears in a table "ithno contents.
Table is empt) default 'alue/
selectedo6ndex
6ou use this attributeto define an index forthe ro"s that arecurrentl) selected.
selectedo6Me
6ou use this attributeto define a e) for thero"s that are currentl)selected.
s,mmar 6ou use this attributeto define summar)information about atable that can be readb) an externalproram. This attributeis important for
8/11/2019 Bsp Extensions
60/218
accessibilit) purposes.
foc,s
9efines "hether thereis a na'iation focus
on the tableN that is,"hether users can oto the table b) usin ae) combination.
priorit
9efines the priorit) ofthe table. If priorit) G 0,focus is set to thistable.
Example
8/11/2019 Bsp Extensions
61/218
title = "ma5e" horiIontal;li5nment="center" >
8/11/2019 Bsp Extensions
62/218
tpe = "ima5elink" link2ol,mnMe = "linkcarrid" link2lick$ar5et = "_blank" title = "ma5e3ink" *>
&oteSee also BSP application (B(:'$_H$&3B, pae tableGie6.bsp.
ip# an$ ric5#
The tableGie6element automaticall) ets the appropriate field labels from the dictionar)information of the table t)pes if a'ailable/ and displa)s them as column headins. Hea$in,is usedas the default field label. If )ou need to mae a'ailable )our o"n column headins, create a field
catalo for the tableGie6element.
The tableGie6element al"a)s hides the client column field name 4A&9T/ for dictionar) tablet)pes.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC AB&E)IE*C!&S
Functionality
This Business Ser'er Pae BSP/ element maes a "rapper for table entries a'ailable for a ta"le)ie.element.
The internal element structure of this element is made up of indi'idual tableiewColumn elements.
Attri"ute#
There are no attributes for this BSP element.
Example
See example intableiew.
&oteSee also BSP application (B(:'$_H$&3B, pae $ableGie6.bsp.
E+ent han$lin,
8/11/2019 Bsp Extensions
63/218
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC AB&E)IE*C!&UMN
Functionality
This Business Ser'er Pae BSP/ element maes a'ailable indi'idual table columns of a
ta"le)ie.Column#of a tableiewelement.
Attri"ute#
Name !"li,atory De#cription
col,mn)ame : 6ou use this attribute to define name of the table column.
encode
6ou use this attribute to define the codin. T38E and *A2SE arethe possible 'alues here. When this attribute is set to T38E, thetext is "ritten as 5T42 source text. When this attribute is set to
*A2SE default/, the text appears exactl) as it stands.
sort
6ou use this attribute to define sortin for the indi'idual ro"s.Possible 'alues include &
8/11/2019 Bsp Extensions
64/218
horiIontal;li5nment6ou use this attribute to define the hori@ontal alinment of an entr)"ithin the table cell. Possible 'alues include 2E*T, 7E&TE3default/, 3I?5T, =8STI*6, and 75A3.
s;ppendCnit6ou use this attribute to define that the data 'alue andcorrespondin unit should be output toether, rather than inseparate table columns.
link2lick$ar5et 6ou use this attribute to define a h)perlin to the taret.
link2ol,mnMe 6ou use this attribute to define a h)perlin to a column.
on2ell2lick 6ou use this attribute to define an e'ent handler for clicin on atable cell.
ontem2lick 6ou use this attribute to define an e'ent handler for clicin on anentr).
title 6ou use this attribute to define the title of a table column.
tooltip2ol,mnMe 6ou use this attribute to define a text for the tooltip. This textappears "hen the cursor mo'es o'er the table column.
tpe
6ou use this attribute to define ho" the entries in the columnshould be handled b) the renderer. The default 'alue is TE:T,
meanin that the column is formatted accordin to the t)peinformation or dictionar) information of the data source.Additionall), the follo"in 'alues are possible 2I&> cells appearas h)perlins/, I4A?E the column data is interpreted as 832s ofpictures/, E9IT the cells of this column can be chaned andappear as input fields/, and B8TT
8/11/2019 Bsp Extensions
65/218
,nit2ol,mnMe 6ou use this attribute to define "hich s)mbols the current columnshould contain for units of measure or currenc).
1ertical;li5nment
6ou use this attribute to define the 'ertical alinment of an entr)
"ithin the table column. Possible 'alues include T
8/11/2019 Bsp Extensions
66/218
id :8ni(ue name that identifies the Business Ser'er Pae BSP/ element. This attributeis used in data handlin.
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "hen the
cursor mo'es o'er the text edit element.
text 6ou use this attribute to specif) the text that should appear in front of the text editelement..
disabled 6ou use this attribute to define "hether the text edit element is a'ailable for entr).T38E and *A2SE default/ are possible 'alues here.
font 6ou use this attribute to enter the text font for the text edit element.
cols 6ou use this attribute to define the number of columns.
ro6s 6ou use this attribute to define the number of ro"s.
hei5ht 6ou use this attribute to define the heiht of the text edit element in pixels orpercentae.
6idth 6ou use this attribute to define the "idth of the text edit element in pixels orpercentae.
6rappin5
6ou use this attribute to define "hether the text "ithin a text edit element should
allo" "rappin. Possible 'alues include 5A39 default/, S
8/11/2019 Bsp Extensions
67/218
8/11/2019 Bsp Extensions
68/218
IS CRM/BS'/IC RA4
Functionality
6ou use this Business Ser'er Pae BSP/ element to define a frame around an internal element. 6ou cans"itch the 'isibilit) of the internal element b) usin the expand s)mbol in the element header.
The traelement is similar to the 5ro,pelementN the difference is that the tra) element offers additionalfunctions. In the collapsed state, it appears as a thin hori@ontal bar "ith a title and a s)mbol in the top rihtcorner for expansion. If )ou choose this s)mbol, the contents of this element are expanded, and therefore'isible. If )ou choose the s)mbol once aain, the element returns to the collapsed state.
Since the contents of the element can be an) imbedded element, a tracan be 'er) useful if )ou need tostore lare amounts of information in a small space. 5o"e'er, please note that tras increase thecomplexit) of )our pae and therefore decrease usabilit).
This element triers t"o different e'ents for expandin and collapsin the bod) elements on'xpandoron2ollapse, respecti'el).
The traelement is 'isuall) 'er) complex in appearance. It offers three different desins that areoptimi@ed for the most common applications.
The internal element structure is made up of a trayBodyelement.
Attri"ute#
Name !"li,atory De#cription
id :8ni(ue name that identifies the Business Ser'er Pae BSP/ element. This attributeis used in e'ent handlin and data handlin.
title 6ou use this attribute to define the tit le of the tra).
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "hen the cursormo'es o'er the tra).
6idth 6ou use this attribute to define the "idth of the tra).
hei5ht6ou use this attribute to define the heiht of the tra). 6ou can also mae heihtentries usin percentaes or "ith t"o parameters heiht in percentae, heiht inpixels/. Example heiht G 10##F,DD1
desi5n 6ou use this attribute to define the current desin for renderin the tra). Possible
8/11/2019 Bsp Extensions
69/218
'alues include B
8/11/2019 Bsp Extensions
70/218
The traelement is 'isuall) 'er) complex in appearance. It offers three different desins that areoptimi@ed for the most common applications.
The internal element structure is made up of a trayBodyelement.
Attri"ute#
Name !"li,atory De#cription
id :8ni(ue name that identifies the Business Ser'er Pae BSP/ element. This attributeis used in e'ent handlin and data handlin.
title 6ou use this attribute to define the tit le of the tra).
tooltip 6ou use this attribute to define a text for the tooltip. This text appears "hen the cursor
mo'es o'er the tra).
frame 6ou use this attribute to define the "idth of the frame around the tra). 9efault is oneline "ith a "idth of one pixel.
mode If this attribute is set to 9ISAB2E9 or 5IST
8/11/2019 Bsp Extensions
71/218
&oteSee also BSP application (B(:'$_H$&3B, pae tra.bsp.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC RA4B!D4
Functionality
6ou use this Business Ser'er Pae BSP/ element to roup the contents of a tra) bod). This element cancontain internal elements.
This BSP element is imbedded in atray.
Caution
This imbedded element is mandator).
Attri"ute#
There are no attributes for this BSP element.
Example
See example intray.
&oteSee also BSP application (B(:'$_H$&3B, pae tra.bsp.
E+ent Han$lin,
8/11/2019 Bsp Extensions
72/218
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
ip# an$ ric5#
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
IS CRM/BS'/IC RA4B!D46
Functionality
6ou use this Business Ser'er Pae BSP/ element to roup the contents of a tra) bod). This element cancontain internal elements.
This BSP element is imbedded in atray.
Caution
This imbedded element is mandator).
Attri"ute#
There are no attributes for this BSP element.
Example
See example intray.
&oteSee also BSP application (B(:'$_H$&3B, pae tra.bsp.
E+ent han$lin,
E'ents are not supported for this BSP element.
Data Extraction for In"oun$ Re-ue#t#
9ata handlin is not supported for this BSP element.
Further information
*or more information about BSP extensions, seeBS' Exten#ion#.
8/11/2019 Bsp Extensions
73/218
*or eneral information about BSP applications, seeBu#ine## Ser+er 'a,e#.
+crmictree%
+crmictree7olumn%
IS HM&B
Functionality
The 5T42 Business 5T42B/ 2ibrar) pro'ides an intuiti'e and eas)-to-understand librar) for de'elopinWeb content. With 5T42B de'elopers can
8se bro"ser-independent BSP elements in their BSP applications
Implement e'ents for handlin user actions in 'arious "a)s
3etrie'e user input
8se st)le sheets that are either predefined or user-defined, such as st)le sheets stored on a portal.
To do this, )ou simpl) specif) sapFtheme=in the 832.
The desin 'ariants 72ASSI7, 9ESI?# and 9ESI?# from SAP Web AS D.# Support PacaeQ/ are a'ailable in 5T42B.The indi'idual desin 'ariants are supported b) different bro"sers
9esin 72ASSI7
o 4icrosoft Internet Explorer from Hersion .#0
o &etscape &a'iator from Hersion D.#
9esin 9ESI?#
o 4icrosoft Internet Explorer from Hersion .#
o &etscape &a'iator from Hersion D.#
9esin 9ESI?#
o4icrosoft Internet Explorer from Hersion .#
o &etscape &a'iator from Hersion Q.#
&ote that "ith and "ithin table 'ie"s, replacin 1RR1 is not supported.
*or Enterprise Portal , 9ESI?# and 72ASSI7 are supportedN for Enterprise Portal D, 9ESI?#and 9ESI?# and 72ASSI7 are supported.
8/11/2019 Bsp Extensions
74/218
The 5T42B 2ibrar) for BSP is a'ailable in e'er) SAP Web Application Ser'er D.# S)stem or hiher/ in thecontext of ABAP Worbench for creatin Web applications "ith Business Ser'er Paes.
Ri,ht to &eft 7R&8
The standard "a) to "rite 4iddle Eastern lanuaes, for example, 5ebre" and Arabic, is from riht to left
3T2/. This is in contrast to left to riht 2T3/, as used in Indo-European lanuaes. 5o"e'er, in 4iddeEastern lanuaes left to riht is still used for numbers, for example, telephone numbers, postin items, andproper nouns. 7onse(uentl), 2T3 lanuaes often ha'e sentences containin a mixture of 3T2 and 2T3.
The BSP prorammin model supports 3T2. All BSP applications based on 5T42B or :5T42Bautomaticall) support the 3T2 la)out.
When )ou lo on to a BSP application, the BSP runtime determines the code paes appropriate for theloon data and sets the correct 'alue for the lanuae direction. If )ou lo on, for example, in 5ebre", thetext direction is automaticall) set to 3T2.
6ou can acti'ate 3T2 renderin usin the 832 parameter sapFrtl=tr,e. This onl) applies to the firstcall before the 832 manlin has been executed for the BSP-832.
To support 3T2, SAP pro'ides thetextDirectionattribute, and additional 'alues for ali5n!ali5nmentfor di'erse htmlb and xhtmlb elements for desi5n9008.
text!irectionhas been introduced for the follo"in BSP elements
htmlb
o 9"utton:
o 9chec5"ox:
o9fileUploa$:
o 9inputFiel$:
o 9la"el:
o 9lin5:
o 9ra$ioButton:
o 9textE$it:
o9text)ie.:
o 9treeNo$e:
xhtmlb
o toolbarButton
o toolbarInput*ield
8/11/2019 Bsp Extensions
75/218
o toolbarlin
The text!irectionattribute is implemented indirectl) usin the element9text)ie.:for the follo"inhtmlb elements
9ta"StripItem:
9li#tItem:
Indirect means that althouh the abo'e elements themsel'es do not contain a text!irection attribute,)ou can still use this attribute if a textGie6is used "ithin a tab(triptemor listtem
ali5nor ali5nmentor horiIontal;li5nmenthas been enhanced or implemented for thefollo"in BSP elements
htmlb
o inputFiel$
o text)ie.
o ,ri$&ayoutCell
xhtmlb
o toolbarInput*ield
o SapTable7ellne" column9efintion-forceText9irection2T3 attribute
o SapTable5eader7ell
Recommen$ation#
To use the full extent of 3T2 support Application 9e'elopers should eep the follo"in points in mind
A'oid nati'e 5T42. Instead, use the elements of the BSP extension 5T42B or :5T42B.
4ae sure that frames appear in the correct se(uence.
In 4S Internet Explorer frames are numbered in the se(uence the) are named in the source code.When frames are displa)ed, the) are rendered from left to riht and in the se(uence the) arenamed in the source code. This happens independentl) of the la)out se(uence.
In contrast to 2T3, "ith 3T2 frames should be arraned as follo"so The menu and content lists belon on the riht side
o The actual content belons on the left side
3emember that this mirrorin arranement does not happen automaticall).
6ou can can create 3T2 'ersions of )our o"n imaes imaes not pro'ided b) SAP/. 4ae sure
that the 3T2 'ersion of the imaes is also used in the application. 8ns)mmetrical imaes usuall)ha'e to be mirrored. All SAP s)mbols are automaticall) adCusted.
8/11/2019 Bsp Extensions
76/218
3emember to use the the ne" 'alues for ali5nali5nmentand horiIontal;li5nment/.9o not use H$"hen )ou actuall) mean ')!A3)'.
)alue &R Ali,nment R& Ali,nment De#cription
A2'!3'A$ 2eft 2eft 2eft
3'A$ 2eft 3iht Start of line
')!A3)' 3iht 2eft End of lineH$ 3iht 3iht 3iht
6ou can o'erride the direction of texts usin the text!irection attribute. 8se it toether "itha strin t)pe attribute in the follo"in cases
o If the text is user input, a telephone number, fax number, or an output text that has a fixedsi@e and must not be rearraned. *or example, the material number 0#Fk9F8,telephone number NS*?99T*TFTTor aircraft t)pe TTF00"ould be mistaenl)interpreted b) the standard alorithm as subtractions and the 'alues altered.
o If the text is an input field for an 2T3 text in an 3T2 context and 'ice 'ersa/.
o Example Input of names in Enlish in a 5ebre" or Arabic form.
Note
5T42 $.# is a pr