Drag[en]gine Script Module DragonScript Script API  1.0
BorderSize Class Reference
Inheritance diagram for BorderSize:

Public Member Functions

BorderSize enlarge (int left, int top, int right, int bottom)
 
BorderSize enlarge (BorderSize borderSize)
 
bool equals (Object other)
 
int getBottom ()
 
int getHeight ()
 
int getLeft ()
 
int getRight ()
 
Point getSize ()
 
int getTop ()
 
int getWidth ()
 
BorderSize new ()
 
BorderSize new (int size)
 Create border size object with identical size all around. More...
 
BorderSize new (int left, int top, int right, int bottom)
 
BorderSize new (BorderSize borderSize)
 
BorderSize operator+ (BorderSize borderSize)
 Border size enlarged by another border size object. More...
 
BorderSize operator- (BorderSize borderSize)
 Border size shrunk by another border size object. More...
 
BorderSize shrink (int left, int top, int right, int bottom)
 Border size shrunk by another border size object. More...
 
BorderSize shrink (BorderSize borderSize)
 Border size shrunk by another border size object. More...
 
String toString ()
 

Detailed Description

Immutable object storing the size of borders around a rectangular area.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ enlarge() [1/2]

BorderSize enlarge ( int  left,
int  top,
int  right,
int  bottom 
)

Returns the border size enlarged by another border size object.

§ enlarge() [2/2]

BorderSize enlarge ( BorderSize  borderSize)

Returns the border size enlarged by another border size object.

§ equals()

bool equals ( Object  other)

Test if two border size objects are equal.

§ getBottom()

int getBottom ( )

Retrieves the size in pixels of the bottom border.

§ getHeight()

int getHeight ( )

Retrieves the total height of the top and bottom border added together.

§ getLeft()

int getLeft ( )

Retrieves the size in pixels of the left border.

§ getRight()

int getRight ( )

Retrieves the size in pixels of the right border.

§ getSize()

Point getSize ( )

Retrieves the total size of the borders as a point object. The x coordinate is the sum of the left and right border. The y coordinate is the sum of the top and bottom borders.

§ getTop()

int getTop ( )

Retrieves the size in pixels of the top border.

§ getWidth()

int getWidth ( )

Retrieves the total width of the left and right border added together.

§ new() [1/4]

BorderSize new ( )

Creates a border size object with 0 pixel borders.

§ new() [2/4]

BorderSize new ( int  size)

Create border size object with identical size all around.

§ new() [3/4]

BorderSize new ( int  left,
int  top,
int  right,
int  bottom 
)

Creates a border size object with the given border sizes in pixels.

§ new() [4/4]

BorderSize new ( BorderSize  borderSize)

Creates a copy of a border size object.

§ operator+()

BorderSize operator+ ( BorderSize  borderSize)

Border size enlarged by another border size object.

§ operator-()

BorderSize operator- ( BorderSize  borderSize)

Border size shrunk by another border size object.

§ shrink() [1/2]

BorderSize shrink ( int  left,
int  top,
int  right,
int  bottom 
)

Border size shrunk by another border size object.

§ shrink() [2/2]

BorderSize shrink ( BorderSize  borderSize)

Border size shrunk by another border size object.

§ toString()

String toString ( )

String representation.


The documentation for this class was generated from the following file: