BBjFormFrame

Description

In BBj 4.0 and higher, the BBjFormFrame object allows users to construct a filled or unfilled rectangle on a page.

Creation

BBjAPI > BBjPrinter > BBjForm > BBjFormPage > BBjFormFrame

The BBjFormFrame object is created through the following BBjFormPage object method:

Return Value

Method

BBjFormFrame

newFrame()

BBjFormFrame

newFrame(double x, double y, double width, double height)

Methods of BBjFormFrame

Return Value

Method

BBjColor

getFillColor()

BBjColor

getLineColor()
int getMiter()
float getMiterLimit()

double

getThickness()

void

setFillColor(BBjColor color)

void

setLineColor(BBjColor color)
void setMiter(int miter)
void setMiterLimit(float limit)

void

setThickness(double thickness)

Methods of BBjFormFrame inherited from BBjFormElement

Return Value Method
void add(BBjFormElement object)
double getBottomMargin()
point getDrawingOrigin()
dimension getDrawingSize()
double getDrawingHeight()
double getDrawingWidth()
double getDrawingX()
double getDrawingY()
double getHeight()
int getHorizontalSticky()
double getLeftMargin()
BBjFormPage getPage()
BBjFormElement getParent()
point getPosition()
double getRightMargin()
dimension getSize()
double getTopMargin()
int getVerticalSticky()
double getWidth()
double getX()
double getY()
int isChild()
int isHorizontalFill()
int isVerticalFill()
void remove(BBjFormElement object)
void setBottomMargin(double margin)
void setHeight(double height)
void setHorizontalFill(int fill)
void setHorizontalSticky(int sticky)
void setLeftMargin(double margin)
void setPosition(double x, double y)
void setPosition(Point point)
void setRelative(int relative)
void setRightMargin(double margin)
void setSize(double width, double height)
void setSize(dimension size)
void setTopMargin(double margin)
void setVerticalFill(int fill)
void setVerticalSticky(int sticky)
void setWidth(double width)

Constants

Value Constant
0 JOIN_MITER
1 JOIN_ROUND
2 JOIN_BEVEL

Example

rem 'Get a new frame

rem 'Obtain the instance to the BBjAPI object
myAPI! = BBjAPI()

rem 'Obtain an instance of a default BBjPrinter object
let myBBjPrinter! = myAPI!.getBBjPrinter(0)

rem 'Get BBjForm for the selected printer
let myBBjForm! = myBBjPrinter!.getForm(1)

rem 'Get a new page
let myBBjFormPage! = myBBjForm!.createPage()

rem 'Get a new frame
let frame! = myBBjFormPage!.newFrame()
release

See Also

BBjAPI

BBj Object Variables

BBj Object Assignment

BBj Object Error Handling

BBj Object Operators

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.