DrawLAF Java Bean - public properties

These properties can be set or read from any bean area

whose Implementation Class property is set to:

oracle.forms.fd.DrawLAF
Content
Drawing on the canvas............................................................................9
ADD_IMAGE.......................................................................................9
ADD_LINEAR_GRADIENT....................................................................10
ADD_LINE........................................................................................11
ADD_RECT.......................................................................................12
ADD_ELLIPSE...................................................................................13
ADD_TEXT........................................................................................13
ADD_SHAPE.....................................................................................14
ADD_TEXTUREPAINT..........................................................................15
SET_TEXT_LABEL..............................................................................16
POINT_TEXT_LABEL...........................................................................16
GET_TEXT_LABEL..............................................................................16
CLEAR.............................................................................................17
REMOVE_GRAPHIC............................................................................17
REMOVE_LINES.................................................................................17
REMOVE_RECTS................................................................................17
REMOVE_SHAPES..............................................................................17
REMOVE_ELLIPSES............................................................................17
REMOVE_TEXTS................................................................................18
TRANSFORM_GRAPHIC.......................................................................18
POINT_SHAPE_PROPERTY...................................................................18
SHAPE_GET_PROPERTY......................................................................19
SHAPE_SET_PROPERTY......................................................................19
SET_GRADIENT_COLORS....................................................................20
SET_GRADIENT_DIRECTION...............................................................20
SET_GRADIENT_TEXT........................................................................20
SET_H_CYCLE...................................................................................20
SET_V_CYCLE...................................................................................21
SET_GUI_PROPERTIES.......................................................................21
DRAW_GUI_ELEMENTS.......................................................................22
REFRESH..........................................................................................22
SET_CANVAS_RESIZED......................................................................22
SET_MOTIF.......................................................................................23
Canvas mouse event capture (since the 1.7.7 version)...............................24
CANVAS_MOUSE_MOVE.....................................................................24
The messages sent back to Forms........................................................24
Shape animation (since the 1.7.7 version)................................................25
SHAPE_MOVE_TO..............................................................................25
SHAPE_ROTATE_TO...........................................................................25
SHAPE_STRETCH_TO.........................................................................26
SHAPE_ADD_ANIMATION_STEP...........................................................26
SHAPE_PLAY_ANIMATION...................................................................26
SHAPE_CLEAR_ANIMATION.................................................................26
 ANIMATION_DELAY............................................................................27
The animation message sent back to Forms...........................................27
Sound properties .................................................................................28
PLAY_SOUND....................................................................................28
SET_SOUND_FILE.............................................................................28
SET_SOUND_BASE............................................................................28
Flashing Text properties ........................................................................30
SET_FLASH_FONT.............................................................................30
SET_FLASH_COLORS.........................................................................30
SET_FLASH_TEXT..............................................................................30
SET_FLASH_TEXT2............................................................................31
Frames properties.................................................................................33
SET_FRAME......................................................................................33
SET_FRAME_TEXT.............................................................................33
SET_FRAME_TEXT_ALIGNMENT...........................................................34
SET_FRAME_TEXT_OPAQUE................................................................34
SET_FRAME_FONT.............................................................................34
SET_FRAME_BACKGROUND................................................................35
SET_FRAME_COLORS.........................................................................35
SET_FRAME_GRADIENT_ORIENTATION.................................................35
SET_FRAME_ROUND_BORDER.............................................................36
SET_FRAME_BOUNDS........................................................................36
SET_FRAME_HCYCLE.........................................................................36
SET_FRAME_VCYCLE..........................................................................36
SET_FRAME_TITLE_COLOR.................................................................37
SHOW_FRAME..................................................................................37
HIDE_FRAME....................................................................................37
REMOVE_FRAME................................................................................37
REMOVE_ALL_FRAMES.......................................................................37
Input Dialog Box properties....................................................................38
SET_DIALOG_PROPS..........................................................................38
SET_INPUT_DIALOG..........................................................................38
Tabs properties.....................................................................................39
SET_TAB_COLORS.............................................................................39
SET_TAB_SELECTED_COLORS.............................................................39
SET_TAB_FONT.................................................................................39
SET_TAB_ITEM_ICON.........................................................................39
Window properties................................................................................41
SET_WIN_MDI_ICON.........................................................................41
SET_WINDOW_ICON..........................................................................41
SET_CURRENT_WINDOW_ICON...........................................................41
SET_ALL_WINDOWS_ICON.................................................................42
SET_WINDOW_PROPERTY...................................................................42
Dynamic Menus properties.....................................................................43
ADD_MENU......................................................................................43
ADD_MENU_OPTION..........................................................................43
 SET_STATUS_MENU...........................................................................44
SET_STATUS_MENU_OPTION..............................................................44
SET_VISIBLE_MENU..........................................................................44
SET_VISIBLE_MENU_OPTION..............................................................45
MOVE_WIN_MENU_OPTION................................................................45
SHOW_MENU_BAR............................................................................46
Status Bar properties............................................................................47
SET_STATUSBAR_VALUE....................................................................47
SET_STATUSBAR_INDEX....................................................................47
GET_STATUSBAR_VALUE....................................................................47
SHOW_STATUSBAR............................................................................48
SHOW_STATUSBAR_SECOND_LINE......................................................48
Color chooser properties........................................................................49
SET_COLORCHOOSER_VALUES ...........................................................49
GET_COLORCHOOSER_COLOR ...........................................................49
Socket Server properties........................................................................50
INIT_SERVER ...................................................................................50
STOP_SERVER .................................................................................51
SOCKET_SERVER_LOG ......................................................................51
List properties......................................................................................52
SET_ENHANCED_POPLISTS.................................................................52
SET_LIST_ORIENTATION....................................................................52
SET_MULTI_SELECTION.....................................................................52
SET_SORTED_LIST............................................................................52
SET_TIME_KEY_SELECT.....................................................................53
Alerts..................................................................................................54
DISPLAY_ALERT................................................................................54
GET_ALERT_BUTTON.........................................................................55
Scrolling Panel properties.......................................................................56
SET_SCROLL_PANEL_COLOR...............................................................56
SET_SCROLL_PANEL_BORDER.............................................................56
SET_SCROLL_ALLOW_LINKS...............................................................56
SET_SCROLL_PANEL_FONT.................................................................57
SET_SCROLL_PANEL..........................................................................57
SET_SCROLL_PANEL_TEXT.................................................................58
SET_SCROLL_TEXT_ERROR.................................................................58
SHOW_SCROLL_PANEL.......................................................................58
SET_SCROLL_HORIZONTAL_TOOLBAR..................................................58
SET_SCROLL_VERTICTAL_TOOLBAR.....................................................59
SET_SCROLL_PANEL_ESCAPE..............................................................59
SET_SCROLL_PANEL_FRAME...............................................................59
SET_SCROLL_PANEL_EXTENDS...........................................................59
SET_SCROLL_PANEL_INFO_TEXT.........................................................60
SET_SCROLL_PANEL_INFO_PROPERTIES..............................................60
SET_SCROLL_DURATION....................................................................60
SET_SCROLL_PANEL_LOG...................................................................60
Robot properties...................................................................................61
CREATE_ROBOT................................................................................61
SET_ROBOT_STEP.............................................................................61
SET_ROBOT_INFO_MENU...................................................................62
SET_ROBOT_FORMS_STEP..................................................................62
SET_ROBOT_FORMS_STEPS................................................................63
SET_ROBOT_FILE_NAME....................................................................63
SET_ROBOT_BUBBLE.........................................................................63
SET_ROBOT_SHAPE...........................................................................64
SET_ROBOT_BUBBLE_PROPERTIES......................................................64
SET_ROBOT_SHAPE_PROPERTIES........................................................65
SET_ROBOT_TEXT_PROPERTIES..........................................................65
SET_ROBOT_ABORT_SCRIPT...............................................................65
Script available keywords...................................................................66
Dynamic item properties........................................................................69
ADD_BUTTON...................................................................................70
ADD_TEXTFIELD (ADD_TEXTFIELD2)....................................................70
ADD_TEXTAREA (ADD_TEXTAREA2).....................................................70
ADD_CHECKBOX...............................................................................70
ADD_SLIDER....................................................................................71
ADD_LABEL......................................................................................71
ADD_PASSWORDFIELD.......................................................................71
NEW_ITEM_PROPERTY.......................................................................71
ITEM_SET_PANEL..............................................................................74
NEW_ITEM_PANEL_PROPERTY.............................................................74
ITEM_DELETE_PANEL.........................................................................74
GO_ITEM.........................................................................................75
DELETE_ITEM...................................................................................75
ITEM_NAVIGATION_INSIDE................................................................75
ITEM_SET_INDICE.............................................................................75
ITEM_GET_VALUE..............................................................................76
Image item properties...........................................................................77
IMG_NEW.........................................................................................77
IMG_DELETE.....................................................................................78
IMG_DELETE_ALL..............................................................................78
IMG_SET_POSITION..........................................................................78
IMG_SET_LEGEND.............................................................................78
IMG_SET_BACKGROUND....................................................................79
IMG_CLEAR......................................................................................79
IMG_READIMGFILE............................................................................79
IMG_READIMGBASE...........................................................................79
IMG_SCALE_IMAGE...........................................................................80
IMG_CENTER_IMAGE.........................................................................80
IMG_LABEL_COLOR...........................................................................80
IMG_SET_SCROLLBARS......................................................................80
IMG_SET_BORDER............................................................................81
 IMG_SET_TOOLTIP............................................................................81
IMG_SET_FILECHOOSER_TITLE...........................................................81
IMG_GET_FILE_NAME........................................................................82
IMG_GET_IMAGE_SIZE......................................................................82
IMG_GET_IMAGE_WIDTH...................................................................82
IMG_GET_IMAGE_HEIGHT..................................................................82
IMG_SET_DBLCLICK_SHOW_IMAGE.....................................................83
IMG_SET_LOG..................................................................................83
Popup menu properties..........................................................................84
CREATE_POPUP_MENU.......................................................................84
ADD_POPUP_MENU_OPTION...............................................................84
SET_POPUP_MENU............................................................................85
SET_POPUP_MENU_FONT...................................................................85
SET_POPUP_MENU_FONT_COLOR........................................................85
SET_POPUP_MENU_ICON...................................................................85
SET_POPUP_MENU_OPTION_PROPERTY................................................86
SHOW_POPUP_MENU.........................................................................86
REMOVE_POPUP_MENU_OPTION..........................................................87
DELETE_POPUP_MENU.......................................................................87
The messages sent back to Forms........................................................88
Asynchronous JDBC calls (since the 1.6.7 version).....................................89
DB_SET_DBINFO...............................................................................89
DB_SET_USER..................................................................................89
DB_SET_PWD...................................................................................90
DB_SET_PROCEDURE.........................................................................90
DB_SET_FUNCTION...........................................................................90
DB_SET_POPUP.................................................................................90
The messages sent back to Forms........................................................91
External command calls (since the 1.6.8 version)......................................92
SET_EXT_PROG.................................................................................92
Image Spinner (since the 1.7.1 version)..................................................93
IMAGE_SPINNER_NEW.......................................................................93
IMAGE_SPINNER_SET_LOCATION........................................................93
IMAGE_SPINNER_SET_SIZE................................................................93
IMAGE_SPINNER_SET_BACKGROUND...................................................93
IMAGE_SPINNER_SET_BORDER...........................................................94
IMAGE_SPINNER_SET_LEGEND_HALIGN...............................................94
IMAGE_SPINNER_SET_LEGEND_VALIGN...............................................94
IMAGE_SPINNER_SET_LEGEND_FONT..................................................95
IMAGE_SPINNER_SET_LEGEND_COLORS..............................................95
IMAGE_SPINNER_SHOW_LEGEND........................................................95
IMAGE_SPINNER_SET_LABELS............................................................95
IMAGE_SPINNER_SET_IMAGE.............................................................96
IMAGE_SPINNER_SET_IMAGE_BASE....................................................96
IMAGE_SPINNER_SET_SCALE.............................................................97
IMAGE_SPINNER_SET_MAX_SIZE........................................................98
 IMAGE_SPINNER_REFRESH.................................................................98
IMAGE_SPINNER_CLEAN....................................................................99
IMAGE_SPINNER_DISPLAY..................................................................99
IMAGE_SPINNER_SET_MAGNIFIER.......................................................99
IMAGE_SPINNER_REMOVE..................................................................99
IMAGE_SPINNER_SET_CURRENT.........................................................99
IMAGE_SPINNER_GET_NEW_LIST......................................................100
IMAGE_SPINNER_SET_CURRENT_IMAGE.............................................100
IMAGE_SPINNER_SET_KEEP_SIZE.....................................................102
The message sent back to Forms.......................................................103
Dynamic table-blocks (since the 1.7.5 version)........................................104
The message sent back to Forms.......................................................107
Video player (since the 1.7.6 version)....................................................108
QUICKT_SET_PANEL........................................................................108
QUICKT_SET_PANEL_BORDER ..........................................................108
QUICKT_SET_PANEL_COLOR ............................................................108
QUICKT_SET_MOVIE .......................................................................109
QUICKT_SET_MOVIE_BASE...............................................................109
QUICKT_SET_LOAD_AND_PLAY ........................................................109
QUICKT_START_MOVIE ...................................................................110
QUICKT_STOP_MOVIE .....................................................................110
QUICKT_GOTO ...............................................................................110
QUICKT_INC_VOLUME .....................................................................110
QUICKT_DEC_VOLUME ....................................................................110
QUICKT_SET_FRAME_TITLE .............................................................110
QUICKT_SET_FRAME_MOVIE_SIZE ....................................................111
QUICKT_REMOVE_PANEL .................................................................111
Miscellaneous.....................................................................................112
DISPLAY_MESSAGE..........................................................................112
GET_SCHEME_COLOR ......................................................................112
DRAW_FOCUS_LINES ......................................................................112
GET_SCHEME_COLOR_LIGHT............................................................113
SET_APPLY_SCHEME........................................................................113
SEARCH_TEXT_ITEMS......................................................................113
GET_INPUT_DIALOG........................................................................113
SHOW_ABOUT.................................................................................114
GET_SCHEME..................................................................................114
GET_TEXT_HEIGHT..........................................................................114
GET_TEXT_SIZE..............................................................................114
GET_TEXT_WIDTH...........................................................................114
SET_SCHEME..................................................................................115
SET_TEXT.......................................................................................115
SET_ALL_HYPER_LINK_COLORS........................................................116
SET_CBOX_BG_COLOR.....................................................................116
SET_SCHEME_COLORS.....................................................................116
SET_QUICK_EXIT............................................................................117
SHOW_IN_RECT..............................................................................117
OPEN_DIALOG................................................................................118
GET_FILE_NAME..............................................................................118
SET_DESKTOP.................................................................................118
SET_DEFAULT_PRINTER....................................................................118
GET_DEFAULT_PRINTER...................................................................119
GET_PRINTER_LIST.........................................................................119
GET_USER_IP.................................................................................119
FORMS_SERVER_URL.......................................................................120
SET_LOG........................................................................................120
Drawing on the canvas

ADD_IMAGE

Add an image on the current canvas.

property value:

name,full_image_name,X_pos,Y_pos[,transparency_level[,width
,height[,clicked_image_name]][mirrored_image]]

name is a unique object name

image can be read:

● from the jar file : /image.gif

● from the client machine : c:/image.jpg
● from an internet url: http://…

X_Pos can include the following keywords:

● LEFT
● CENTER
● RIGHT
● IMAGEWIDTH
● IMAGEWIDTH/2

That can be combined together.

For instance; if you want to attach the image to the right border of the canvas, enter as
follows:

RIGHT-IMAGEWIDTH

Center the image:

CENTER-IMAGEWIDTH/2

Right border minus 10 pixels:

RIGHT-10

Y_Pos can include the following keywords:

● TOP
● CENTER
● BOTTOM
● IMAGEHEIGHT
● IMAGEHEIGHT/2

Image centered on both axis:

 CENTER-IMAGEWIDTH/2,CENTER-IMAGEHEIGHT/2

transparancy_level must be a value between 0 and 1. 0 is completely transparent and 1 is

completely opaque.

width and height can be used to enforce an image to fit to the required size. The special
value -1 can be used on width or height to keep the aspect ratio.

For example, if you want to scale the image to 300 pixels width and keep the aspect ratio on
the height, put a -1 value in place of the height value:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ADD_IMAGE'
,'1,c:/images/image1.jpg,100,50,1,300,-1);

If you want to scale the image on the height axis and keep the aspect ratio on the width axis,
put -1 in place of the width argument:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ADD_IMAGE'
,'1,c:/images/image1.jpg,100,50,1,-1,300);

clicked_image_name can be used to set the image sensitive, so that it could be clicked to
send a message to the Bean Area through the When-Custom-Item-Event trigger.
In this case, the EventName is IMAGE_CLICKED and the corresponding value is stored in the
IMAGE_NAME attribute.

mirrored_image, if true draw a reflected image under the normal image.

If you do not specify the previous parameters, replace them by a -

When-Custom-Item-Event trigger:

If (EventName = 'IMAGE_CLICKED') then

get_parameter_attr(BeanValListHdl,'IMAGE_NAME',ParamType, param1);
message('Image clicked:' || param1, no_acknowledge);
End if;

If you want to set an image sensitive without providing the previous arguments (transparency,
width and height, set the special value - to them:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1
,'ADD_IMAGE','1,c:/images/image1.jpg,1,210,50,-,-,-,nom image1);

ADD_LINEAR_GRADIENT

Add a multi-stops sized linear gradient on the canvas

property value:

PosX,PosY,Width,Height,orientation,coefficients,colors,transparency_factor
PosX and PosY are the upper left corner, and must contain an integer positive value. It also
can be the following keywords:

● WITH or HEIGHT
● WITH/2, WITH/3 or WITH/4 - HEIGHT/2, HEIGHT/3 or HEIGHT/4

Width and Height are the dimensions of the gradient to be drawn. It also can be the following
keywords:

● WITH or HEIGHT
● WITH/2, WITH/3 or WITH/4 - HEIGHT/2, HEIGHT/3 or HEIGHT/4

orientation can be one of the following:

● UpToDown
● LeftToRight

coefficient should be width1[%][-width2[%][-widthx[%]]]

If you specify a percentage [%] the gradient will use this percentage to draw each pair of
corresponding gradient colors.
If not specified, the gradient is painted using the real pixel dimension given.

colors should be RGB pairs : RxGxBx-RxGxBx[-RxGxBx-RxGxBx[...]]

For each coefficient given you should give a pair of colors.

e.g.:

Set_Custom_Property('CTRL.BEAN',1,'ADD_LINEAR_GRADIENT',
'0,0,WIDTH/2,HEIGHT,UpToDown,20%-60%-20%,r50g50b50-r255g255b255-r255g255b255-
r50g50b50-r50g50b50-r255g255b255,.6');

The first gradient with the first 2 colours is painted on the first 20% of the total size given
The second gradient with the succeeding 2 colours is painted on the next 60% of the total size
given
The last gradient with the last 2 colours is painted on the last 20% of the total size given

The CSS corresponding tag is the following:

gradient-linear:0,0,WIDTH/2,HEIGHT,UpToDown,20%-60%-20%,r50g50b50-r255g255b255-
r255g255b255-r50g50b50-r50g50b50-r255g255b255,.6

You can have as many as you want in the CSS file.

ADD_LINE

Add a line on the current canvas

property value:

name,x1,y1,x2,y2,width[,color[,transparency_level[,cap,join,dash]]]
name is a unique object name
if color is not specified, the default is white (r255g255b255).
if you want to specify a transparency level but not the color, put - (minus) to the color

You can have a dashed line by providing the 3 last parameters:

cap is the end line style

Allowed values are:

● BUTT
● ROUND
● SQUARE

join is the join line style

Allowed values are:

● BEVEL
● ROUND
● MITER

dash is 2 integers separated by a comma.

The first integer gives the length in pixel of the visible segment
The second integer gives the length in pixel of the invisible segment (gap)

-- add a plain line --

Set_Custom_Property( …, 'ADD_LINE', '1,10,10,300,10,2,-,.5 );

-- add a dashed line --

Set_Custom_Property( …, 'ADD_LINE', '1,10,10,300,10,2,r125g50b200
,.5,square,miter,14,4' );

ADD_RECT

Add a rectangle on the current canvas

property value:

name,xpos,ypos,width,height,line_width,frame_color,inside_color_transparency,ins
ide_color,shade_color,gradient_start,gradient_end,gradient_direction,rounded_fac
tor,motif

default values are:

width : 1
frame_color : black
other colors are : white
inside_color_transparency : 1
gradient_direction : LeftToRight
other gradient direction can be : UpToDown
if you want to specify a transparency level but not the color, put - (minus) to the color
name is a unique object name

-- rectangle filled with the pre-defined tp3 Texture Paint --

Set_Custom_Property( …, 'ADD_RECT', '1,10,10,100,100,2,-,.5,-,-,-,-,-,-,tp3' );
ADD_ELLIPSE

Add an ellipse to the current canvas (since 1.7.7)

property value:

name,xpos,ypos,width,height,line_width,frame_color,inside_color_transparency,ins
ide_color,shade_color,gradient_start,gradient_end,gradient_direction,motif

default values are:

width : 1
frame_color : black
other colors are : white
inside_color_transparency : 1
gradient_direction : LeftToRight
other gradient direction can be : UpToDown
if you want to specify a transparency level but not the color, put - (minus) to the color
name is a unique object name

set_custom_property('laf_block.laf_bean',1,'ADD_ELLIPSE','el,100,100,40,20,2,#000000');

ADD_TEXT

Add a string to the current canvas.

property value is:

name,text,x1,y1,font_name,wight,size,gradient_flag/color,transparency[,outline_c
olor[,outline_width[,rotation[,motif][,scale/justification]]]]

text (not mandatory) can contains a unique name following the real prompt. If provided, it
must be separated with the special ^ character. You are then able to modify, at runtime, this
text using the SET_TEXT_LABEL method.

outline_width is the size in pixel of text outline. Put – (minus) if it is no used but followed by
other parameters.

rotation is indicated in degree. Put – (minus) if you want to set a motif and no rotation.

motif must be one of the following:

• predefined shape described via the ADD_TEXTUREPAINT method

• horizontal_lines
• vertical_lines
• image full path name

default values are:

weight : plain
size : 8
color : black
transparency : 1
If gradient_flag/color = 'G' then the text use the gradient colors previously set by the
SET_GRADIENT_TEXT method.
Else, the color defined (format rxgxbx) is use to paint the string.
name is a unique object name

scale/justification can be one of the following:

• scale=x_factor-y_factor
• box=width-height
• justify=width

ADD_TEXT samples:

-- set a text with unique name and defined color and a half transparency level --
Set_Custom_Property( …, 'ADD_TEXT'
,'1,BLOCK.ITEM^Hello,10,10,Arial,plain,12,r100g25b255,.5' );

-- set a text with defined color and a half transparency level --

Set_Custom_Property( …, 'ADD_TEXT', '1,Hello,10,10,Arial,plain,12,r100g25b255,.5' );

-- set a text with a gradient pre-defined color and no transparency level --

Set_Custom_Property( …, 'ADD_TEXT', '1,Hello,10,10,Arial,plain,12,G,1' );

-- Text Rotation 45 ° --
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,1,'Text rotated',260,200,Arial Black,bold,22,r255g0b0,1,r100g25b255,1,45');

-- using pre-defined motif (tp1) --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,1 || ',Hello,460,200,Arial Black,bold,100,r0g0b255,1,r0g0b255,2,-,-,tp1' );

–- horizontal line filling --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,1,Lines,460,90,SansSerif,bold,80,r0g0b255,1,r255g255b255,1,-,horizontal_lines' );

-– image clipping –-
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,1 || ',LAF,420,350,Arial Black,bold,120,r255g0b0,1,r0g0b255,2,-,c:/image,jpg' );

-– text scaled horizontally –-

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,'1,Hor. Scale,300,158,Arial,bold,24,r0g0b255,1,r0g170b255,1,-,-,-,scale=3.0-1.0' );

-– text scaled to fit a 500*20 pixel bounding box–-

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,'1,Text in Box,70,300,Arial,bold,30,r0g170b255,1,r0g0b255,1,-,-,-,box=500-20' );

-– text justification –-
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXT'
,'1,Justification,70,395,Arial,bold,30,r0g0b255,1,r0g170b255,1,-,-,-,justify=500' );

ADD_SHAPE

Add a shape on the current canvas (since 1.7.7)

property value:
name,texture_paint_name,x1,y1[,transparency]

name is the unique name of the shape

texture_paint_name is the name of object created with the ADD_TEXTUREPAINT method.
x1-y1 are the location on the canvas.
transparency should be between 0.0 (full transparent) to 1.0 (full opaque). If not provided,
the default value is 1.0

declare
n pls_integer := get_Block_property(:system.trigger_block, current_record);
s varchar2(100);
begin
n := (n-1) * 18 ;
s := '30,300,m0-' || n || '.' ;
s := s || 'l28-20.';
s := s || 'l28-70.';
s := s || 'l0-' || (n+18) || '.z';
-- create the shape --
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXTUREPAINT'
,'tp1,shape,r255g255b255,#C0E0FF,#C0E0FF,' || s );
-– display the shape on the canvas --
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_GRAPHIC', 'shape,shape1');
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_SHAPE', 'shape1,tp1,659,45' );
end;

ADD_TEXTUREPAINT

Create a Texture Paint (motif) to be used with the ADD_TEXT method. (since 1.5.2)

property value:
name,style,background_color,shape_line_color,shape_background_color,width,height
,shape_description

name is the unique name of the shape.

style can be one of the following:

• shape (a group of orders : moveTo, lineTo, quadTo, curveTo)

• paint (a matrix of colored points)
• image (a gif or jpeg image that will be repeated as a motif)

background_color, is the the background of the whole rectangle (shape only).

shape_line_color, is the color of the line that build the shape (shape only).
shape_background_color is the background of the shape, if it is closed (shape only).
width is the width in pixels of the whole shape (the bounding rectangle).
height is the height in pixels of the whole shape (the bounding rectangle).
shape_description depends on the shape style.

• shape
order, followed by a group of coordinates, can be one of the following:
• m (moveTo) float x, float y
• l (lineTo) float x, float y
• q (quadTo) float x1, float y1, float x2, float y2
• c (curveTo) float x1, float y1, float x2, float y2, float x3, float y3
• z (close path)
coordinates are separated by a – (minus) and groups by a . (dot).
see the Java documentation

• paint
matrix of colored points. The matrix is defined line by line from the top – left to right, to
the bottom. Each point separated by a . (dot)

• Image
a full image name from the JAR file, the client machine of the Internet. Only
name,style, and image_name required.

–- shape motif –-
–- red squares with blue border on white background-–
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXTUREPAINT'
,'tp1,shape,r255g255b255,r0g0b255,r255g0b0,7,7,m0-0.l4-0.l4-4.l0-4.z' );

–- paint motif –-
-- blue points --
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXTUREPAINT'
,'tp2,paint,-,-,-,2,2,ffffff.ffffff.ffffff.0000ff' );

–- image motif –-
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'ADD_TEXTUREPAINT'
,'tp3,image,-,-,-,-,-,/target-16.gif');

SET_TEXT_LABEL

Used to modify the prompt of a text created by the ADD_TEXT() method.

The parameter is composed by a unique name followed by the new label, both separated by a
comma.

Set_Custom_Property('CTRL.BEAN', 1, 'SET_TEXT_LABEL', 'EMP.JOB,New label);

POINT_TEXT_LABEL

Used to point the prompt in order to get its current value (since 1.7.7).

Set_Custom_Property('CTRL.BEAN', 1, 'POINT_TEXT_LABEL', 'EMP.JOB);

GET_TEXT_LABEL

Used to get the value of a prompt defined by a preceding POINT_TEXT_LABEL() (since

1.7.7).

Set_Custom_Property('CTRL.BEAN', 1, 'POINT_TEXT_LABEL', 'EMP.JOB);

:value := Get_Custom_Property('CTRL.BEAN', 1, 'GET_TEXT_LABEL', '');
CLEAR

Remove all graphics created on the current canvas

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 'CLEAR', '' );

REMOVE_GRAPHIC

Remove the given graphic from the current canvas (since 1.7.7)

property value: type,name

type can be:

• line
• rect
• ellipse
• shape
• text
• image

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_GRAPHIC', 'shape,shape1');

REMOVE_LINES

Remove all lines created with ADD_LINE from the current canvas (since 1.7.7)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_LINES', '');

REMOVE_RECTS

Remove all rectangles created with ADD_RECT from the current canvas (since 1.7.7)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_RECTS', '');

REMOVE_SHAPES

Remove all shapes created with ADD_SHAPE from the current canvas (since 1.7.7)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_SHAPES', '');

REMOVE_ELLIPSES

Remove all ellipses created with ADD_ELLIPSE from the current canvas (since 1.7.7)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_ELLIPSES', '');

REMOVE_TEXTS

Remove all texts created with ADD_TEXT from the current canvas (since 1.7.7)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'REMOVE_TEXTS', '');

TRANSFORM_GRAPHIC

Transform an existing shape (since 1.7.7)

property value : shape_type,shape_name,transformation,values

shape_type must be line, rect, ellipse, shape or text.

transformation can be moveto, stretch or rotate.
In case of stretch, you can set values as percentage transformation.
values can be:

moveto new X and Y position

stretch new size in pixels or percentage
rotate angle, rotation center point (ul,ur,dl,dr,c)

-- change shape location --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'TRANSFORM_GRAPHIC'
,'text,txt_end,moveto,50,140');

-- change shape size 110% of current size --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'TRANSFORM_GRAPHIC'
,'text,txtrot,stretch,110%,110%');

-- rotate shape around center --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'TRANSFORM_GRAPHIC'
,'text,txt_end,rotate,90,c');

POINT_SHAPE_PROPERTY

Points to a shape in order to get its property (since 1.7.7)

property value : shape_type, shape_name, shape_property

shape_type must be line, rect, ellipse, shape or text.

shape_name is the unique shape name.
shape_property is the shape property you need the current value.

Properties you can get from a rectangle/ellipse:

• StartPoint
• ShapeColor
• LineColor
• Gradient
• Rotation
• RotationPoint
• LineWidth
• Paint
 • Width
• Height

Properties you can get from a line:

• StartPoint
• EndPoint
• LineColor
• Rotation
• LineWidth
• RotationPoint

Properties you can get from a shape:

• StartPoint
• Rotation
• RotationPoint

Properties you can get from a text:

• StartPoint
• Scale
• LineColor
• ShapeColor
• Gradient
• Rotation
• RotationPoint
• FontName | FontSize | FontStyle
• Alignment
• Box
• Paint
• Image

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'POINT_SHAPE_PROPERTY'

, 'line,l,linewidth' );
synchronize;
message(Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SHAPE_GET_PROPERTY' ));
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'POINT_SHAPE_PROPERTY'
, 'text,txtrot,alignment' );
synchronize;
message(Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SHAPE_GET_PROPERTY' ));

SHAPE_GET_PROPERTY

Get the shape property value defined by POINT_SHAPE_PROPERTY (since 1.7.7).

:value := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SHAPE_GET_PROPERTY' )

SHAPE_SET_PROPERTY

set a given shape property value (since 1.7.7).

The properties are the same you can get with SHAPE_GET_PROPERTY.
Twin values should be passed with | (Alt-124) separator
 -- change width value --
Set_Custom_Property( 'laf_block.laf_bean', 1, 'SHAPE_SET_PROPERTY'
, 'ellipse,ball2,width,30');
-- change X,Y position value –
Set_Custom_Property( 'laf_block.laf_bean', 1, 'SHAPE_SET_PROPERTY'
, 'ellipse,ball2,startpoint,30|100');

SET_GRADIENT_COLORS

Set the 2 colors, and a possible transparency factor needed to paint a gradient.

The 2 colors are of type RGB and separated by a comma.

The first color is the start color, the second is the end color.
The transparency factor (since version 1.3.4), not required mus be between 0 (full
transparent) and 1 (full opaque)

Set_Custom_Property( …, 'SET_GRADIENT_COLORS', 'r0g0b0,r255g255b255' );

-- gradient with light transparency factor --
Set_Custom_Property( …, 'SET_GRADIENT_COLORS', 'r0g0b0,r255g255b255,.1' );

SET_GRADIENT_DIRECTION

Indicates the drawing gradient direction.

Allowed values are:

● LeftToRight (default)
● UpToDown
● LeftUpToRightDown
● LeftDownToRightUp

SET_GRADIENT_TEXT

Indicates the text gradient direction.

Identical that SET_GRADIENT_COLORS but used to set the gradient for texts.
These gradients colors are set to be used by a following ADD_TEXT() call.

SET_H_CYCLE

In case a cycling gradient, allow to set the cycle value.

Default is 0

The value corresponds to pixels.

If the value starts with / the value is considered as a divisor factor.

-- gradient cycles 4 times horizontally in the current canvas --

Set_Custom_Property( …, 'SET_H_CYCLE', '/4' );
SET_V_CYCLE

Identical to SET_H_CYCLE but for the vertical gradient cycling.

-- gradient cycles every 20 pixels vertically in the current canvas --

Set_Custom_Property( …, 'SET_V_CYCLE', '20' );

SET_GUI_PROPERTIES
Set some particular element properties.

These properties are normally read from the CSS file in the
PKG_Look_And_Feel.Set_GUI_Properties() laf.pll procedure.

property value :

item_type,font_name,font_weight,font_size[,foreground_color[,background_color]]

item_type can be one of the following:

● TextField
● TextArea
● Button
● CheckBox
● RadioB
● Tree
● ComboBox
● PopList
● TList
● Tree
● MenuBar
● MenuOption
● Status
● Window

font_weight can be one of the following:

● P (plain)
● B (bold)
● I (italic)
● BI (bold+italic)

colors must follow the RGB syntax

Examples:

Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'TextField,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'Button,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'CheckBox,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
 ,'RadioB,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'Tree,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'ComboBox,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'Tree,Tahoma,B,14,r0g128b255' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'MenuBar,Tahoma,B,14,r255g128b0,r200g255b150' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'MenuOption,Tahoma,B,14,r0g185b90,r255g255b150' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'Status,Tahoma,B,12,r255g255b255,r0g185b90' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_GUI_PROPERTIES'
,'Window,Verdana,BI,16,r255g255b128' ) ;

DRAW_GUI_ELEMENTS

Used to draw the elements set by the SET_GUI_PROPERTIES method.

Set_Custom_Property('BL.BEAN', 1, 'DRAW_GUI_ELEMENTS', '');

REFRESH

Used to repaint the windows after a ADD_IMAGE method used outside a When-New-
Form-Instance trigger.

Set_Custom_Property('BL.BEAN', 1, 'REFRESH', '[milliseconds]');

milliseconds is the time the function wait before repainting the windows.
the value can be between 50 and 2000. If not provided, the value used is 300.

e.g.:

Set_Custom_Property('BL.BEAN', 1, 'REFRESH', '');

SET_CANVAS_RESIZED

Used to repaint the canvas when it is resized.

When you resize the canvas that include the Bean Area, you can inform the Java Bean so that,
the gradients can be re-painted with the new dimensions.

e.g.:

Set_Canvas_Property('CV1', WIDTH, 600);

-– tell the Bean that the canvas size has changed --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_CANVAS_RESIZED', '');
SET_MOTIF

Used to draw a motif on the canvas. (since 1.5.2)

The motif must be already created with the ADD_TEXTUREPAINT method.

property value : motif_name[,transparency_factor]

The default transparency_factor is 1.0

-– Paint the canvas with the tp2 motif --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_MOTIF', 'tp2,.2');
Canvas mouse event capture (since the 1.7.7 version)

You can add a mouse listener to the current canvas to receive mouse move and click events.

CANVAS_MOUSE_MOVE

Define what canvas area is used to catch mouse events.

property value : false|full|x,y,width,height

If value is full, the whole canvas size is used.

If value is false, the mouse events capture is disabled.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'CANVAS_MOUSE_MOVE','5,40,485,230');

The messages sent back to Forms

You know what mouse event has fired through the When-Custom-Item-Event trigger attached
to the DrawLAF Bean Area.

------------------------------
-- Canvas mouse move event --
------------------------------
ELSIF (eventName='CANVAS_MOUSE_MOVE') THEN
get_parameter_attr(eventValues,'MOUSE_X_POS',eventValueType, p1);
get_parameter_attr(eventValues,'MOUSE_Y_POS',eventValueType, p2);
-------------------------------
-- Canvas mouse click event --
-------------------------------
ELSIF (eventName='CANVAS_MOUSE_CLICK') THEN
get_parameter_attr(eventValues,'ITEM_ACTION_MOUSEBUTTON',eventValueType, p1);
Shape animation (since the 1.7.7 version)

These methods allows the programmer to apply transformations on the shapes added to the
canvas.

SHAPE_MOVE_TO

Move a shape to a defined target.

property value : type,name,x_start,y_start,x_end,y_end[,delay[,step]]

type must be line, rect, ellipse, shape or text

name is the shape name
x_start, y_start are the source position
x_end, y_end are the target position
delay indicates the delay in milliseconds between each step (default 1000)
steps indicates the number of pixels between each move (default 10)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'SHAPE_MOVE_TO'
,'text,txt_help,10,140,350,140,20,2');

SHAPE_ROTATE_TO

Rotate a shape to a defined angle in degrees.

property value : type,name,rotation_in_degrees[,orientation[,delay,[step,

[rotation_point]]]]

type must be line, rect, ellipse, shape or text

name is the shape name
rotation_in_degrees must be between 0 and 360
orientation can be 1 (counterclockwise) or -1 (clockwise)
delay indicates the delay in milliseconds between each step (default 1000)
steps indicates the number of degrees between each move (default 10)
rotation_point points to the rotation center point and can be:

• ul upper left corner (default)

• ur upper right corner
• dl down left corner
• dr down right corner
• c center

-- shape rotation 360 degrees, 5 degrees each step, 20 milliseconds delay --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'SHAPE_ROTATE_TO'
,'text,txtrot,360,1,20,5');
SHAPE_STRETCH_TO

Stretch a shape to a new size.

property value : type,name,width|font_size,height[,delay[,step]]

type must be line, rect, ellipse, shape or text

name is the shape name
width is the new with in pixels of font size for text
height is the new height in pixels - put – (minus) for text shapes
delay indicates the delay in milliseconds between each step (default 1000)
steps indicates the number of pixels between each step (default 10)

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN',1,'SHAPE_STRETCH_TO','rect,re,100,100,50,4');

SHAPE_ADD_ANIMATION_STEP

Add an animation step to a list.

You can combine as many transformation you want. All of them executing at the same time.
The transformation is executed in an asynchronous mode.

property value : animation_type,values

animation_type must be shape_stretch_to, shape_rotate_to or shape_move_to

values is the correct values for the transformation

-- add a 3 steps animation (stretch, rotate and move) --

set_custom_property('laf_block.laf_bean',1,'SHAPE_ADD_ANIMATION_STEP'
,'shape_stretch_to=rect,re,140,100,100,4');
set_custom_property('laf_block.laf_bean',1,'SHAPE_ADD_ANIMATION_STEP'
,'shape_rotate_to=rect,re,360,1,60,10,c');
set_custom_property('laf_block.laf_bean',1,'SHAPE_ADD_ANIMATION_STEP'
,'shape_move_to=rect,re,100,50,260,150,80,5');

SHAPE_PLAY_ANIMATION

Start the animations added to the list.

-- play the animation --

set_custom_property('laf_block.laf_bean',1,'SHAPE_PLAY_ANIMATION','');

SHAPE_CLEAR_ANIMATION

Clear the animation list.

-- clear existing animation --

set_custom_property('laf_block.laf_bean',1,'SHAPE_CLEAR_ANIMATION','');
ANIMATION_DELAY

Sleep the given number of milliseconds.

-- wait one second --

set_custom_property('laf_block.laf_bean',1,'ANIMATION_DELAY','1000');

The animation message sent back to Forms

You know what animation is finished through the When-Custom-Item-Event trigger attached to
the DrawLAF Bean Area.

----------------------------
-- Shape animation event --
----------------------------
ELSIF (eventName='SHAPE_MOVE_EVENT') THEN
get_parameter_attr(eventValues,'SHAPE_MOVE_DONE',eventValueType, p1);

SHAPE_MOVE_DONE contains the name of the shape the animation has finished.
Sound properties

PLAY_SOUND

Used to play a sound pre-loaded with the SET_FILE_SOUND() method.

-- Play a pre-loaded sound --

Set_Custom_Property('BL.BEAN', 1, 'PLAY_SOUND', 'SOUND3.WAV');

The sound must have been successfully loaded with the SET_SOUND_FILE() method.

SET_SOUND_FILE

Used to pre-load sound files.

The sound files can be read from the jar file or from the local disk.

property value : path, file_name

For those who run the Windows XP system, there are plenty of standard Windows sound files
located in the c:\i386 directory, so there is no need to put sound files into the JAR file.

-- from the JAR file --

Set_Custom_Property('BL.BEAN', 1, 'SET_SOUND_FILE', '/,SOUND1.WAV');

-- from the local hard drive --

Set_Custom_Property('BL.BEAN', 1, 'SET_SOUND_FILE', 'c:/i386,SOUND12.WAV');

Note:
The table that handles the sounds is static to the bean, so this list of sounds is shared between
all the modules of the current application.
This list has to be initialized only once for the whole application, at the loading of the first form
module that contains a DrawLAF bean.

SET_SOUND_BASE
Used to pre-load sound files from a BLOB database column.

In order to read sounds from the database, you need to compile the LAF_PKG package in your
database.
The SQL script to do so is located in the /scripts folder of the zip file.

Set_Custom_Property( 'BL.BEAN_LAF', 1, 'SET_SOUND_BASE', sound_chunk ) ;

Sound_chunk contains as many sound chunks as needed to reconstitute the complete sound
file. These chunks are read from the database BLOB column through the PKG_LAF package
functions.
The end of the sound - last chunk - must contains the special value : [END_SOUND]

It needs the PKG_LAF package compiled in your schema, or, at least, a grant execute on this
package to another schema.
The script of the PKG_LAF package is located in the /script folder in the zip file.

PROCEDURE Load_BLOB_Sound
(
PC$WhereClause IN Varchar2,
PC$Name IN Varchar2
)
IS
LB$Ok boolean ;
LC$Sound Varchar2(32767) ;
LC$Clause Varchar2(4000) ;
BEGIN

--
-- Read a BLOB content from the database
--
-- Select the Blob column --
If PKG_LAF.Select_Blob(PC$WhereClause) Then
Loop
-- Get the image chunks from the database --
LC$Sound := PKG_LAF.Get_B64_Chunk ;
If LC$Sound Is Not Null Then
-- Send the chunks to the Java Bean --
Set_Custom_Property( 'BL.BEAN_LAF', 1, 'SET_SOUND_BASE', LC$Sound ) ;
Else
-- End the sending process --
LC$Sound := '[END_SOUND]|' || PC$Name ;
Set_Custom_Property( 'BL.BEAN_LAF', 1, 'SET_SOUND_BASE', LC$Sound );
Exit ;
End if ;
End loop ;
End if ;

END;

The PC$WhereClause parameter must contains valid SQL SELECT order to identify the single
row that contains the BLOB to read.

Here is a call sample:

Load_Blob_Sound('SELECT SOUND FROM CATALOG WHERE NAME=''apostrophe.jpg'''

,'apostrophe.au');
Flashing Text properties

SET_FLASH_FONT

Set the font properties used to display a flashing message.

property value : font_name, font_weight, font_size

Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_FONT', 'Verdana,bold,14');

If not set, the default font is : Verdana,plain,12

SET_FLASH_COLORS
Set the colors used to display a flashing message.

property value :

font_color [,font_outline_color[,frame_color]]

Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_COLORS', 'r0g0b255');

Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_COLORS', 'r255g0b0,r0g0b255,r255g0b0');

The default frame color is white (r255g255b255).

There is no default font outline color.

If you want to put a frame color but no font_outline_color, put '-' to the font_outline_color:

Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_COLORS', 'r255g0b0,-,r255g0b0');

SET_FLASH_TEXT
Used to display a single or multi-line message lasting the number of milliseconds
given.

property value:

posX | posY | message [| milliseconds [| refresh [| message_color[,shadow_color]

[| sound name ]]]]

-- display the text contained in the :BL.TXT text item at position 10,10
-- during 3 seconds with no refresh, current color and playing the SOUND12.WAV sound:
Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_TEXT'
,'10|10|' ||:BL.TXT||'|3000|false|-|SOUND12.WAV');

-- display a multi-line message at 10,10 with refresh during 4 seconds:

Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_TEXT'
,'10|10|Hello'||CHR(10)||'there|4000|true');
 -- set both text and text shadow colors --
Set_Custom_Property('BL.BEAN', 1, 'SET_FLASH_TEXT'
,'10|10|' ||:BL.TXT||'|3000|false|r250g0b0
,r10g125b96|SOUND12.WAV');

The refresh parameter can be set to true if there are chances that the cursor would blink into
the displayed message. This will ensure that the message would not be erased.
If you are sure the message cannot be erased, because the cursor won't quit the current item
(Raise Forms_Trigger_Failure for instance), set this parameter to false.

A pre-loaded sound can by played as soon as the message is displayed on the screen.

The default value for milliseconds is 2000 (2 seconds).

The default line separator character is CHR(10).

The maximum number of lines allowed in a message is 80.

Only for this method, the default separator is | (alt-124), that allows to display messages that
contain a comma for instance.

SET_FLASH_TEXT2
Used to display a single or multi-line message lasting the number of milliseconds
given.

property value:

posX|posY|message[|milliseconds] [|frame_background_color] [|frame_border_color]

[|sound_name ] [|blink ]

-- message displayed 5 seconds at 100,40 position --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_FLASH_TEXT2',
'100|40|Message displayed|5000|r255g255b255|r42g127b255|-|true');

-- message centered on the window --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_FLASH_TEXT2',
'CENTER|CENTER|Message displayed|5000|r255g255b255|r42g127b255|-|false');

The message can displayed in a frame if frame_background_color and/or frame_border_color

are provided.

A pre-loaded sound can by played as soon as the message is displayed on the screen.

The default value for milliseconds is 2000 (2 seconds).

The default line separator character is CHR(10).

The maximum number of lines allowed in a message is 80.

You can have the message blinking if the blink parameter is set to true.
posX can take one of the following keyword:

• LEFT
• CENTER
• RIGHT

posY can take one of the following keyword:

• TOP
• CENTER
• BOTTOM

With this method, the default separator is | (alt-124), that allows to display messages that
contain a comma for instance.
Frames properties

SET_FRAME

Used to create a new frame on the current canvas.

property_value:

name, border_width, title[, font, font_size, font_weight [,title_pos,

alignment]]

title_pos can be:

● top
● bottom
● left
● right

alignment can be:

● left
● center
● right

Set_Custom_Property('BL.BEAN',1,'SET_FRAME','F1,3,Frame Title,Arial,16,B,top,center') ;

SET_FRAME_TEXT

Set the frame title and eventually the position.

properties: name, title [,title_pos, alignment]

title_pos can be:

● top
● bottom
● left
● right

alignment can be:

● left
● center
● right

Set_Custom_Property('BL.BEAN',1,'SET_FRAME'_TEXT,'F1,Frame Title,top,center') ;
SET_FRAME_TEXT_ALIGNMENT

Set the frame title position.

properties: name, title_pos, alignment

title_pos can be:

● top
● bottom
● left
● right

alignment can be:

● left
● center
● right

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_TEXT_ALIGNMENT','F1,top,center') ;

SET_FRAME_TEXT_OPAQUE

Indicate if the title background is opaque or not.

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_TEXT_OPAQUE','frame_name, true|
false') ;

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_TEXT_OPAQUE','F1,false') ;

SET_FRAME_FONT

Set the title font.

properties: name, font_name [,font_size [,font_weight ] ]

font_weight can be:

● N (Normal)
● B (Bold)
● I (Italic)
● BI (Bold+Italic)

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_FONT','Arial,14,B') ;
SET_FRAME_BACKGROUND

Set the inside frame background.

Properties: name,color1|motif[,color2[,transparency_level]]

colors are indicated with RGB syntax.

If the first color is given, it represents the plain background color
If the first color start with 'motif=' it indicates a pre-defined motif to draw in background
If you specify the two colors, it represents a gradient from color1 to color2
transparency_level must be a float between 0.0 (full transparency) and 1.0 (opaque)
If you provide a transparency_level but no second color, put - in place of color2

-- plain red background --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BACKGROUND','F1,r255g0b0') ;

-- gradient background from white to red --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BACKGROUND','F1,r255g255b255,r255g0b0') ;

-- plain red background with .3 transparency level --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BACKGROUND',' F1,r255g0b0,-,.3') ;

-- background filled with a motif --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BACKGROUND','Rb,motif=motif1,-,.2');

SET_FRAME_COLORS

Set the border frame colors.

Properties: name,color1[,color2]

colors are indicated with RGB syntax.

color1 is the frame color
color2 is the frame shadow color

-- set frame color without shadow --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_COLORS','F1,r200g200b200') ;

-- set frame color with shadow --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_COLORS','F1,r255g255b255,r120g120b120') ;

SET_FRAME_GRADIENT_ORIENTATION

Set the frame inside gradient orientation.

orientation can be:

● LeftToRight
● RightToLeft
● UpToDown
● DownToUp

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BACKGROUND','F1,LeftToRight') ;
SET_FRAME_ROUND_BORDER

Indicates if the frame border is rounded or not.

By default, the frame is created with no rounded border.

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_ROUND_BORDER','F1, true|false') ;

-- frame with rounded border --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_ROUND_BORDER','F1,true') ;

SET_FRAME_BOUNDS

Set the frame bounds.

This method have to be used just after the SET_FRAME method

Properties: x_position,y_position,width,height

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_BOUNDS','F1,10,10,300,200');

SET_FRAME_HCYCLE

Set the horizontal cycle factor for a gradient frame color.

Properties: name,cycle_value

cycle_value can be expressed in number of pixels or a divisor factor

-- Horizontal cycle that repeat twice in the frame --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_HCYCLE','F1,/2');

SET_FRAME_VCYCLE

Set the vertical cycle factor for a gradient frame color.

Properties: name,cycle_value

cycle_value can be expressed in number of pixels or a divisor factor

-- Vertical cycle that repeat every 50 pixels the frame --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_VCYCLE','F1,50');
SET_FRAME_TITLE_COLOR

Set the frame title color.

Properties: name,foreground_color[,background_color]

-- set a blue foreground title color --

Set_Custom_Property('BL.BEAN',1,'SET_FRAME_TITLE_COLOR','F1,r0g0b255');

SHOW_FRAME

Show the given frame.

Set_Custom_Property('BL.BEAN',1,'SHOW_FRAME','frame_name');

HIDE_FRAME

Hide the given frame.

Set_Custom_Property('BL.BEAN',1,'HIDE_FRAME','frame_name');

REMOVE_FRAME

Remove the given frame.

Set_Custom_Property('BL.BEAN',1,'REMOVE_FRAME','name');

REMOVE_ALL_FRAMES

Remove all current frames.

Set_Custom_Property('BL.BEAN',1,'REMOVE_ALL_FRAMES','');
Input Dialog Box properties

SET_DIALOG_PROPS

Used to set the graphical dialog properties.

properties: font_name,font_size[,foreground_color[,background_color]]

foreground_color is the text color

background_color is the dialog background color

Set_Custom_Property('CTRL.LAF', 1, 'SET_DIALOG_PROPS','Arial,16,r0g0b255');
Set_Custom_Property('CTRL.LAF', 1, 'SET_DIALOG_PROPS','Arial,14,r255g0b0,r255g255b0');

SET_INPUT_DIALOG

Used to set the dialog properties.

properties: title,text[,multi-line[,x_pos,y_pos[,width[,height[,icon_name]]]]]

multi-line could be : true|false (default is false)

x_pos and y_pos are the top-left X,Y screen coordinate you want to display the dialog box
put -1,-1 to center the dialog box.

width and height are expressed in pixel

icon_name can be searched from:

● the JAR file : /image.gif

● the local machine : c:/image.gif
● the internet : http:/..../image.gif

Unrequested parameter followed by valuated one has to be passed as '-'

-- multi-line 400*100 pixels with icon read from the JAR file --
Set_Custom_Property('CTRL.LAF', 1, 'SET_INPUT_DIALOG'
,'Titre,texte,true,50,100,400,100,/img.gif');
-- centered single line item 400 pixels width and icon read from the local machine --
Set_Custom_Property('CTRL.LAF', 1, 'SET_INPUT_DIALOG'
,'Titre,texte,false,-1,-1400,-,c:/images/img.gif');
Tabs properties

SET_TAB_COLORS

Used to set the non-selected tab colors.

Properties: Foreground_color [,background_color]

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_TAB_COLORS', 'r0g0b204' ) ;

SET_TAB_SELECTED_COLORS

Used to set the selected tab colors.

Properties: Foreground_color [,background_color]

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_TAB_SELECTED_COLORS'

,'r50g80b180,r200g0b128' ) ;

SET_TAB_FONT

Used to set the tab font.

Properties: font_name,font_weight,font_size

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_TAB_FONT', 'Verdana,B,14' ) ;

SET_TAB_ITEM_ICON

Used to put an image on the tab.

Properties: tab_label,icon_name

e. g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_TAB_ITEM_ICON', 'EMPLOYEES,/pen-24.gif' ) ;

Notice that you must indicate the tab's label (title) and not the tab's name.
The image can be read from:
● the current JAR file: /image.gif
● the local drive : c:/image.gif
● an Internet URL : http://.../image.gif
Window properties

SET_WIN_MDI_ICON

Used to put an image on MDI window caption bar.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_WIN_MDI_ICON', 'icon_name' ) ;

e. g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_WIN_MDI_ICON', '/oracle.gif' ) ;

The image can be read from:

● the current JAR file: /image.gif

● the local drive : c:/image.gif
● an Internet URL : http://.../image.gif

SET_WINDOW_ICON

Used to put an image on the given window caption bar.

You have to indicate the window title, not the Forms window name that is lost by the Java
Bean.

Properties: window_title,icon_name

e. g.:

-- get the image from the current JAR file --

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_WINDOW_ICON'
, 'The window title/oracle.gif' ) ;

The image can be read from:

● the current JAR file: /image.gif

● the local drive : c:/image.gif
● an Internet URL : http://.../image.gif

SET_CURRENT_WINDOW_ICON

Used to put an image on the current window caption bar.

The current window is the one that contains the canvas that contains the Bean.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_CURRENT_WINDOW_ICON', 'icon_name' ) ;

e. g.:
 -- get the image from the current JAR file --
Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_CURRENT_WINDOW_ICON', '/oracle.gif' ) ;

The image can be read from:

● the current JAR file: /image.gif

● the local drive : c:/image.gif
● an Internet URL : http://.../image.gif

SET_ALL_WINDOWS_ICON

Used to put an image on all the window caption bars.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_ALL_WINDOWS_ICON', 'icon_name' ) ;

e. g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_ALL_WINDOWS_ICON', '/oracle.gif' ) ;

The image can be read from:

● the current JAR file: /image.gif

● the local drive : c:/image.gif
● an Internet URL : http://.../image.gif

SET_WINDOW_PROPERTY

Set several window or MDI window properties.

Set_Custom_Property('CTRL.BEAN',1,'SET_WINDOW_PRPOERTY','property[,value]') ;

The pairs property/value can be:

• can_move, true|false
• can_close, true|false
• can_maximize, true|false
• can_minimize, true|false
• can_resize, true|false
• can_disable, true|false
• can_show, true|false
• set_MDI_state_icon (MDI only)
• set_MDI_state_maximize (MDI only)
• set_MDI_state_normal (MDI only)
• on_top ,true|false (MDI only)

e. g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_WINDOW_PROPERTY'

, 'set_MDI_state_maximize' ) ;
Dynamic Menus properties

Note :
- before handling the current menu, you have to call the DRAW_GUI_ELEMENTS method in
order to scan the current menu options:

Set_Custom_Property('CTRL.BEAN', 1, 'DRAW_GUI_ELEMENTS', '' ) ;

- the popup/option menu's names given to the methods are the displayed ones, so with
standard internal Forms menu,
they can differ from one language setting to another one.

ADD_MENU

Used to add a pop up menu to the menu bar.

Set_Custom_Property( 'CTRL.BEAN', 1, 'ADD_MENU', 'popup_menu_name');

The new pop up menu is added to the end of the current menu tool bar.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'ADD_MENU', 'Contracts');

ADD_MENU_OPTION

Used to add a menu option to an existing pop up menu.

Set_Custom_Property( 'CTRL.BEAN', 1, 'ADD_MENU_OPTION', 'properties');

properties: option_name,label,action_command[,icon[,tooltip_text]]

option_name must be formated like : popup_menu_name.option_name.

The menu option is added to the end of the given popup menu.
The tool tip text is passed as the last argument so that you can put commas in it.

e.g.:

Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION'
,'Menu1.Opt3,label,instruction,/help.gif,tooltip text' ) ;

If you provide the tool tip but no icon, put a - in place of the icon name:

Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION'
,'Menu1.Opt3,label,instruction,-,tooltip text' ) ;
to add a separator, put SEPARATOR in the label:

Set_Custom_Property('CTRL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.sep1,SEPARATOR' ) ;

SET_STATUS_MENU

Used to enable/disable a pop up menu.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUS_MENU', 'properties');

properties: popup_menu_name, boolean

boolean can be 'true' to enable the pop up or 'false' to disable it.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUS_MENU', 'Action,false');

SET_STATUS_MENU_OPTION

Used to enable/disable an option menu.

properties: option_name,boolean

boolean can be 'true' to enable the option or 'false' to disable it.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUS_MENU_OPTION', 'Edit.Edition,false');

SET_VISIBLE_MENU

Used to show/hide a pop up menu.

properties: popup_menu_name,boolean

boolean can be 'true' to show the or 'false' to hide it.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_VISIBLE_MENU', 'Action,false');

SET_VISIBLE_MENU_OPTION

Used to show/hide an option menu.

properties: option_name,boolean

boolean can be 'true' to show the option or 'false' to hide it.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_VISIBLE_MENU_OPTION', 'Edit.Edition,false');

MOVE_WIN_MENU_OPTION

Used to move the "Window" system pop up at the end of the tool bar.

Set_Custom_Property( 'CTRL.BEAN', 1, 'MOVE_WIN_MENU_OPTION', '');

This method must be invoked at the last position, after you have added/removed all pop up
and options menus.
It moves the "Window" system pop up menu at the end of the menu tool bar.

Menu handling code example:

-- Get the current menu --

Set_Custom_Property('BL.BEAN', 1, 'DRAW_GUI_ELEMENTS', '' ) ;

-- remove standard menu popups --

Set_Custom_Property('BL.BEAN', 1, 'SET_VISIBLE_MENU', 'Edit,false' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_VISIBLE_MENU', 'Record,false' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_VISIBLE_MENU', 'Block,false' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_VISIBLE_MENU', 'Query,false' ) ;
Set_Custom_Property('BL.BEAN', 1, 'SET_VISIBLE_MENU', 'Field,false' ) ;

-- Add a few menu options --

Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU', '&Menu1' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.Opt1,Option 1
,instruction1' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.Opt2,Option 2
,instruction2' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.sep1,SEPARATOR' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.Opt3,Help,go-help
,Option menu tooltip,/help.gif' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.sep2,SEPARATOR' ) ;
Set_Custom_Property('BL.BEAN', 1, 'ADD_MENU_OPTION', 'Menu1.Exit,E&xit,Exit-Form' ) ;

-- Move Window system menu at end --

Set_Custom_Property('BL.BEAN', 1, 'MOVE_WIN_MENU_OPTION', '' ) ;
SHOW_MENU_BAR

Used to show/Hide the entire menu bar.

Allowed values are 'true' or 'false'

-– hide the entire menu bar --

Set_Custom_Property( 'CTRL.BEAN', 1, 'SHOW_MENU_BAR', 'false');
Status Bar properties

SET_STATUSBAR_VALUE

Used to set the value of one of the Status Bar zone.

Properties: bar_line,bar_zone,value

bar_line can be 1 or 2 (first or second line).

bar_zone can be 1-2 for line 1 and 1-6 for line 2.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUSBAR_VALUE', '2,1,message');

SET_STATUSBAR_INDEX

Used to set the index of the Status Bar zone to read (with the
GET_STATUSBAR_VALUE).

Properties: bar_line,bar_zone

bar_line can be 1 or 2 (first or second line).

bar_zone can be 1-2 for line 1 and 1-6 for line 2.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUSBAR_INDEX', '2,1');

GET_STATUSBAR_VALUE

Used to get the value of one of the Status Bar zone.

value := Get_Custom_Property( 'CTRL.BEAN', 1, 'GET_STATUSBAR_VALUE', '');

returns the value of the statusbar zone set by a preceding SET_STATUSBAR_INDEX() method.
If SET_STATUSBAR_INDEX was not used before, returns the value of the zone set by the last
SET_STATUSBAR_VALUE() method.

e.g.:

-- set the zone index to read --

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_STATUSBAR_INDEX', '2,1');

-- read the value --

v_msg := Get_Custom_Property( 'CTRL.BEAN', 1, 'GET_STATUSBAR_VALUE', '');
SHOW_STATUSBAR

In order to use this method, you should ensure the DRAW_GUI_ELEMENTS() has been called
somewhere before.

Used to show or hide the status bar.

Properties: true|false

Set_Custom_Property( 'CTRL.BEAN', 1, 'SHOW_STATUSBAR', 'false');

SHOW_STATUSBAR_SECOND_LINE

In order to use this method, you should ensure the DRAW_GUI_ELEMENTS() has been called
somewhere before.

Used to show or hide the status bar second line.

Properties: true|false

Set_Custom_Property( 'CTRL.BEAN', 1, 'SHOW_STATUSBAR_SECOND_LINE', 'false');

Color chooser properties

SET_COLORCHOOSER_VALUES

Used to set the initial color and title to the Java JColorChooser dialog.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_COLORCHOOSER_VALUES',

'rgb_color[,title]');

rgb_color is a string of RGB format.

title is optional.

e.g.:

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_COLORCHOOSER_VALUES'

, 'r200g100b0,Select a color');

If you do not want to indicate the color, but only the title, provide a - (minus) instead of the
color value

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_COLORCHOOSER_VALUES', '-,Select a color');

GET_COLORCHOOSER_COLOR

Used to get a color returned by the JColorChooser dialog.

Declare
LC$Color Varchar2(12);
Begin
LC$Color := Get_Custom_Property( 'CTRL.BEAN', 1, 'GET_COLORCHOOSER_COLOR');
End;

The returned string is in format: RGB.

The values used to show the dialog (initial color and title) are those given in a previous
Set_Colorchooser_values() method.
Socket Server properties

INIT_SERVER

Initialize a socket.

Properties: port[,wait_time]

port is the number of the port you want to open.

wait_time is optional, and indicate the amount of milliseconds the socket sleeps. Because the
socket read messages from the outside in an infinite loop, this is necessary to let the processor
do something else.
If this value that must be greater than 50 is not given, the default value is 1000, so one
second.

In most cases, you will put this instruction at the start-up of the form.

e.g.:

-- open a socket on port 4450, reading the port every 0.2 second --
Set_Custom_Property( 'CTRL.BEAN', 1, 'INIT_SERVER', '4450,200');

-- open a socket on port 4450, reading the port every second --

Set_Custom_Property( 'CTRL.BEAN', 1, 'INIT_SERVER', '4450');

The messages sent by the bean can be retrieved in the Forms module through the When-
Custom-Item-Event trigger of the Forms bean area.
The event name is: SENDMSG and the corresponding message is stored in the
MESSAGEVALUE parameter list attribute:

DECLARE

eventName varchar2(30) := :system.custom_item_event;

eventValues ParamList;
eventValueType number;
LC$Msg varchar2(512);
LC$Value varchar2(256);

BEGIN

IF (eventName='SENDMSG') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
-- get the message in the LC$Msg variable --
get_parameter_attr(eventValues,'MESSAGEVALUE',eventValueType, LC$Msg);
END IF;

END;
STOP_SERVER

Used to close the socket.

Set_Custom_Property( 'CTRL.BEAN', 1, 'STOP_SERVER', '');

The POST-FORM trigger is a good place to put this instruction

SOCKET_SERVER_LOG

Used to output socket activity on the Java console.

Set_Custom_Property( 'CTRL.BEAN', 1, 'SOCKET_SERVER_LOG', 'true|false');

List properties

SET_ENHANCED_POPLISTS

Transform all lists (PopList, Tlist and CombBox) of the form module to enhanced (Swing) or
standard

property value is 'true' or 'false'

Set_Custom_Property( …, 'SET_ENHANCED_POPLISTS', 'true' );

SET_LIST_ORIENTATION

Set all current form the enhanced(Swing) Poplist orientation.

Allowed values are:

● HORIZONTAL_WRAP
● VERTICAL_WRAP
● VERTICAL

Set_Custom_Property( …, 'SET_LIST_ORIENTATION', 'VERTICAL_WRAP' );

SET_MULTI_SELECTION

Set all current form enhanced (Swing) Tlists multi-selection true/false.

At creation time, each Tlist default is false.

Set_Custom_Property( …, 'SET_MULTI_SELECTION', 'true' );

SET_SORTED_LIST

Set all current form enhanced (Swing) Tlists sorted flag.

Available values are : 'true' or 'false'

Default creation value is 'false'

Set_Custom_Property( …, 'SET_SORTED_LIST', 'true' );

SET_TIME_KEY_SELECT

Set the number of millisecond between each keyboard hit in every Poplist.

A high number allows to enter several characters added to each other to pre-select the
attempted value.

For instance, with a value of 5000, the end user has 5 seconds to cumulate keys to find the
correct list entry ("abdominal" by entering abc, for instance).

With a lower value (for instance 100), the end user has only 1/10th of second to concatenate
characters.
In the reality, each character hit set the focus on the list entry that starts with the key just hit.

Set_Custom_Property( …, 'SET_TIME_KEY_SELECT', '5000' );

Alerts

DISPLAY_ALERT

Display an alert box with buttons (possibly more than 3) or pop list.

Properties: list,Xpos,Ypos,width,height,icon,option list,default,Title,Message

If list = true, then a poplist is used to display the options, else we use push buttons.

If you do not want to provide Xpos, Ypos, width, height or icon, put - (minus) instead.
All other parameters are required.

If XPos and YPos < 0 then the dialog box is centered to the screen.
If XPos and YPos = 0 then the dialog box is centered to the Forms application.

icon can be one of the following:

• question
• information
• warning
• error

It can also be an image file read from the JAR file, the local disk or the Internet.

option list contains the labels of the options separated by a | (alt-124).

default option is indicated as the number of the option that is the default.

The title cannot contains any comma.

The message itself is moved to the last argument, then can contains commas.

Alert using buttons:

Set_Custom_Property( 'CTRL.BEAN', 1, 'DISPLAY_ALERT', 'false,0,0,400,160,question,&Yes|

&No|May&be|D&on''t know,3,Choose the best option,Are you sure to be really about stopping
to start?' ) ;

Alert using a list and an image for the icon:

Set_Custom_Property( 'CTRL.BEAN', 1, 'DISPLAY_ALERT', 'true,0,0,400,160,/LAFhelp.gif,one|

two|three|four|five|six|seven|eight|nine,3,Choose the best option,Select a value between
1 and 9' ) ;
GET_ALERT_BUTTON

Returns the number of the selected option.

If the pop list display is selected, the value returned is the value in the pop list.

message('option:' || Get_Custom_Property( 'CTRL.BEAN', 1, 'GET_ALERT_BUTTON') );

Scrolling Panel properties
These properties are available since the 1.4 version

SET_SCROLL_PANEL_COLOR

Set the Scrolling Panel background's color.

Properties: RGB color

If not set, the default color is white.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_COLOR','r0g255b255');

SET_SCROLL_PANEL_BORDER

Set the Scrolling Panel background's border style.

Properties: style[,RGB color,line_size]

you can choose one of the following border type:

• line
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty

If line border is chosen, you have to specify a RGB color and a line size.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_BORDER','raisedetched');

–- red 2 pixels line border –-

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_BORDER'
,'line,r255g0b0,2');

SET_SCROLL_ALLOW_LINKS

If the HTML content contains links, allow the end-user to click them.

Properties: true|false

If not set, the default is false.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_ALLOW_LINKS','true');

SET_SCROLL_PANEL_FONT

Set the Scrolling Panel default font.

This property is needed only when you just send single text to the Scrolling Panel.

Properties: font_name,font_size

If not set, the default font is system font..

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_FONT','Verdana,14');

SET_SCROLL_PANEL

Set the main Scrolling Panel values then show it.

Properties: initial_delay,delay,X,Y,Width,Height[,content]

initial_delay is the number of milliseconds the panel waits before scrolling.

delay is the number of milliseconds that defines scrolling speed. 20 is fast. 1000 is very slow.
0 is no scroll if you want to have the page frozen (in the aim of displaying help system pages).

X is the X position on the canvas (in pixel)

Y is the Y position on the canvas (in pixel)
Width is the Scrolling Panel width (in pixel)
Height is the Scrolling Panel height (in pixel)

content is the Scrolling Panel content.

It can be only text, but also an URL.
You can show documents stored on the Application Server in one of the virtual/physical paths
defined in the /forms/server/forms.conf (AliasMatch). In this case, just precede the html page
name with the virtual path e.g. : /forms/html/

–- external URL content --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL'
,'0,25,10,10,600,250,http://google.com' ) ;

–- Application Server content --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL'
,'0,25,10,10,600,250,/forms/html/page.html' ) ;

–- single text content --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL'
,'0,25,10,10,600,250
,<html><body>Hello there<br>here is the content</body></html>' ) ;
SET_SCROLL_PANEL_TEXT

Set the Scrolling Panel's content.

Properties: URL or HTML content

Useful to change the source of an existing Scrolling Panel.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_TEXT'

,'<html><body>Hello there<br>here is the content</body></html>');

SET_SCROLL_TEXT_ERROR

Set the Scrolling Panel's error text corresponding to error 404 – page not found.

Properties: error_message

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_TEXT_ERROR'

,'<html><body bgcolor='#ffffff'><font color='#ff0000' size='2'
face='Verdana'><strong>Sorry, the requested page was not
found</strong></font></body></html>');

SHOW_SCROLL_PANEL

Show/Hide an existing Scrolling Panel.

Properties: true|false

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SHOW_SCROLL_PANEL','false');

SET_SCROLL_HORIZONTAL_TOOLBAR

Show, if needed, an horizontal scrollbar.

Properties: true|false

default value is false.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_HORIZONTAL_TOOLBAR','true');

SET_SCROLL_VERTICTAL_TOOLBAR

Show, if needed, a vertical scrollbar.

Properties: true|false

default value is false.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_VERTICAL_TOOLBAR','true');

SET_SCROLL_PANEL_ESCAPE

Allow the user to exit the panel with Escape key.

Properties: true|false

default value is false.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_ESCAPE','true');

SET_SCROLL_PANEL_FRAME

Show the scrolling panel in a separate frame.

Properties: true|false[,frame_title]

default value is false.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_FRAME','true');

SET_SCROLL_PANEL_EXTENDS

Allow the user to expand the panel to bigger given size.

This function is commanded by double-clicking inside the scrolling panel.
First double-click enlarge the panel to the given size. Second double-click restores the panel to
its original size/position.

Properties: x,y,width,height | fullcanvas

default value is no extend.

If the fullcanvas keyword is provided, the panel will take the entire canvas surface.

-– extend to given size --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1,
'SET_SCROLL_PANEL_EXTENDS','10,10,600,400');
–- extend to full canvas area --
Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_EXTENDS','fullcanvas');
SET_SCROLL_PANEL_INFO_TEXT

Show, if needed, a non-scrolling warning text inside the panel.

Properties: text

default is no text.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_INFO_TEXT',

'Double-click to extend/restore panel size');

SET_SCROLL_PANEL_INFO_PROPERTIES

Set the warning text properties.

Properties: font_name,font_type,font_size,textRGB,textBackGroundRGB

font_type can be:

• N (Normal)
• B (Bold)
• I (Italic)
• BI (Bold Italic)

textRGB is the foreground text color

textBackGroundRGB is the background text color

if not provided the default values are: Verdana,N,12,r0g0b0,r240g240b240

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1,
'SET_SCROLL_PANEL_INFO_PROPERTIES',
'Verdana,B,14,r255g127b85,r230g230b230');

SET_SCROLL_DURATION

Set the duration of message display (-1, so infinite if not provided).

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_DURATION','14000');

SET_SCROLL_PANEL_LOG

Set the Scrolling Panel logging mode.

Properties: true|false

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_SCROLL_PANEL_LOG','true');

Robot properties
These properties are available since the 1.5 version

CREATE_ROBOT

Create a new Robot object.

Properties:

Must be the first method used in order to execute following robot orders.

-- robot creation --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'CREATE_ROBOT', '');

SET_ROBOT_STEP

Send an order to the robot.

This property is called within the laf.pll library, so that you normally should not use it directly.

Properties: keyword[,param1[,...]]

List of available keywords:

• delay,int millisecond (Sleeps for the specified time)

• keypress,int keystroke (Presses a given key)
• keyrelease,int keystroke (Releases a given key)
• mousemove,int x, int y (Moves mouse pointer to given screen coordinates)
• send_key, char key (send a character)
• mouse_press,int num_button (Presses one or more mouse buttons)
• mouserelease,int num_button (Releases one or more mouse buttons)
• mousewheel,int wheelAmt (Rotates the scroll wheel on wheel-equipped mice)
• setautodelay, int milliseconds (Sets the number of milliseconds this Robot sleeps after
generating an event)
• setautowaitforidle,true|false (Sets whether this Robot automatically invokes waitForIdle
after generating an event)
• waitforidle (Waits until all events currently on the event queue have been processed)
• wait, int milliseconds (Sleeps for the specified time)
• paste,string (Simulate a PASTE clipboard action)

-- send key (end of field) --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_STEP', 'send_key,END');
-- send key (left one character) --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_STEP', 'send_key,LEFT');
-- send key (paste a string) --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_STEP', 'paste,Hello');
-- press mouse left button --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_STEP', 'mouse_press,1');
Here is the list of keys you can use:

• BACK
• HOME
• END
• COPY
• CUT
• DEL
• INS
• LEFT
• RIGHT
• PGUP
• PGDOWN
• UP
• DOWN
• ALT
• SHIFT
• CTRL
• TAB
• a to z

To send a string, use the PASTE keyword.

SET_ROBOT_INFO_MENU

Indicates what type of menu is used in the current application.

Properties: nomenu | default | default&smartbar

nomenu means no menu bar at all.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_INFO_MENU', 'default&smartbar');

SET_ROBOT_FORMS_STEP

Sends a unique order to the robot.

Properties:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_FORMS_STEP'
,'Bubble(1000,200,215,160,30,I'm a bubble)');
SET_ROBOT_FORMS_STEPS

Sends a group of orders to the robot.

Properties: [START] | order[,order[,...]] | [END]

The first time this method is used, send the [START] string, then send as many orders as you
need, then send the [END] string to terminate and start executing the orders.

Remember that the Set_Custom_Property() is limited to 4000 characters.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_FORMS_STEPS', '[START]');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_FORMS_STEPS'
, 'order[,order[,...]]');
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_FORMS_STEPS'
, 'order[,order[,...]]');
...
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_FORMS_STEPS', '[END]');

SET_ROBOT_FILE_NAME

Reads orders from an external client-machine file.

Properties: full_filename

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_ROBOT_FILE_NAME', 'c:/laf_robot.txt');

SET_ROBOT_BUBBLE

Displays a bubble of text on the screen.

Properties: delay,x,y,width,height,text

delay unit is millisecond

x, y, width and height are number of pixels. They are relative to the canvas left-upper corner.
The text content can be in HTML format

-- plain text format --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_BUBBLE'
,'2000,200,215,200,45,I'm a bubble');
-- HTML text format --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_BUBBLE'
,'2000,200,215,200,45,<html>I'm a <b>bubble</b></html>');
SET_ROBOT_SHAPE

Draws a shape on the screen.

Properties: shadow,delay,shape,line_width,x,y,width,height

shadow can be 0 or 1
shape can be on of the following:

• circle
• line
• rectangle
• roundrectangle
• arrow
• polygon
• text

For lines and arrows, width is X end position, and height is Y end position.
For text, Carriage Return has to be indicated as a '<br>' string, and line_width is the font size.

To have the shape blinking, precede the shape name with 'blink_'

-– draw a circle for 4 seconds --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE'
,'1,4000,circle,2,80,100,50,60');

-– draw a blinking circle for 4 seconds --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE'
,'1,4000,blink_circle,2,80,100,50,60');

-– draw a rounded rectangle for 2 seconds --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE'
,'1,2000,roundrectangle,2,80,100,50,60');

-– draw an arrow for 6 seconds --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE'
,'1,6000,arrow,3,200,100,150,250');

-– draw a text for 3 seconds --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE'
,'1,3000,text,14,200,100,Hello<br>there');

SET_ROBOT_BUBBLE_PROPERTIES

Sets the bubble properties.

Properties: Font,type,size,foreground,background

type can be B (Bold), I (Italic), P (Plain) or BI (Bold+Italic)

If the Font is not provided, use – instead of the first 3 parameters

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_BUBBLE_PROPERTIES'
,'Verdana,B,14,r255g255b255,r0g127b255');
SET_ROBOT_SHAPE_PROPERTIES

Sets the shape properties.

Properties: foreground,background,dash_fill,dash_gap[,transparency]

for a full line use 1,0 as dash_file,dash_gap

for a balanced dashed line, use the same value for both parameters
If not provided, transparency background value is set to 0.3

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE_PROPERTIES'
,'r255g0b0,r0g0b0,10,3');

-- display next shape text with 0.5 background panel transparency value --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_SHAPE_PROPERTIES'
,'r255g0b0,r0g0b0,10,3,.5');

SET_ROBOT_TEXT_PROPERTIES

Sets the text properties.

Properties: Font,type,size,foreground,shadow,frame_border,frame_background

if frame_border and frame_background are not given, no frame is drawn behind the text.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_TEXT_PROPERTIES'
,'Verdana,B,14,r255g255b255,r0g127b255,r255g0b0,r200g0b0');

SET_ROBOT_ABORT_SCRIPT

Terminates the script execution.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'SET_ROBOT_ABORT_SCRIPT' ,'');

Script available keywords

Here is the list of keywords you can use in a robot script.

• GO_ITEM()
• GO_BLOCK()
• GO_RECORD()
• KEY-DOWN
• KEY-UP
• KEY-CLRBLK
• KEY-CLRFRM
• KEY-CLRREC
• KEY-COMMIT
• KEY-CQUERY
• KEY-CREREC
• KEY-DELREC
• KEY-DOWN
• KEY-DUP-ITEM
• KEY-DUPREC
• KEY-EDIT
• KEY-ENTQRY
• KEY-EXEQRY
• KEY-EXIT
• KEY-HELP
• KEY-LISTVAL
• KEY-NXTBLK
• KEY-NXT-ITEM
• KEY-NXTKEY
• KEY-NXTREC
• KEY-NXTSET
• KEY-PRINT
• KEY-PRVBLK
• KEY-PRV-ITEM
• KEY-PRVREC
• KEY-SCRDOWN
• KEY-SCRUP
• KEY-UP
• KEY-UPDREC
• FIRST_RECORD
• LAST_RECORD
• DO_KEY()
• MOUSE_PRESS()
• MOUSE_MOVE_TO()
• MOUSE_MOVE_TO_XY()
• BUBBLE_PROPERTIES()
• BUBBLE()
• SHAPE_PROPERTIES()
• TEXT_PROPERTIES()
• SHAPE()
• SHAPE_AROUND()
• ARROW_TO_ITEM()
• PASTE()
• SEND_KEY()
• WAIT()
MOUSE_MOVE_TO() moves the mouse pointer to the given item.

MOUSE_MOVE_TO_XY() moves the mouse pointer to the given coordinates.

SHAPE_AROUND() draw a rectangle or a rounded rectangle around the given object.

Object can be item, block or window

e.g.:

Shape_around(item,laf_block.pb_create,2000,roundrectangle,4)

Shape_around(block,dept,2000,roundrectangle,3)

Shape_around(window,-,2000,roundrectangle,3)

ARROW_TO_ITEM() draw an arrow from a given direction to an item. Useful when you want
to point to an item just by giving its name.

Argument: delay,line_width,item_name,distance,direction_to,length,direction_from

distance can be E(xternal) so that the arrows stops outside the item shape

or I(nternal) so that it stops inside the item shape.

Directions can be one of the following:

• N North
• NE North-Est
• E Est
• SE South-Est
• S South
• SW South-West
• W West
• NW North-West

e.g.:

Arrow, displayed 2 seconds, width 2 points and length 50 points from North to Inside item
North:

Arrow_To_Item(2000,2,LAF_BLOCK.PB_DELETE,I,N,50,N)

You can see an example in the sample file /fmb/laf_robot.txt used by the
test_laf_robot.fmb sample dialog.

Here is the required code in the When-Custom-Item-Event trigger of the DrawLAF bean:

DECLARE

eventName varchar2(30) := :system.custom_item_event;

eventValues ParamList;
eventValueType number;
LC$proc varchar2(10000);
LC$param varchar2(10000);
LC$LOV_Name varchar2(200);
LN$Ret Pls_Integer ;

BEGIN

-------------------
-- Robot events --
-------------------
IF (eventName='SET_ROBOT_FORMS_STEP') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'SET_ROBOT_FORMS_BUILTIN',eventValueType, LC$Proc);
get_parameter_attr(eventValues,'SET_ROBOT_FORMS_PARAMETERS',eventValueType,
LC$param);
PKG_LAF_ROBOT.LAF_ROBOT( 'LAF_BLOCK.LAF_BEAN', LC$Proc, LC$Param ) ;
END IF;

END;
Dynamic item properties
These properties are available since the 1.6 version.
They allow the developer to create dynamically items at runtime.

Dynamic items, can be created on the current canvas, or grouped on a panel.

Once they are created, they raise events back to Forms via the When-Custom-Item-Event
trigger attached to the DrawLAF bean.
The event name is : ITEM_ACTION and the properties of this event are the following:

• ITEM_ACTION_OBJECT
• ITEM_ACTION_NAME
• ITEM_ACTION_TYPE
• ITEM_ACTION_VALUE
• ITEM_ACTION_MOUSEPOS (since 1.7.6)
• ITEM_ACTION_MOUSEBUTTON (since 1.7.6)

ITEM_ACTION_OBJECT describes the object type that raised the event. It can be:

• button
• textfield
• checkbox
• image
• slider

ITEM_ACTION_NAME is the unique name given in the ADD_xxx method

ITEM_ACTION_TYPE can be:

• mouseevent
• focus
• content

ITEM_ACTION_VALUE is the value of the action type that can be:

• clicked, entered, exited, pressed or released for mouse events

• gained or lost for focus events
• changed for content event

ITEM_ACTION_MOUSEPOS is the comma delimited X,Y mouse position at click time.

Form all items it points to the position relative to the item itself.
For Image Items, it points to the absolute screen position.

ITEM_ACTION_MOUSEBUTTON is the clicked button number.

ITEM_ACTION_MOUSEPOS and ITEM_ACTION_MOUSEBUTTON can and must

be read only if ITEM_ACTION_TYPE is mouseevent.
ADD_BUTTON

Create a new Push Button.

Properties: unique_name,label,tooltip,X_pos,Y_pos,width,height

If no tooltip is defined put – (minus) instead..

-- button creation --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_BUTTON'
,'button1,the label,-,80,5,100,38');

ADD_TEXTFIELD (ADD_TEXTFIELD2)

Create a new single-line Text Item.

Properties:
unique_name,label,tooltip,X_pos,Y_pos,width,height[,background_color[,foreground_color]]

-- single-line text item creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_TEXTFIELD'
,'textfield1,Forms,-,100,90,100,20,r255g255b255');

ADD_TEXTFIELD2 creates a “Java Swing” TextField that can have a transparent background.

ADD_TEXTAREA (ADD_TEXTAREA2)

Create a new multi-line Text Item.

Properties:
unique_name,label,tooltip,X_pos,Y_pos,width,height[,background_color[,foreground_color]]

-- multi-line text item creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_TEXTAREA'
,'textarea2,Text area,-,100,25,100,50');

ADD_TEXTAREA2 creates a “Java Swing” TextArea that can have a transparent background.

ADD_CHECKBOX

Create a new Check box item.

Properties:
unique_name,label,tooltip,X_pos,Y_pos,width,height[,background_color[,foreground_color]]

-- check box item creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_CHECKBOX'
,'checkbox,Checkbox,-,100,160,18,80');
ADD_SLIDER

Create a new slider item.

Properties:
unique_name,direction,x,y,width,height[,init_value,
min_value,max_value,major_tick,minor_tick,foreground_color]

direction can be v (vertical) or h (horizontal)

-- slider item creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_SLIDER'
,'slider,h,5,170,200,38,10,0,100,25,5,r255g255b255');

ADD_LABEL

Create a new label.

Properties:
unique_name,label,x,y,width,height[,alignment,foreground_color]

alignment can be L (Left), C (Center) or R (Right)

-- label creation --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_LABEL'
,'title,label,10,8,140,20,C,#FFFFFF');

ADD_PASSWORDFIELD

Create a new password item.

Properties: same as ADD_TEXTFIELD

-- password item creation --

Set_Custom_Property(PC$Bean,1,'ADD_PASSWORDFIELD','laf_im_pwd
,'password',-,120,65,150,20,r255g255b255');

NEW_ITEM_PROPERTY

Set a new created item property.

Properties: unique_name,property

property can be:

for all : enabled, visible, location, size, value, label, font, fgcolor, bgcolor, border, opaque,
prompt, promptcolor, promptfont, promptposition, maxlength, showinrect (since 1.7.2).

for buttons : default, textposition, imageposition, imageon and imageoff.

for sliders : slidertrack,sliderticks,sliderlabels and sliderinvert.

for TextFields and TextAreas : hscrollbar, vscrollbar, editable, caretpos and selection.
hscrollbar and vscrollbar can be : ALWAYS, NEVER or AS_NEEDED. Editable can be TRUE or
FALSE.
Caretpos can take a positive value but also the kewords “start” or “end”.
Selection has the start and end values separated by a – (minus). Start and end values can also
be “start” or “end”.

for TextField2s and TextArea2s : gradient.

–- change new item property --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield1,font=Tahoma-BI-14');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield1,promptposition=right');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield1,fgcolor=r0g0b255');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield1,value=the value');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield2,border=empty');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textfield2,prompt=new prompt');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textarea2,opaque=false');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textarea2,hscrollbar=as_needed');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'textarea2,promptcolor=r255g255b255');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'button1,default=true');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'bouton1,imageoff=/all-24.gif');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'bouton2,imageoff=/book-24.gif');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'bouton1,textposition=right');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'bouton1,imageposition=LM');

–- sliders --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'slider,slidertrack=false');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'slider,sliderticks=false');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'slider,sliderlabels=false');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'slider,sliderinvert=true');
 Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'button1,showinrect=1-160-500-40');

border can be: (text items only)

• line
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty

promptposition can be: (text items only)

• left
• right
• topleft
• topcenter
• topright
• bottomleft
• bottomcenter
• bottomright

textposition can be: (button only)

• left
• center
• right
imageposition can be: (button only)

• LT (Left Top)
• CT (Center Top)
• RT (Right top)
• LM (Left Middle)
• CM (Center Middle)
• RM (Right Middle)
• LB (Left Bottom)
• CB (Center Bottom)
• RB (Right Bottom)
showinrect (since 1.7.2) defines the area coordinates used to define when to show or to hide the
component if the mouse pointer enters or exits this area.

component,showinrect=x-y-width-height

x can be "start" or any positive integer value

y can be "top" or any positive integer value
width can be "end" or any positive integer value
height can be "bottom" or any positive integer value

-- left border to right border strip --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PROPERTY'
,'button1,showinrect=start-160-end-40');
This example defines an area that takes the entire canvas width and 40 pixel height.
ITEM_SET_PANEL

Once this method is used, every subsequent call to the ADD_xxx method will add the
new item on a Panel.

The panel can have a transparent background.

If the panel is moved, the corresponding items move accordingly.
When you hide the panel the corresponding items are hidden too.
When you delete the panel, the items are destroyed at the same time.

Properties:
unique_name,X_pos,Y_pos,width,height[,background_color[,transparent[,border]]]

If transparent is true, the panel has no background.

border can be one of the following:

• line
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty

-- transparent panel creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ITEM_SET_PANEL'
,'jp,10,50,450,200,r255g255b177,true,raisedbevel');

-- invisible panel creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ITEM_SET_PANEL'
,'jp,10,50,450,200,-,true,empty');

NEW_ITEM_PANEL_PROPERTY

Set the created panel properties.

Properties: property,value[,value]

property can be:

• SIZE (width,height)
• LOCATION (X pos, Y pos)
• VISIBLE (true | false)
• OPAQUE (true | false)
• BGCOLOR (RGB color)

-- item panel property --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'NEW_ITEM_PANEL_PROPERTY'
,'size,200,180');

ITEM_DELETE_PANEL

Delete the panel with all its associated items.

Properties:

-- panel deletion --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ITEM_DELETE_PANEL', '');

GO_ITEM

Put the focus on the given item.

Properties: unique_name

-- put focus on item --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'GO_ITEM','button1');

DELETE_ITEM

Delete the given item.

Properties: unique_name

-- delete item --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'DELETE_ITEM','button1');

ITEM_NAVIGATION_INSIDE

Define the navigation rules in the created items

Properties: true | false

If set to true, the tabulation action keeps the focus inside the created items' group.
If set to false, the tabulation on the last created item gives the focus back to Forms standard
next item.

-- keep navigation inside new item group --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ITEM_NAVIGATION_INSIDE','true');

ITEM_SET_INDICE

Define the new item name in order to get its value

–- set item indice to “textfield1” item --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ITEM_SET_INDICE', 'textfield1');

-- get the item value --

LC$Value := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ITEM_GET_VALUE');
ITEM_GET_VALUE

Get the value of the item defined by the previous ITEM_SET_INDICE method.

–- set item indice to “textfield1” item --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ITEM_SET_INDICE', 'textfield1');

-- get the item value --

LC$Value := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'ITEM_GET_VALUE');

Associated When-Custom-Item-Event trigger code:

...
----------------------
-- New Item events --
----------------------
ELSIF (eventName='ITEM_ACTION') THEN
get_parameter_attr(eventValues,'ITEM_ACTION_OBJECT',eventValueType, p1);
get_parameter_attr(eventValues,'ITEM_ACTION_NAME',eventValueType, p2);
get_parameter_attr(eventValues,'ITEM_ACTION_TYPE',eventValueType, p3);
get_parameter_attr(eventValues,'ITEM_ACTION_VALUE',eventValueType, p4);
If p3 = 'mouseevent' Then -– since 1.7.6
get_parameter_attr(eventValues,'ITEM_ACTION_MOUSEPOS',eventValueType, p5);
get_parameter_attr(eventValues,'ITEM_ACTION_MOUSEBUTTON',eventValueType, p6);
End if ;
-- call generic procedure --
LAF_New_Item_Event(p1,p2,p3,p4,p5,p6);
ELSIF ...
Image item properties
These properties are available since the 1.6 version.
They allow the developer to create dynamically Image items at runtime.

The image can have a legend, an HTML tooltip and be displayed in full size when double-
clicked.

To read an image from, or write the image to a database BLOB column, use the following
functions stored in the laf pll library:

• PROCEDURE Read_Image
(
PC$Bean IN VARCHAR2, –- bean area name
PC$Image IN VARCHAR2, –- unique image name
PC$Clause IN VARCHAR2 –- complete select order
);

• PROCEDURE Write_Image
(
PC$Bean IN VARCHAR2, -- bean area name
PC$Image IN VARCHAR2, -- unique image name
PC$Table IN VARCHAR2, -- table that contains the BLOB
PC$Column IN VARCHAR2, -- BLOB column name
PC$Clause IN VARCHAR2 -- where clause to udpate one row
);

e.g.:

-- read image from database --

PKG_LOOK_AND_FEEL.Read_Image('LAF_BLOCK.LAF_BEAN','img'
,'SELECT PHOTO_JAVA FROM PHOTOS WHERE IDENTIFIANT=1');

-- write image to database --

PKG_LOOK_AND_FEEL.Write_Image('LAF_BLOCK.LAF_BEAN','img'
,'PHOTOS','PHOTO_JAVA','IDENTIFIANT=1');

IMG_NEW

Create a new Image Item.

Properties: unique_name,X pos,Y pos,width,height[,label[,image_name]]

-- new image creation --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_NEW','img,260,25,120,120,Label image');
IMG_DELETE

Delete the given image.

Properties: unique_name

-- new image deletion --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_DELETE','img');

IMG_DELETE_ALL

Delete all new created images.

Properties:

Must be the first method used in order to execute following robot orders.

-- delete all images --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_DELETE_ALL','');

IMG_SET_POSITION

Set the Image new position on the screen.

Properties: unique_name,X pos,Y pos

-- new image position --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_POSITION','img,100,80');

IMG_SET_LEGEND

Set the new image's legend.

Properties: unique_name,legend

-- new image legend --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_LEGEND','img,The legend');
IMG_SET_BACKGROUND

Set the new image background color.

Properties: unique_name,RGBcolor | transparent

-- new image background --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_BACKGROUND','img,r255g0b0');

-- transparent background –
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_BACKGROUND','img,transparent' ) ;

IMG_CLEAR

Clear the new image.

Properties: unique_name

-- clear new image --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_CLEAR','img');

IMG_READIMGFILE

Populate the image from a file.

Properties: unique_name,file_name

The file can be in a JAR, the client machine or anywhere on the Internet.

-- populate image item from a file --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_READIMGFILE','img,/carla.jpg');

IMG_READIMGBASE

Populate the image from a database BLOB column.

This method is not invoked directly, but is the result of the use of the
PKG_LOOK_AND_FEEL.Read_Image() laf.pll function.

Properties:

See the PKG_LOOK_AND_FEEL.Read_Image() laf.pll function.

IMG_SCALE_IMAGE

Gives scaling indications.

Properties: unique_name,width_scale,height_scale

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SCALE_IMAGE'
,'img,Width=FIT,Height=-1' );

FIT means the image fits the width or the height of the image frame.
-1 means the image keep the aspect ratio
Other numeric values are interpreted as pixel sizes.

IMG_CENTER_IMAGE

Center the image in its frame.

Properties: unique_name,true | false

-- center new image --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_CENTER_IMAGE','img,true' );

IMG_LABEL_COLOR

Set the image's label color.

Properties: unique_name,RGBcolor

-- image label's color --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_LABEL_COLOR', 'img,r200g200b200');

IMG_SET_SCROLLBARS

Display/hide the scrollbars.

Properties: unique_name,true | false

-- image scrollbars --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_SCROLLBARS','img,true');
IMG_SET_BORDER

Set the image's border type.

Properties: unique_name,border

border can be:

• line
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty
• pixel_size,color

-- image border --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_BORDER','img,loweredbevel' ) ;

-- image border 3 pixel red line--

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_BORDER','img,3,r255g0b0' ) ;

IMG_SET_TOOLTIP

Set the image's tooltip. You can use HTML format to decorate the tooltip.

Properties: unique_name,tooltip

-- image label's tooltip --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_TOOLTIP'
,'img,<html><body>....</body></html>');

IMG_SET_FILECHOOSER_TITLE

Set the image file chooser title and starting directory.

Properties: unique_name,title[,start directory]

-- image file chooser title --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_SET_FILECHOOSER_TITLE'
,'img,Choose an image,c:/images');
IMG_GET_FILE_NAME

Display the image file chooser then returns the selected filename.

Properties:

-- get image filename –-

file_name := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_GET_FILE_NAME');

IMG_GET_IMAGE_SIZE

Get the image size.

Use, first the IMG_SET_INDICE method to identify the image

Properties: unique_name

-- get image size –

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_INDICE','img');

size := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_GET_IMAGE_SIZE');

IMG_GET_IMAGE_WIDTH

Get the image width.

Use, first the IMG_SET_INDICE method to identify the image

Properties: unique_name

-- get image size –

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_INDICE','img');

width := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_GET_IMAGE_WIDTH');

IMG_GET_IMAGE_HEIGHT

Get the image height.

Use, first the IMG_SET_INDICE method to identify the image

Properties: unique_name

-- get image size –

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_INDICE','img');

height := Get_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMG_GET_IMAGE_HEIGHT');

IMG_SET_DBLCLICK_SHOW_IMAGE

Display image in separate frame on double-click.

Properties: unique_name,true | false

If property is false a DOUBLECLICK event is sent via the Set_Item_Custom_Property trigger.

-- Display image on double-click –

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_DBLCLICK_SHOW_IMAGE','img,true');

IMG_SET_LOG

Set/unset output to the Java console.

Properties: unique_name,true | false

-- image log –
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMG_SET_LOG','img,true');
Popup menu properties
These properties are available since the 1.6.4 version.
They allow the developer to create dynamically pop-up menus at run time.

CREATE_POPUP_MENU

Create a new pop-up menu. Must be used first.

Properties: popup_name[,RGBcolor[,opaque[,border]]]

opaque can be true or false

border can be:

• line
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty

-- popup with raisedbevel border --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'CREATE_POPUP_MENU'
,'popup1,-,true,raisedbevel');

-- popup with no border and transparent background --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'CREATE_POPUP_MENU'
,'popup2,-,true,empty');

ADD_POPUP_MENU_OPTION

Add an option to the pop-up menu.

Properties: popup_name,option_id,option_label[,icon[,icon_position[,label_position]]]

icon_position can be:

LT, CT, RT, LM, CM, RM, LB, CB, RB

L(eft), C(enter), R(ight), T(op), M(iddle), B(ottom)

default is : LM

label_position can be:

• left
• center
• right

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_POPUP_MENU_OPTION'
,'popup3,opt31,3 Option one,-,-,right');
SET_POPUP_MENU

Indicates what pop-up menu is active.

Properties: popup_name|null

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU','popup3');

If set to 'null', no popup will be displayed.

SET_POPUP_MENU_FONT

Set the pop-up menu font.

Properties: popup_name,font_name[,size[,style]]

default values:

• size 12
• style N(ormal)

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU_FONT'
,'popup2,Verdana,14,B');

SET_POPUP_MENU_FONT_COLOR

Set the pop-up menu font color.

Properties: popup_name,RGBcolor

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU_FONT_COLOR'
,'popup2,r123g45b87');

SET_POPUP_MENU_ICON

Set a pop-up menu option icon.

Properties: popup_name,option_id,icon_name[,icon_position]

icon_position can be:

LT, CT, RT, LM, CM, RM, LB, CB, RB

L(eft), C(enter), R(ight), T(op), M(iddle), B(ottom)

default is : LM

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU_ICON'
,'popup2,opt1,/help.gif,LM');
SET_POPUP_MENU_OPTION_PROPERTY

Set a pop-up option property.

Properties: popup_name,option_id,property,value

property can be:

• enabled (true/false)
• label
• icon
• tooltip
• icon_position
• label_position

icon_position can be:

LT, CT, RT
LM, CM, RM
LB, CB, RB

L(eft), C(enter), R(ight), T(op), M(iddle), B(ottom)

default is : LM

label_position can be:

• left
• center
• right

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU_OPTION_PROPERTY'
,'popup3,opt35,enabled,false');

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU_OPTION_PROPERTY'
,'popup3,opt34,label,short label');

SHOW_POPUP_MENU

Show/hide a pop-up menu.

Properties: popup_name,true|false[,pos_x,pos_y[,initial_option]]

NOTE : generally the popup is automatically shown/hidden with action on mouse

-- show popup --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SHOW_POPUP_MENU','popup2,true');

-- hide popup --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SHOW_POPUP_MENU','popup2,false');

initial_Option move the mouse pointer under the given option. If you don't give the pos_y and
pos_y argument, set them to '-'.
 -- show popup and point to second option button --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SHOW_POPUP_MENU'
,'popup2,true,-,-,2');

REMOVE_POPUP_MENU_OPTION
Remove a pop-up menu option.

Properties: popup_name,option_id

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'REMOVE_POPUP_MENU_OPTION'
,'popup3,opt34');

DELETE_POPUP_MENU

Delete a pop-up menu.

Properties: popup_name

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'DELETE_POPUP_MENU','popup3');

A new popup menu creation sample code:

-- create a new popup menu --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'CREATE_POPUP_MENU'
,'popup1,-,true,raisedbevel');
-- add options --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_POPUP_MENU_OPTION'
,'popup1,opt11,Option 1');
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_POPUP_MENU_OPTION'
,'popup1,opt12,Option number 2');
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_POPUP_MENU_OPTION'
,'popup1,opt13,Option three');
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'ADD_POPUP_MENU_OPTION'
,'popup1,opt14,Brand New Option four');
-- set the menu active --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_POPUP_MENU','popup1');
The messages sent back to Forms

You know what pop-up option has been selected through the When-Custom-Item-Event trigger.

DECLARE
eventName varchar2(30) := :system.custom_item_event;
eventValues ParamList;
eventValueType number;
p1 varchar2(256);
p2 varchar2(256);
p3 varchar2(256);
p4 varchar2(256);
BEGIN
------------------------
-- Popup menu events --
------------------------
IF (eventName='ITEM_ACTION') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'ITEM_ACTION_OBJECT',eventValueType, p1);
get_parameter_attr(eventValues,'ITEM_ACTION_NAME',eventValueType, p2);
get_parameter_attr(eventValues,'ITEM_ACTION_TYPE',eventValueType, p3);
get_parameter_attr(eventValues,'ITEM_ACTION_VALUE',eventValueType, p4);

If p1 = 'popup' And
p3 = 'mouseevent' And
p4 = 'clicked' Then
Message('Option selected: ' || p2, no_acknowledge);
Synchronize;
End if ;

END IF;
END;

The event name is ITEM_ACTION, and the values returned are the following:

• ITEM_ACTION_OBJECT “popup”
• ITEM_ACTION_NAME the option ID
• ITEM_ACTION_TYPE “mouseevent”
• ITEM_ACTION_VALUE entered,exited,clicked,pressed or released.
Asynchronous JDBC calls (since the 1.6.7 version)

These methods use the JDBC driver to access the Database.

In order to call the JDBC driver's methods, you need to add and sign the classes12.jar file to
the archive tags of your /forms/server/formsweb.cfg configuration file:

...
archive=frmall.jar,...,laf_10123.jar,classes12.jar
...

You should, normally, find it in the <DEVSUITE_HOME>/jdbc/lib folder.

The laf_xxxx.jar file has to be signed, and you cannot mix, in the same archive tag, signed and
unsigned JAR files, so that you have to sign all the JARs present in this tag with the same
signature (except the frmall.jar).

Every call to the DB_SET_PROCEDURE() and DB_SET_FUNCTION() is executed in its own

Forms' independent transaction. The transaction is committed in case of no error, otherwise it
is rollbacked.

The procedure or function is executed in an independent thread in an asynchronous way, so

that it won't “freeze” the Forms application.

It cannot handle procedures and functions that contain OUT or/and IN OUT
arguments.

DB_SET_DBINFO

Set the Database Information for the JDBC connection.

Properties: jdbc:oracle:thin@machine:port:instance

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'DB_SET_DBINFO'
, 'jdbc:oracle:thin:@machine:1521:XE');

DB_SET_USER

Set the Database User name for the JDBC connection.

Properties: user_name

LC$User := Get_Application_Property(USERNAME);
...
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'DB_SET_USER', LC$User);
DB_SET_PWD

Set the Database Password for the JDBC connection.

Properties: password

LC$Pwd := Get_Application_Property(PASSWORD);
...
Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'DB_SET_PWD', LC$Pwd);

DB_SET_PROCEDURE

Start a Database procedure.

Properties: name|procedure_call

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'DB_SET_PROCEDURE' ,'P1|proc_name(1)');

DB_SET_FUNCTION

Start a Database function.

Properties: name|function_call

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'DB_SET_FUNCTION' ,'F1|fct_name(1)');

DB_SET_POPUP

Set the message displayed in a Popup during the procedure call.

Properties: same syntax as the SET_FLASH_TEXT2() method.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'DB_SET_POPUP'
,'LEFT|BOTTOM| Database method %NAME%() running... |1000|r255g255b255|r42g127b255');

To have no popup displayed, set the value to null:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'DB_SET_POPUP', '');

If you put the %NAME% special tag, it will be replaced by the procedure name sent by the
DB_SET_PROCEDURE() and DB_SET_FUNCTION() methods.

The first argument – X POS – can be a valid integer value or one of the following keyword:
• LEFT
• CENTER
• RIGHT
The second argument – Y POS - can be a valid integer value or one of the following keyword:
• TOP
• CENTER
• BOTTOM

Do not change the timing value (|1000|), but you can change the 2 colors - 5th and 6th
argument).

The messages sent back to Forms

You know what procedure has been finished through the When-Custom-Item-Event trigger
attached to the DrawLAF Bean Area.

DECLARE
eventName varchar2(30) := :system.custom_item_event;
eventValues ParamList;
eventValueType number;
p1 varchar2(1024);
p2 varchar2(1024);
p3 varchar2(1024);
p4 varchar2(1024);
BEGIN
-----------------
-- DB events --
-----------------
IF (eventName='DB_EVENT') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'DB_NAME',eventValueType, p1);
get_parameter_attr(eventValues,'DB_RESULT',eventValueType, p2);
get_parameter_attr(eventValues,'DB_ERROR',eventValueType, p3);
get_parameter_attr(eventValues,'DB_START',eventValueType, p4);
get_parameter_attr(eventValues,'DB_END',eventValueType, p5);
END IF;
END;

The event name is DB_EVENT, and the returned values are the following:

• DB_NAME the Function or Procedure name.

• DB_RESULT the result of the function or “OK” for a procedure.
• DB_ERROR the error message if any.
• DB_START the start time.
• DB_END the end time.
External command calls (since the 1.6.8 version)

These methods allows the programmer to execute a client host command, then get the result
or error back. The result is sent line by line in an asynchronous way.

SET_EXT_PROG

Execute the command on the client machine.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_EXT_PROG'
, 'cmd /c dir /b c:\*,jpg');

If one of the parameters contains a space (blank), pass it surrounded by double-quotes:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'SET_EXT_PROG', 'cmd,/c,findstr

,"width height",d:\devsuite\forms\server\formsweb.cfg' ) ;

The result of the command, texte or error message is sent by the Java Bean to Forms via the
When-Custom-Item-Event trigger.

The event name is EXT_MSGSTND for a correct result or EXT_MSGERROR for an error
message. The text itself is transmitted line by line and asynchronously via the EXT_MSGTEXT
event. When the external program is finished, you receive a EXT_MSGEND event.

-------------------------------
-- External command events --
-------------------------------
...
ElsIF (eventName='EXT_MSGSTND') THEN
-- get the standard output --
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'EXT_MSGTEXT'
,eventValueType, LC$param);
ELSIF (eventName='EXT_MSGERROR') THEN
-- get the component properties --
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'EXT_MSGTEXT'
,eventValueType, LC$param);
ELSIF (eventName='EXT_MSGEND') THEN
-- the external program is finished --
...
END IF;
Image Spinner (since the 1.7.1 version)

These methods allows the programmer to manage an image spinner located on the canvas.
The spinner is designed to handle images loaded from the client machine (file system or JAR),
the internet or the database. You can also drag and drop image files or folders from the client
file system.
The Bean can manage as many spinners as you want.

IMAGE_SPINNER_NEW

Add a new image spinner on the canvas.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_NEW','spin');

IMAGE_SPINNER_SET_LOCATION

Set the spinner location on the canvas.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LOCATION','spin,5,5');

IMAGE_SPINNER_SET_SIZE

Set the image spinner size.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_SIZE','spin,100,100');

IMAGE_SPINNER_SET_BACKGROUND

Set the image spinner background.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_BACKGROUND'
,'spin,#ffffff');

If color equals the “null” string, the panel has no background, so is transparent:

-- transparent spinner background --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_BACKGROUND'
,'spin,null');
IMAGE_SPINNER_SET_BORDER

Set the image spinner border.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_BORDER'
,'spin,line,#80A5EA');

border can be:

• line,color
• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• empty
• null

IMAGE_SPINNER_SET_LEGEND_HALIGN

Set the image spinner legend horizontal alignment.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LEGEND_HALIGN'
,'spin,center');

alignment can be:

• left
• center
• right

If not provided, default is left.

IMAGE_SPINNER_SET_LEGEND_VALIGN

Set the image spinner legend vertical alignment.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LEGEND_VALIGN'
,'spin,top');

alignment can be:

• top
• bottom

If not provided, default is bottom.

IMAGE_SPINNER_SET_LEGEND_FONT

Set the image spinner legend font.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LEGEND_FONT'
,'spin,Arial,bold,10');

Style can be:

• plain
• bold
• italic
• bolditalic

IMAGE_SPINNER_SET_LEGEND_COLORS

Set the image spinner legend colors.

syntax is: spinner_name,foreground[,background]

–- set both foreground and background colors --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LEGEND_COLORS'
,'spin,#000,#fff');
–- set only foreground color --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LEGEND_COLORS'
,'spin,#80A5EA');

IMAGE_SPINNER_SHOW_LEGEND

Show/hide the image spinner legend.

If you do not want to manage any image legend, you can tell the spinner to hide the
associated area.

-- hide the legend area --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SHOW_LEGEND'
,'spin,false');

IMAGE_SPINNER_SET_LABELS

Set the image spinner image properties labels.

When you load a new image into the spinner you can associate some properties in order to
store them later in the database. Each image can have the following properties:

• name
• legend
• tooltip
When the end-user add images to the spinner, a dialog box is displayed to let the user set
these properties.
This method describes what properties you want to save and the label translation displayed in
the title property grid.

By default, no property is handled, so no grid is displayed when new images are loaded. The
image name is the one corresponding to the source file name.
If you want to change other properties, just provide the property title in the method:

Syntax is: spinner_name,dialog box general title,name_title[,legend title[,tooltip title]]

-- set box and name translations --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LABELS'
,'spin,new image properties,Name');
-- set box, name and legend translations --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LABELS'
,'spin,new image properties,Name,Legend');
-- set box, name, legend and tooltip translations --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_LABELS'
,'spin,new image properties,Name,Legend,Tooltip');

IMAGE_SPINNER_SET_IMAGE

Add a new image to the spinner.

Syntax is: spinner_name|image_name[|image_legend[|image_tooltip]]

Notice that the separator is | (alt-124) to allow commas in the legend and/or the tooltip.

The image can be loaded from a client JAR or file name or an internet URL.

-- image loaded from a JAR file --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_IMAGE'
,'spin|image1|/carla.jpg|legend1|tooltip1');
-- image loaded from the client system file --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_IMAGE'
,'spin|image1|c:/carla.jpg|legend1|tooltip1');

If you want to populate the spinner with database images, see the
IMAGE_SPINNER_SET_IMAGE_BASE method.

IMAGE_SPINNER_SET_IMAGE_BASE

Add a new image from the database to the spinner.

Syntax is: spinner_name|image_name[|image_legend[|image_tooltip]]

Notice that the separator is | (alt-124) to allow commas in the legend and/or the tooltip.

This method needs the PKG_LAF database package to transfer images chunks between the
database and the Java Bean.
It is generally embedded in a PL/SQL procedure stored in the Forms module:
PROCEDURE Load_Database_Image
(
PC$Bean IN Varchar2,
PN$Record IN Pls_Integer,
PC$Spinner IN Varchar2,
PC$Query IN Varchar2,
PC$Name IN Varchar2,
PC$Legend IN Varchar2 Default NULL,
PC$Tooltip IN Varchar2 Default NULL
)
IS
LB$Ok boolean ;
LC$Image Varchar2(32767) ;
LC$Clause Varchar2(4000) ;
BEGIN
--
-- Read a BLOB content from the database
--
-- Select the Blob column --
If PKG_LAF.Select_Blob(PC$Query) Then
Loop
-- Get the image chunks from the database --
LC$Image := PKG_LAF.Get_B64_Chunk ;
If LC$Image Is Not Null Then
-- Send the chunks to the Java Bean --
Set_Custom_Property( PC$Bean, PN$Record
, 'IMAGE_SPINNER_SET_IMAGE_BASE'
, PC$Spinner || '|' || LC$Image ) ;
Else
-- End the sending process --
LC$Image := '[END_IMAGE]|' || PC$Name ;
If PC$Legend is not null then
LC$Image := LC$Image || '|' || PC$Legend ;
End if ;
If PC$Tooltip is not null then
LC$Image := LC$Image || '|' || PC$Tooltip ;
End if ;
Set_Custom_Property( PC$Bean, PN$Record
, 'IMAGE_SPINNER_SET_IMAGE_BASE'
, PC$Spinner || '|' || LC$Image );
Exit ;
End if ;
End loop ;
End if ;
END;

that you call with the following code:

-- image loaded from a Blob column --

Load_Database_Image('LAF_BLOCK.LAF_BEAN',1,'spin'
,'SELECT IMAGE FROM LAF_IMAGE_SPINNER WHERE NAME=''image1'''
,'image1','legend image 1','Tooltip 1');

IMAGE_SPINNER_SET_SCALE

Set the image spinner image scaling behavior.

It defines how the images will be scaled or not at display time.

Possible values are:
 • FIT
• FITALL
• LARGEST
• none

FIT means that one of the image size will be adjusted to the spinner size, and the other will
keep the aspect ratio.

FITALL means that both width and height will be scaled to fit the spinner box size.

LARGEST means that the spinner box will be increased to fit the largest image size, but this
size will not exceed the size given in the IMAGE_SPINNER_SET_MAX_SIZE method.

None, means no scaling.

-- scale image to the largest given --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_SCALE'
,'spin,LARGEST');
-- scale image to fit the spinner size --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_SCALE'
,'spin,FIT');

IMAGE_SPINNER_SET_MAX_SIZE

Set the image spinner maximum size.

If you set the spinner image scale to LARGEST, it will increase it size to fit the largest loaded
image size. If the largest image is very big, it could explode your dialog design, so this method
is used to limit the spinner box size.

-- set initial spinner box to 100x100 pixels --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_SIZE'
,'spin,100,100');
-- scale image to the largest given --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_SCALE'
,'spin,LARGEST');
–- limit spinner box enlargement to 200x200 pixels --
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_MAX_SIZE'
,'spin,200,200');

IMAGE_SPINNER_REFRESH

Refresh the spinner with new loaded images.

It orders the spinner to display its new content when all images are loaded.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMAGE_SPINNER_REFRESH', 'spin');

IMAGE_SPINNER_CLEAN

Clear the image spinner.

This will clear the image spinner in order to populate it with a new image set.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1, 'IMAGE_SPINNER_CLEAN', 'spin');

It will typically be used in a When-New-Record-Instance trigger, for example.

IMAGE_SPINNER_DISPLAY

Show/hide the image spinner.

-- hide the spinner --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_DISPLAY','spin,false');

IMAGE_SPINNER_SET_MAGNIFIER

Allow the image spinner to show the double-clicked image full size in a separate
frame.

If set to true, the end-user can display the full size original image in a separate frame when
he/she double-click it.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_MAGNIFIER'
,'spin,true');

If not defined, the default value is false.

IMAGE_SPINNER_REMOVE

Remove the image spinner from the canvas.

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_REMOVE','spin');

IMAGE_SPINNER_SET_CURRENT

Set the image spinner current image.

If you want to know what is the spinner current image displayed, you have to indicate first
what spinner is involved before calling the IMAGE_SPINNER_GET_IMAGE_NAME method.

-- set the current spinner --

Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_CURRENT','spin');
-- get the current image name --
LC$Image := Get_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'IMAGE_SPINNER_GET_IMAGE_NAME');
IMAGE_SPINNER_GET_NEW_LIST

Get the image spinner new images list.

You can get the new loaded images list, in order to generally store them into the database.

-------------------------------
-- get new images list --
-- then save in the database --
-------------------------------
Declare
list varchar2(10000);
tok varchar2(2000);
name varchar2(1000);
legend varchar2(1000);
tooltip varchar2(1000);
i pls_integer := 1 ;
Begin
Set_Custom_Item_Property('LAF_BLOCK.LAF_BEAN','IMAGE_SPINNER_SET_CURRENT','spin');
list := get_custom_property('LAF_BLOCK.LAF_BEAN',1,'IMAGE_SPINNER_GET_NEW_LIST');
loop
tok := regexp_substr (list, '[^~]+', 1, i);
i := i + 1;
exit when tok is null;
name := regexp_substr (tok, '[^|]+', 1, 1);
legend := replace(regexp_substr (tok, '[^|]+', 1, 2), 'null', null);
tooltip := replace(regexp_substr (tok, '[^|]+', 1, 3), 'null', null);
-- update image --
Save_Database_Image('LAF_BLOCK.LAF_BEAN',1,'spin',name,legend,tooltip
,'LAF_IMAGE_SPINNER','IMAGE','name=''' || name || '''');
end loop;
forms_ddl('commit');
End;

The method returns a delimited string where each image line is delimited by a ~ and inside
each line, the properties are delimited by a | (alt-124).

IMAGE_SPINNER_SET_CURRENT_IMAGE

Set the image spinner image name.

It is used to select an image from the spinner in order to save it to the database.
This method is used with the IMAGE_SPINNER_GET_IMAGE method that get the image chunks
from the spinner to transfer them to the database via the PKG_LAF database package.
PROCEDURE Save_Database_Image
(
PC$Bean IN Varchar2, -- bean area name
PN$Record IN Pls_Integer, –- table-block record number
PC$Spinner IN Varchar2, -- spinner name
PC$ImgName IN Varchar2, -- image name
PC$Legend IN Varchar2, -- image legend
PC$Tooltip IN Varchar2, -- image tooltip
PC$Table IN Varchar2, -- database table name
PC$Column IN Varchar2, -- database column name
PC$Where IN Varchar2 -- where clause
)
IS
LC$Req Varchar2(32000);
LN$Cpt Pls_integer := 0 ;
LC$Res Varchar2(2000) ;
BEGIN
--------------------------------------------
-- check if record exists in the database --
--------------------------------------------
Begin
Select '1'
Into LC$Res
From laf_image_spinner
Where name = PC$ImgName
And rownum <= 1
;
Exception
When no_data_found Then
-- create record --
Insert Into laf_image_spinner(
name, legend, tooltip, image
)
Values (
PC$ImgName, PC$Legend, PC$Tooltip, empty_blob()
);
End;
--
-- Save the image to the database
--
Set_Custom_Property(PC$Bean, PN$Record,'IMAGE_SPINNER_SET_CURRENT_IMAGE'
,PC$Spinner||','||PC$ImgName);

Loop
-- Get the image chunk from the Java Bean --
LC$Req := Get_Custom_Property(PC$Bean, PN$Record,'IMAGE_SPINNER_GET_IMAGE');
Exit When LC$Req is null ;
LN$Cpt := LN$Cpt + 1 ;
If Ln$Cpt = 1 Then
Pkg_laf.Init_Transfer ;
End if ;
-- Send the image chunks to the Database --
Pkg_laf.Set_B64_Chunk(LC$Req);
End loop;
If LN$Cpt > 0 Then
-- Update the Blob column with the new content --
LC$Res := Pkg_laf.Save_Blob(PC$Table,PC$Column,PC$Where );
End if ;
END;

Called with the following code:

-- save image to database --

Save_Database_Image('LAF_BLOCK.LAF_BEAN',1,'spin',name,legend,tooltip
,'LAF_IMAGE_SPINNER','IMAGE','name=''' || name || '''');
forms_ddl('commit');
IMAGE_SPINNER_SET_KEEP_SIZE

Indicates if the component should keep the original image size.

If you intend to load many images and don't want to store them later, you can set this to false
to save memory.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,
'IMAGE_SPINNER_SET_KEEP_SIZE','spin,false');

As the Image Spinner can handle several images, it is not designed to store hundreds images.
If you encounter Java memory issue, do not hesitate to increase the memory allowed to the
JRE.
Edit your HTML starting file (probably /forms/server/basejpi.htm) to add the corresponding
lines:

…
<PARAM NAME="java_arguments" value="-Xms128m -Xmx512m">
…
<EMBED SRC="" PLUGINSPAGE="%jpi_download_page%"
…
java_arguments="-Xms128m -Xmx512m"
The message sent back to Forms

You know what image is selected/displayed through the When-Custom-Item-Event trigger

attached to the DrawLAF Bean Area.

DECLARE
eventName varchar2(30) := :system.custom_item_event;
eventValues ParamList;
eventValueType number;
p1 varchar2(1024);
p2 varchar2(1024);
BEGIN
----------------------
-- Spinner events --
----------------------
IF (eventName='SPINNER_EVENT') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'SPINNER_NAME',eventValueType, p1);
get_parameter_attr(eventValues,'SPINNER_IMAGE_NAME',eventValueType, p2);
END IF;
END;

The event name is SPINNER_EVENT, and the returned values are the following:

• SPINNER_NAME the spinner name.

• SPINNER_IMAGE_NAME the image name.

The test_laf_image_spinner.fmb sample dialog shipped with the LAF zip file is based on the
following table:

create table laf_image_spinner

(
name varchar2(256 CHAR) NOT NULL
,legend varchar2(256 CHAR)
,tooltip varchar2(1000 CHAR)
,image blob
)
Dynamic table-blocks (since the 1.7.5 version)

This feature allows the developer to dynamically handle table-blocks at run-time.

The table-block is represented as a Java Swing JTable.

Even though the Java Bean needs the Set_Custom_Property() and Get_Custom_Property()
built-ins, the developer won't use them directly, but use equivalent Set_property() and
Get_Property() functions stored in the PKG_Table laf.pll's package.

So to see how to handle the dynamic table-blocks, refer to the laf.pll documentation.

Main features description

Table

The dynamic table-block is a Java JTable that can be populated by a database query or with
hand-given data.
The end-user can re-size, reorder and sort the columns of the table.
The end-user can enlarge the table with a Right-click so that the table will take the full canvas
size. Another Right-click will bring the table back to its original size.
The table can be displayed in a separate window.
The table can support a pagination system, so that you don't have to query the whole table
rows.
You can dynamically change the number of visible rows at run-time.
The same DrawLAF bean can support several dynamic table-blocks.
A total line can be added to the table to show some calculation operations on columns like
COUNT, SUM, AVG, MAX and MIN.

Images

It can display images provided by a database BLOB column (GIF, JPG, JPEG and PNG format).
The end-user can drop an image file to the column and use the “DEL” keyboard key to delete
the current image.
With a double-click on the image, he/she can display the image in a separate window in its
original size.

CLOBs

CLOB columns can be edited in a full-size editor panel that supports the undo management.
The user also has a Find/next feature to find specific words in the text, using the Ctrl+F key.

Check-boxes

A column that represents Boolean kind of values can be represented as a check-box widget.
For that purpose, use the “CHECKBOX” PKG_TABLE.Set_Property() built-in BEFORE displaying
the data-set with the Display_Table() function:

PKG_Table.Set_Property('tb1', 'CHECKBOX=C6,CHECKBOX,Yes,No');

This means that the C6 column will show a check-box widget where checked value is “Yes” and
unchecked value is “No”.
Poplists

A column can be represented as a pop-list. The list of available values if given through the
PKG_Table.Set_Property() procedure.

PKG_Table.Set_Property('tb1', 'CELLPROP=C2,COMBOBOX,true,line 1^line 2^line 3');

This means that the C2 column will use a Pop-list widget and values are line 1, line 2 and line
3.
The third argument (true/false) indicates if the null value is allowed. If set to false, it is
equivalent to the REQUIRED standard item property set to Yes.

Warning and limitations

Memory

As it is a Java component, it uses the Java Virtual Machine's memory. If you expect to show a
large amount of data and/or many images, you should pay attention to the memory allowed to
the JVM. If needed, edit your HTML starting file (probably /forms/server/basejpi.htm) to add or
modify the corresponding lines:

…
<PARAM NAME="java_arguments" value="-Xms256m -Xmx512m">
…
<EMBED SRC="" PLUGINSPAGE="%jpi_download_page%"
…
java_arguments="-Xms256m -Xmx512m"

ROWID

If you want to allow the user to modify rows in the table (Update, Insert, Delete), the query
should provide the ROWID column, for example:

SELECT t.ROWID,t.identifiant,t.nom,t.photo from photos t

If you query the whole table columns by only providing the database table name, the ROWID
will be automatically retrieved.

Pagination and posting changes

If you allow the pagination (PAGESIZE != -1), the program will refresh the data of the table by
reading new data-sets from the database. To keep the changes made on the previous page, it
will automatically POST those changes to the database before querying a new data-set.
That implies that the DML orders (INSERT, UPDATE and DELETE) will be applied to the
database every time a new page is requested.
Of course, the changes will be completely validated in the database at commit time only.
Data-types allowed in the query

The columns' data-types allowed in the query can be:

• VARCHAR2
• NUMBER
• INTEGER
• DATE
• BLOB (images only)
• CLOB

Date and number Java formats

As the dynamic table-block is a Java Swing JTable, you need to format dates and numbers with
Java formats instead of Forms PL/SQL formats.

Here are links to the Java formats:

Link to the Java date formats

Link to the Java numeric formats

To test this feature, open and run the test_laf_DynTable.fmb sample dialog shipped with the
LAF zip file.
To have it running “as is”, you must create the laf_dyn_table database table, using the
creation script located in the /script/create_laf_dyn_table.sql file.
The message sent back to Forms

You know what action has been done through the When-Custom-Item-Event trigger attached
to the DrawLAF Bean Area.

---------------------------------
-- Dynamic Table-block events --
---------------------------------
ElsIF (eventName='TB_POST_CHANGE') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
ElsIf (eventName='TB_NEW_RECORD_INSTANCE') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
:GLOBAL.CURRENT_ROW := p1 ;
ElsIf (eventName='TB_NEW_ITEM_INSTANCE') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
:GLOBAL.CURRENT_CELL := p1 ;
ElsIf (eventName='TB_WHEN_MOUSE_CLICK') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
ElsIf (eventName='TB_WHEN_MOUSE_DOUBLECLICK') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
ElsIf (eventName='TB_GET_PAGE') THEN
eventValues := get_parameter_list(:system.custom_item_event_parameters);
get_parameter_attr(eventValues,'TB_TABLE_EVENT_MSG',eventValueType, p1);
get_parameter_attr(eventValues,'TB_NAME',eventValueType, p2);
If p1 Is Not Null Then
-- proceed DML operations if paging defined --
If PKG_TABLE.Ask_Proceed_DML_table(p2) Then
If PKG_TABLE.Display_table( p2, p1, FALSE ) > 0 Then
PKG_Table.Set_Property(p2, 'PAGE_REFRESH=' || p1);
End if ;
End if ;
End if ;
END IF;

For every event, the TB_NAME event value contains the unique table-block name.

The event name TB_POST_CHANGE, fires every time a cell content has changed.
p1 returns a comma delimited string (row_number,cell_number)
The event name TB_NEW_RECORD_INSTANCE, fires every time a new row is selected.
p1 returns the number of the new row
The event name TB_NEW_ITEM_INSTANCE, fires every time a new cell is selected.
p1 returns the number of the new cell
The event name TB_WHEN_MOUSE_CLICK, fires every time a cell is clicked.
p1 returns the number of the clicked button
The event name TB_WHEN_MOUSE_DOUBLECLICK, fires every time a cell is double-clicked.
p1 returns the number of the clicked button
The event name TB_GET_PAGE, fires every time the table-block needs a new data-set.
p1 returns the number of the new page to refresh
Video player (since the 1.7.6 version)
The Video player permits to play video files through the QuickTime Java bean.
It needs QuickTime player installed on the client machine.

QUICKT_SET_PANEL

Display a panel to play video.

Properties: Xpos,YPos,Width,Height,remote_control[,show_in_frame]

If remote_control is set to true, a buttons' bar is shown to control the video.

If show_in_frame is set to true, the video is displayed in an independent frame.

-- video with toolbar, within the Forms canvas --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL', '10,80,250,250,true');

-- video with toolbar, in an independent frame --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL'
,'10,80,250,250,true,true');

QUICKT_SET_PANEL_BORDER

Set the video panel border.

Border can be:

• raisedetched
• loweredetched
• raisedbevel
• loweredbevel
• line
• empty

-- lowered border --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL_BORDER', 'loweredbevel');
-- 2 pixel black line border --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL_BORDER', 'line,2,r0g0b0');

QUICKT_SET_PANEL_COLOR

Set the panel background color.

If color = 'null', the panel as a null background color.

e.g.:
 -- hide the focus lines --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL_COLOR', '#FFD4AA');
-- hide the focus lines –
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_PANEL_COLOR', 'null');

QUICKT_SET_MOVIE

Load a video from a URL.

The URL can point to:

• a client machine file : c:/movie.mov

• an Application Server virtual directory : /forms/videos/movie.mov
• an Internet URL : http://...

e.g.:

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_MOVIE', 'C:/movie.mov');

In case of Application Server location, the URL must start with /forms

QUICKT_SET_MOVIE_BASE

Load a video from a database BLOB column.

For that purpose, use the PKG_LOB.Load_Video_From_Base() procedure of the laf.pll PL/SQL
library:

PROCEDURE Load_Video_From_Base
(
PC$Bean IN Varchar2, –- Bean Area name
PC$WhereClause IN Varchar2, –- database WHERE clause
PC$Name IN Varchar2 -– video clip name
);

The WHERE clause must return one single row from the database table.

e.g:

PKG_LOB.Load_Video_From_Base('LAF_BLOCK.LAF_BEAN'
,'select lob_data from document where id=4','my clip');

QUICKT_SET_LOAD_AND_PLAY

Play the clip as soon as it is loaded.

This way, you don't need to use the QUICKT_START_MOVIE() method, as the clip is started
immediately after loading by QUICKT_SET_MOVIE or QUICKT_SET_MOVIE_BASE.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_LOAD_AND_PLAY', 'true');
QUICKT_START_MOVIE

Start the loaded video.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_START_MOVIE', '');

QUICKT_STOP_MOVIE

Stop the loaded video.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_STOP_MOVIE', '');

QUICKT_GOTO

Go to the begin or the end of the video.

e.g.:

-- go to begin --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_GOTO', 'begin');
-- go to end –
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_GOTO', 'end');

QUICKT_INC_VOLUME

Increase the sound volume.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_INC_VOLUME', '');

QUICKT_DEC_VOLUME

Decrease the sound volume.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_DEC_VOLUME', '');

QUICKT_SET_FRAME_TITLE

Set the independent frame title.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_FRAME_TITLE', 'My movie clip');

QUICKT_SET_FRAME_MOVIE_SIZE

Set the independent frame size as same as the original video size.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_SET_FRAME_MOVIE_SIZE', 'true');

QUICKT_REMOVE_PANEL

Remove the panel to clean before exit.

Use this method in a POST-FORM trigger for instance.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'QUICKT_REMOVE_PANEL', '');
Miscellaneous

DISPLAY_MESSAGE

Display a message box similar to the Show_Alert() built-in.

Properties: XPos,YPos,Width,Height,Icon,Title,Message

If you do not want to provide any icon image, put - (minus) instead.
All other parameters are required.

If XPos and YPos < 0 then the dialog box is centered to the screen.
If XPos and YPos = 0 then the dialog box is centered to the Forms application.

Icon can be:

• question
• information
• warning
• error
• a valid image file name

The message itself is moved to the last argument, then can contains commas.

Set_Custom_Property('LAF_BLOCK.LAF_BEAN', 1,'DISPLAY_MESSAGE'
,'0,0,400,110,/target-32.gif,Title,Message');

GET_SCHEME_COLOR

Used to get the current scheme color in RGB format.

Color := Get_Custom_Property( ' LAF_BLOCK.LAF_BEAN ', 1, 'GET_SCHEME_COLOR' );

DRAW_FOCUS_LINES

Used to draw or hide the tiny lines when an item has the focus.

Set_Custom_Property( 'CTRL.BEAN', 1, 'DRAW_FOCUS_LINES', 'true|false');

e.g.:

-- hide the focus lines --

Set_Custom_Property( 'CTRL.BEAN', 1, 'DRAW_FOCUS_LINES', 'false');
GET_SCHEME_COLOR_LIGHT

Used to get the current scheme light color in RGB format.

Color := Get_Custom_Property( ' LAF_BLOCK.LAF_BEAN ', 1, 'GET_SCHEME_COLOR_LIGHT' );

SET_APPLY_SCHEME

Used to use the current scheme to colorize GUI elements.

Properties: element,true|false

element can be one of the following:

● light
● menu
● window
● status
● dialog
● frame

e. g.:

-- use the current scheme color to colorize the dynamic frames --

Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_APPLY_SCHEME', 'frame,true' ) ;

SEARCH_TEXT_ITEMS

Used to mark any Text Item whose Implementation Class property is

oracle.forms.fd.LAF_XP_TextField or oracle.forms.fd.LAF_XP_TextArea.

It is required to set this method if you want to use the messaging back property.
The goal is to attach to the PJC a VBean object that allows returning messages back to Forms.

-- search for every Text Items whose Implementation Class is

-- oracle.forms.fd.LAF_XP_TextField or oracle.forms.fd.LAF_XP_TextArea
--
Set_Custom_Property( 'CTRL.BEAN', 1, 'SEARCH_TEXT_ITEMS', '');

-- enable events on Text Items --

Set_Custom_Property( 'CTRL.BEAN', 1, 'ENABLE_EVENTS', 'true');
...

GET_INPUT_DIALOG

Used to get the dialog text.

Varchar2 := Get_Custom_Property('BL.BEAN', 1, 'GET_INPUT_DIALOG', '');

SHOW_ABOUT

Used to display the About box.

Set_Custom_Property('BL.BEAN', 1, 'SHOW_ABOUT', '');

GET_SCHEME

Returns the current scheme.

If the scheme is not one of the predefined schemes, the method returns 'Custom'

Declare
LC$Scheme Varchar2(50);
Begin
LC$Scheme := Get_Custom_Property( …, 'GET_SCHEME' ) ;
End;

GET_TEXT_HEIGHT

Returns the height in pixel corresponding to the given text (with SET_TEXT)

height := Get_Custom_Property( …, 'GET_TEXT_HEIGHT' ) ;

GET_TEXT_SIZE

Returns the couple width,height in pixel corresponding to the given text (with SET_TEXT).

values are separated by a comma.

size := Get_Custom_Property( …, 'GET_TEXT_SIZE' ) ;

size would have the following content : width,height (e.g. : 100,20)

GET_TEXT_WIDTH

Get the width in pixel corresponding to the given text (with SET_TEXT)

width := Get_Custom_Property( …, 'GET_TEXT_WIDTH' ) ;

SET_SCHEME

Set the current scheme.

Available values are:

● green
● yellow
● orange
● red
● blue
● purple
● gray
● silver
● XP

Set_Custom_Property( …, 'SET_SCHEME', 'purple' );

You can also give a valid RGB color to set your own choice.

Set_Custom_Property( …, 'SET_SCHEME', 'r200g250b203' );

SET_TEXT

Send a text to the bean to calculate its dimensions.

property value is: text,font_name[,weight,size]

default size is : 8
default weight is : plain

Available weights are:

● plain
● bold
● italic
● bolditalic

Set_Custom_Property( …, 'SET_TEXT', 'Hello,Arial,bold,12' );

The calculated dimensions can, then, be read with the GET_TEXT_xx methods.
SET_ALL_HYPER_LINK_COLORS

Used to put the every hyper link colors in a one shot.

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1,'SET_ALL_HYPER_LINK_COLORS'

,'r6g91b206,r184g9b83');

SET_CBOX_BG_COLOR

Change the Check Box Background color.

It takes a String that contains a RGB color.

The color will be applied to all the Check Boxes in the form.

e.g.:
Set_Custom_Property( 'BL.BEAN', 1, SET_CBOX_BG_COLOR, 'r255g255b255' ) ;

The CSS equivalent tag is : checkbox-background-color

It must be present in a section of type : gui

e.g.:
checkbox-background-color:r255g255b255

If you want to change the background to one particular Check box, use the same method on
the Check Box Item itself:

Set_Custom_Property( 'BL.CHECKBOX', 1, 'SET_CBOX_BG_COLOR', 'r255g255b0' ) ;

SET_SCHEME_COLORS

Define the LAF colors.

The color that can be defined are the following:

Color Set_Custom_Property() CSS GUI property keyword

keyword
Main color Color= scheme-current-color
Main color light color_light= scheme-current-color-light
Selected item color select= scheme-select-color
Focus item color focus= scheme-focus-color
Disable item color disable= scheme-disable-color
List selection color listselect= scheme-listselection-color

Values are separated by a comma.

 Set_Custom_Property( 'CTRL.BEAN', 1, 'SET_SCHEME_COLORS',
'color=r255g40b60,color_light=r200g100b50,focus=r255g255b0,disable=r40g40b40,listselect=r
0g0b255,select=r100g255b255' ) ;

CSS file (GUI section):

scheme-current-color:r255g40b60
scheme-current-color-light:r200g100b50
scheme-focus-color:r255g255b0
scheme-select-color:r100g255b255
scheme-disable-color:r60g60b60
scheme-listselection-color:r0g0b255

SET_QUICK_EXIT

Bypass the Java Bean clean-up actions at exit time.

This feature can be used in Forms dialogs that contains a lot of canvases/Java Beans.
Because when you exit the Form, there is some code to clean-up the Java Memory used by the
DrawLAF Java Bean, it could take several seconds to quit if you have more than 10
canvases/Java Beans. If you want to reduce the time to exit the form, set this property to
TRUE.
As this Java property is “STATIC” to the DrawLAF Java Bean, you need to set it only for the
first (or at least one) DrawLAF bean in the Form.

Allowed values are : 'true' or 'false'.

Set_Custom_Property( …, 'SET_QUICK_EXIT', 'true' );

SHOW_IN_RECT

Show/Hide the Forms standard item depending on the mouse pointer position.

This method is usually called by the PKG_TOOLS.Show_In_Rect() laf.pll procedure.

Procedure Show_In_Rect
(
PC$Item in varchar2 –- item to show/hide
,PC$Strip in varchar2 –- rectangle of the strip
,PC$Bean in varchar2 -- Forms Bean Area
);

The PC$Strip argument defines the rectangle used to show the item when the mouse pointer
enters this area, or to hide it when the mouse pointer quits this area.
The underlying DrawLAF method called is 'SHOW_IN_RECT':

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SHOW_IN_RECT','10-20-1-160-500-40');
The first two parameters are the Forms Item x,y coordinate (in pixel) used to establish the
correspondence between the Forms Item and the underlying Java widget. The four last
parameters are the rectangle coordinates.

OPEN_DIALOG

Display an Open/Save file dialog.

Argument is: open|save,title,default_directory,filter. If you do not want to define a default

directory, put a minus (-) instead.

-- Open file dialog --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'FILE_DIALOG'
, 'open,Select a file,c:\,*.txt;*.css');

-- Save file dialog --

Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'FILE_DIALOG'
, 'save,Select a file,c:\');

GET_FILE_NAME

Returns the file name selected by a previous OPEN_DIALOG Method.

-- Get selected file name --

sel_file := Get_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'GET_FILE_NAME');

SET_DESKTOP

open, print, browse or mail a local file.

option can be:

• open
• edit
• print
• mail
• browse

-- open a file --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_DESKTOP', 'open,c:/file.txt');
-- print a file --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_DESKTOP', 'print,c:/file.txt');
-- browse an URL --
Set_Custom_Property('LAF_BLOCK.LAF_BEAN',1,'SET_DESKTOP', 'browse,http://file.thml');

SET_DEFAULT_PRINTER
Set the default printer in order to print a document via the SET_DESKTOP(print)
method.

Windows only as it uses the Rundll32 Windows feature to set the default printer.

-- open the printer list dialog to select one --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_DEFAULT_PRINTER', '' ) ;

-- set default from given printer name (no dialog) --

Set_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'SET_DEFAULT_PRINTER', 'printer_name' ) ;

GET_DEFAULT_PRINTER

Returns the local machine default printer.

printer := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'GET_DEFAULT_PRINTER');

GET_PRINTER_LIST

Returns the local machine printer list.

printers := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'GET_PRINTER_LIST');

The returned value is a comma delimited string. to loop through the printers, use the laf.pll
PKG_LOOK_AND_FEEL.Split() function:

Declare
printers Varchar2(2000);
printer Varchar2(128);
i Pls_integer := 1 ;
Begin
printers := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'GET_PRINTER_LIST');
Loop
printer := PKG_LOOK_AND_FEEL.Split(printers,i);
exit when printer is null;
message(printer);
i := i + 1 ;
End loop;
End;

GET_USER_IP

Returns the local machine IP address (since 1.7.7)

ip := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'GET_USER_IP');

FORMS_SERVER_URL

Returns the Forms Server URL (since 1.7.7)

host := Get_Custom_Property( 'LAF_BLOCK.LAF_BEAN', 1, 'FORMS_SERVER_URL');

SET_LOG

Turn ON/OFF the logging messages.

By default the all logs are OFF.

Allowed values are : 'true' or 'false'.

Set_Custom_Property( …, 'SET_LOG', 'true' );

Oracle Forms Look & Feel project
Created and maintained by Francois Degrelle
Oracle Forms L&F Web site