publish
plugins.it2be_splash info


Servoy Properties Summary
String build
Date buildDate
String component
Number version


Servoy Methods Summary
void hide( )
void show( byte[], String, Number, Number, Number, Boolean, Number )
void show( ImageIcon, String, String, Number, Number, Number, Boolean, Number )
void show( String, String, String, Number, Number, Number, Boolean )
void show( String, String, Number, Number, Number, Boolean )
void show( String, String, Number, Number, Number, Boolean, Number )
void show( ImageIcon, String, String, Number, Number, Number, Boolean )
void show( String, String, String, Number, Number, Number, Boolean, Number )
void show( byte[], String, Number, Number, Number, Boolean )
void showImage( byte[], Number, Boolean )
void showImage( String, Number, Boolean )
void showImage( String, Number, Boolean, Number )
void showImage( byte[], Number, Boolean, Number )
void showText( String, Number, Boolean )
void showText( String, String, Number, Boolean, Number )
void showText( String, Number, Boolean, Number )
void showText( String, String, Number, Boolean )
void showURL( String, Number, Number, Number, Boolean )
void showURL( String, Number, Number, Number, Boolean, Number )
void showURL( String, Number, Boolean, Number )
void showURL( String, Number, Boolean )


Servoy Properties Details


build
String  build
Returns the current version (major, minor, build)
Returns
String  build String

Supported Clients
SmartClient


buildDate
Date  buildDate
Returns date release date
Returns
Date  date Date

Supported Clients
SmartClient


component
String  component
Returns the component name
Returns
String  name String

Supported Clients
SmartClient


version
Number  version
Returns the current version (major, minor)
Returns
Number  version Double

Supported Clients
SmartClient

Servoy Methods Details


hide
void  hide( )
Hide the current splash screen.
Returns
void  

Supported Clients
SmartClient

Sample
// Hide the current splash screen.
// note: a string can be formatted with html like 'formatted string'
// in this example it is wise to use the try-catch-finally statement to make sure
// that the hide() function is always reached and the splash doesn't stay on top
try {
plugins.it2be_splash.showText('this is my splash
let's see what happens.', 60, false, 4);
for ( var i = 1 ; i < 10000 ; i++) {
application.output(i);
application.sleep(1);
}
} catch (e) {
//this will be output after an error occured
application.output(e.name + ': ' + e.message);
} finally {
//this code will always run, also after an error
plugins.it2be_splash.hide();


show
void  show( byte[], String, Number, Number, Number, Boolean, Number )
Show a splash screen with an Image and text.
Parameters
byte[]  image  the image
String  text  the text
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( ImageIcon, String, String, Number, Number, Number, Boolean, Number )
Show a splash screen with an Image and text.
Parameters
ImageIcon  image  the image
String  text  the text
String  bgColor  the bg color
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( String, String, String, Number, Number, Number, Boolean )
Show a splash screen with an Image and text.
Parameters
String  path  the path
String  text  the text
String  bgColor  the bg color
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( String, String, Number, Number, Number, Boolean )
Show a splash screen with an Image and text.
Parameters
String  path  the path
String  text  the text
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( String, String, Number, Number, Number, Boolean, Number )
Show a splash screen with an Image and text.
Parameters
String  path  the path
String  text  the text
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( ImageIcon, String, String, Number, Number, Number, Boolean )
Show a splash screen with an Image and text.
Parameters
ImageIcon  image
String  text
String  bgColor
Number  x
Number  y
Number  waitSeconds
Boolean  allowClick

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( String, String, String, Number, Number, Number, Boolean, Number )
Show a splash screen with an Image and text.
Parameters
String  path  the path
String  text  the text
String  bgColor  the bg color
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


show
void  show( byte[], String, Number, Number, Number, Boolean )
Show a splash screen with an Image and text.
Parameters
byte[]  image  the image
String  text  the text
Number  x  the x
Number  y  the y
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an Image and text.
// add the image path, the text with an (optional) background and the position
// of the text relative to the position of the image
// (horizontal and vertical 0 = left/top, 1 = center/center, 2 = right/bottom)
// add the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false)
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

var p = plugins.file.showFileOpenDialog(1);
plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', 1, 0, 5, true);

// and set the background color
// plugins.it2be_splash.show(p.getAbsolutePath(), 'this is my splash', '#ffffff', 1, 0, 5, true);

// or use an image from your media database
plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', 1, 0, 5, true, 0);

// and set the background color
// plugins.it2be_splash.show('media:///yourimage.gif', 'this is my splash', '#ffffff', 1, 0, 5, true, 1);


showImage
void  showImage( byte[], Number, Boolean )
Show a splash screen with an Image only.
Parameters
byte[]  image  the image
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an image only.
// add the image path, number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.
var p = plugins.file.showFileOpenDialog(1)
plugins.it2be_splash.showImage(p.getAbsolutePath(), 5, true, 2);

// or use an image from your media database
// plugins.it2be_splash.showImage('media:///yourimage.gif', 5, true, 3);


showImage
void  showImage( String, Number, Boolean )
Show a splash screen with an Image only.
Parameters
String  path  the path
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an image only.
// add the image path, number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.
var p = plugins.file.showFileOpenDialog(1)
plugins.it2be_splash.showImage(p.getAbsolutePath(), 5, true, 2);

// or use an image from your media database
// plugins.it2be_splash.showImage('media:///yourimage.gif', 5, true, 3);


showImage
void  showImage( String, Number, Boolean, Number )
Show a splash screen with an Image only.
Parameters
String  path  the path
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an image only.
// add the image path, number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.
var p = plugins.file.showFileOpenDialog(1)
plugins.it2be_splash.showImage(p.getAbsolutePath(), 5, true, 2);

// or use an image from your media database
// plugins.it2be_splash.showImage('media:///yourimage.gif', 5, true, 3);


showImage
void  showImage( byte[], Number, Boolean, Number )
Show a splash screen with an Image only.
Parameters
byte[]  image  the image
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with an image only.
// add the image path, number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.
var p = plugins.file.showFileOpenDialog(1)
plugins.it2be_splash.showImage(p.getAbsolutePath(), 5, true, 2);

// or use an image from your media database
// plugins.it2be_splash.showImage('media:///yourimage.gif', 5, true, 3);


showText
void  showText( String, Number, Boolean )
Show a splash screen with text only.
Parameters
String  text  the text
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with text only.
// add the text and the (optional) background, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

plugins.it2be_splash.showText('this is my splash', 5, true, 4);

// and set the background color
// plugins.it2be_splash.showText('

this is my splash', '#009999', 5, true, 5);



showText
void  showText( String, String, Number, Boolean, Number )
Show a splash screen with text only.
Parameters
String  text  the text
String  bgColor  the bg color
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with text only.
// add the text and the (optional) background, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

plugins.it2be_splash.showText('this is my splash', 5, true, 4);

// and set the background color
// plugins.it2be_splash.showText('

this is my splash', '#009999', 5, true, 5);



showText
void  showText( String, Number, Boolean, Number )
Show a splash screen with text only.
Parameters
String  text  the text
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with text only.
// add the text and the (optional) background, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

plugins.it2be_splash.showText('this is my splash', 5, true, 4);

// and set the background color
// plugins.it2be_splash.showText('

this is my splash', '#009999', 5, true, 5);



showText
void  showText( String, String, Number, Boolean )
Show a splash screen with text only.
Parameters
String  text  the text
String  bgColor  the bg color
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen with text only.
// add the text and the (optional) background, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// note: a string can be formatted with html like 'formatted string'

plugins.it2be_splash.showText('this is my splash', 5, true, 4);

// and set the background color
// plugins.it2be_splash.showText('

this is my splash', '#009999', 5, true, 5);



showURL
void  showURL( String, Number, Number, Number, Boolean )
Show a splash screen from an URL.
Parameters
String  url  the url
Number  width  the width
Number  height  the height
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen from an URL.
// add the URL, optional width and height, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// REMARK: the URL needs to be intered completely like 'http:// yoururl'

// IMPORTANT: the splash uses the java implementation of html and is limited to only a subset
// because of that JavaScript is not supported.
// When you really need to show websites/pages you could consider our BROWSER BEAN

plugins.it2be_splash.showURL('http:// www.servoy.com/', 15, true, 4);

// or set a fixed size
// or plugins.it2be_splash.showURL('http:// www.servoy.com/', 640, 480, 10, true, 4);


showURL
void  showURL( String, Number, Number, Number, Boolean, Number )
Show a splash screen from an URL.
Parameters
String  url  the url
Number  width  the width
Number  height  the height
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen from an URL.
// add the URL, optional width and height, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// REMARK: the URL needs to be intered completely like 'http:// yoururl'

// IMPORTANT: the splash uses the java implementation of html and is limited to only a subset
// because of that JavaScript is not supported.
// When you really need to show websites/pages you could consider our BROWSER BEAN

plugins.it2be_splash.showURL('http:// www.servoy.com/', 15, true, 4);

// or set a fixed size
// or plugins.it2be_splash.showURL('http:// www.servoy.com/', 640, 480, 10, true, 4);


showURL
void  showURL( String, Number, Boolean, Number )
Show a splash screen from an URL.
Parameters
String  url  the url
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click
Number  border  the border

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen from an URL.
// add the URL, optional width and height, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// REMARK: the URL needs to be intered completely like 'http:// yoururl'

// IMPORTANT: the splash uses the java implementation of html and is limited to only a subset
// because of that JavaScript is not supported.
// When you really need to show websites/pages you could consider our BROWSER BEAN

plugins.it2be_splash.showURL('http:// www.servoy.com/', 15, true, 4);

// or set a fixed size
// or plugins.it2be_splash.showURL('http:// www.servoy.com/', 640, 480, 10, true, 4);


showURL
void  showURL( String, Number, Boolean )
Show a splash screen from an URL.
Parameters
String  url  the url
Number  waitSeconds  the wait seconds
Boolean  allowClick  the allow click

Returns
void  

Supported Clients
SmartClient

Sample
// Show a splash screen from an URL.
// add the URL, optional width and height, the number of waitSeconds to show the splash,
// the user option to click the screen away (boolean true or false),
// and a border value 0=no, 1=line, 2=bevel, 3=etched, 4=lowered bevel, 5=raised bevel.

// REMARK: the URL needs to be intered completely like 'http:// yoururl'

// IMPORTANT: the splash uses the java implementation of html and is limited to only a subset
// because of that JavaScript is not supported.
// When you really need to show websites/pages you could consider our BROWSER BEAN

plugins.it2be_splash.showURL('http:// www.servoy.com/', 15, true, 4);

// or set a fixed size
// or plugins.it2be_splash.showURL('http:// www.servoy.com/', 640, 480, 10, true, 4);