XBorderFilter V0.96 for JAlbum Documentation - Frames and Brackets

Other chapters:

Frames

Frames are bands around the image under consideration. They may be of any color, transparency, and with or without rounded corners. There is a variety of parameters to control frames.

Frame Widths

The width of the frame to draw can be controlled by 5 parameters

Unique Frame Widths

This parameter denotes frame widths that are uniform in all 4 quarters. The value can be overwritten by the edgewise flavour of this parameter.

key	description	available values	examples	default value
frWidth	width of the frame bands to be created, in pixels; the first value indicates the width of the band nearest to the image edge	(list of) positive integers	frWidth=10 frWidth="15" frWidth="10,20"	0 (no frame)

Edge-wise Frame Widths

This parameter denotes frame widths that are valid for only one of the 4 quarters. The value overwrites frWidth (if given) for the denoted direction, all other directions are left untouched.

key	description	available values	examples	default value
frWidthN frWidthE frWidthS frWidthW	width of the frame bands to be created, in pixels; the first value indicates the width of the band nearest to the image edge	(list of) positive integers	frWidthE=10 frWidthN="15" frWidthS="10,20,30,40"	0 (no frame)

If more than one parameter frWidth* is given and the entered lists contain a different number of entries, the number of valid list entries is calculated as the smallest number of list entries observed in any of the parameters.

Example Images

class=XBorderFilter frWidth=20

class=XBorderFilter frWidth=20 frWidthN=5 frWidthS=40

Frame Colors

The color of the frame bands to draw can be controlled by the parameter frCol

key	description	available values	examples	default value
frCol	colors of the frame (bands) to be created	(list of) color names or #......-values	frCol=black frCol="white" frCol="black,white,black" frCol=#ff0000	white

If the number of colors is less than the number of bands, as given by frWidth*, the last given value of frCol is repeated as often as necessary.

Example Images

class=XBorderFilter frWidth=10,10,10 frCol=red,green,blue

Frame Transparencies

The transparency of the frame bands to draw can be controlled by the parameter frTrans

key	description	available values	examples	default value
boTrans	transparencies of the frame (bands) to be created, in %	(list of) positive integers	boTrans=20 boTrans="25" boTrans="100,100,0"	0% (totally opaque)

If the number of transparencies is less than the number of bands, as given by frWidth*, the last given value of frTrans is repeated as often as necessary.

Example Images

class=XBorderFilter frWidth=10,10,10 frTrans=70,0,30 bgCol=red

Frame Blending

The colors and transparencies of the frame bands can be blended. It is controlled by the parameter frBlend

key	description	available values	examples	default value
frBlend	flag, indicating the frame colors and transparencies are to be blended that means, that the colors and transparencies are blended between subsequent bands, using linear recombination	true, false	frBlend (sets frBlend to true) frBlend=false	false

If this flag is used, frCol and frTrans must contain one element more than frWidth* Otherwise, the last value of this lists is repeated.

Example Images

class=XBorderFilter frWidth=10,10 frCol=red,green,blue frTrans=30,50,70 frBlend

Brackets

Brackets are lines on top of frames. In order to use Brackets, you must have a frame. otherwise, no brackets are drawn.
Brackets are always drawn in the middle of the underlying frame.

Bracket Thickness

This parameter denotes the line thickness of the bracket to draw.

key	description	available values	examples	default value
brThick	thickness of the bracket to be created, in pixels	positive integer	brThick=1 brThick="5"	1

Example Images

class=XBorderFilter frWidth=20 brStyle=VERTICAL brThick=2

Bracket Color

The color of the bracket to draw can be controlled by the parameter brCol

key	description	available values	examples	default value
brCol	color of the bracket to be created	color names or #......-values	brCol=black brCol="white" brCol=#ff0000	black

Example Images

class=XBorderFilter frWidth=20 brStyle=HORIZONTAL brCol=red

Bracket Style

The style of the bracket to draw can be controlled by the parameter brStyle
This parameter must be given to switch on of off bracketing.
All other parameters switch bracketing off.

key	description	available values	examples	default value
brStyle	style of the bracket to be created	NONE NORMAL HORIZONTAL VERTICAL	brStyle=NORMAL	NONE (no bracket drawn)

Horizontal Bracket Length

This parameter denotes the horizontal line length of the bracket to draw.
If the value given is negative, the line length is proportional to the image width.

key	description	available values	examples	default value
brX	length of the horizontal bracket to be created, in pixels	integer	brX=50 brX=-1	0

brX has no effect on brStyle=HORIZONTAL

Vertical Bracket Length

This parameter denotes the vertical line length of the bracket to draw.
If the value given is negative, the line length is proportional to the image height.

key	description	available values	examples	default value
brY	length of the vertical bracket to be created, in pixels	integer	brY=50 brY=-1	0

brY has no effect on brStyle=VERTICAL

Example Images

class=XBorderFilter frWidth=20 brStyle=NORMAL brX=15 brY=10

Top