Border (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- vib.segment.Border

All Implemented Interfaces:

Cloneable
```
public class Border
extends Object
implements Cloneable
```
Border - draws a configurable border

Author:

DTAI, Incorporated

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMBOSSED_OUT`
`static int`	`ETCHED_IN`
`static int`	`LINE`
`static int`	`NONE`
`static int`	`ROUND_RECT`
`static int`	`THREED_IN`
`static int`	`THREED_OUT`

Constructor Summary

Constructors
Constructor and Description

Border()

Constructors
Constructor and Description
`Border()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Color`	`brighter(Color color)` Returns a brighter version of this color.
`Object`	`clone()` Returns a clone of this Border
`static Color`	`darker(Color color)` Returns a darker version of this color.
`Color`	`getBorder()` Returns the current border color.
`int`	`getBorderThickness()` Returns the current setting for the border thickness
`int`	`getBottomMargin()` Returns the bottom margin.
`Insets`	`getInsets()` returns the left, right, top, and bottom insets of the background of the current style, taking into account thickness and margins.
`int`	`getLeftMargin()` Returns the left margin.
`int`	`getRightMargin()` Returns the right margin.
`int`	`getTopMargin()` Returns the top margin.
`int`	`getType()` Returns the border type (e.g., Border.LINE)
`void`	`paint(Graphics g, Color background, int x, int y, int width, int height)` returns the left, right, top, and bottom insets of the background of the current style, taking into account thickness and margins.
`void`	`setBorder(Color border)` Sets the current border color.
`void`	`setBorderThickness(int borderThickness)` Sets the border thickness
`void`	`setBottomMargin(int margin)` Sets the bottom margin
`void`	`setLeftMargin(int margin)` Sets the left margin
`void`	`setMargins(int margin)` Sets all margins (top, left, bottom, and right) to the same, given value.
`void`	`setMargins(int top, int left, int bottom, int right)` Sets all margins (top, left, bottom, and right) to the given values.
`void`	`setNoInsets()` sets all margins and thicknesses to zero
`void`	`setRightMargin(int margin)` Sets the right margin
`void`	`setTopMargin(int margin)` Sets the top margin
`void`	`setType(int type)` Sets the border type (e.g., to Border.LINE)

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    See Also:
    
    Constant Field Values
  - LINE
```
public static final int LINE
```
    See Also:
    
    Constant Field Values
  - THREED_IN
```
public static final int THREED_IN
```
    See Also:
    
    Constant Field Values
  - THREED_OUT
```
public static final int THREED_OUT
```
    See Also:
    
    Constant Field Values
  - ETCHED_IN
```
public static final int ETCHED_IN
```
    See Also:
    
    Constant Field Values
  - EMBOSSED_OUT
```
public static final int EMBOSSED_OUT
```
    See Also:
    
    Constant Field Values
  - ROUND_RECT
```
public static final int ROUND_RECT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Border
```
public Border()
```
- Method Detail
  - brighter
```
public static Color brighter(Color color)
```
    Returns a brighter version of this color. Replaces the "awt.Color" function brighter to use, in my opinion, a better factor (awt used FACTOR = 0.7)
    
    Parameters:
    
    color - the color to which to apply the factor
    
    Returns:
    
    the new, brighter color
  - darker
```
public static Color darker(Color color)
```
    Returns a darker version of this color. Replaces the "awt.Color" function brighter to use, in my opinion, a better factor (awt used FACTOR = 0.7)
    
    Parameters:
    
    color - the color to which to apply the factor
    
    Returns:
    
    the new, darker color
  - clone
```
public Object clone()
```
    Returns a clone of this Border
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the new, identical Border
  - setNoInsets
```
public void setNoInsets()
```
    sets all margins and thicknesses to zero
  - getType
```
public int getType()
```
    Returns the border type (e.g., Border.LINE)
    
    Returns:
    
    the border type id
  - setType
```
public void setType(int type)
```
    Sets the border type (e.g., to Border.LINE)
    
    Parameters:
    
    type - the border type
  - getBorder
```
public Color getBorder()
```
    Returns the current border color. If null (the default), a border color is dynamically derived from the current background (passed to the "paint" function).
    
    Returns:
    
    the current Color value for the border
  - setBorder
```
public void setBorder(Color border)
```
    Sets the current border color. If null (the default), a border color is dynamically derived from the current background (passed to the "paint" function).
    
    Parameters:
    
    border - the new border color
  - getTopMargin
```
public int getTopMargin()
```
    Returns the top margin.
    
    Returns:
    
    the top margin
  - getLeftMargin
```
public int getLeftMargin()
```
    Returns the left margin.
    
    Returns:
    
    the left margin
  - getBottomMargin
```
public int getBottomMargin()
```
    Returns the bottom margin.
    
    Returns:
    
    the bottom margin
  - getRightMargin
```
public int getRightMargin()
```
    Returns the right margin.
    
    Returns:
    
    the right margin
  - setMargins
```
public void setMargins(int margin)
```
    Sets all margins (top, left, bottom, and right) to the same, given value.
    
    Parameters:
    
    margin - the margin
  - setMargins
```
public void setMargins(int top,
                       int left,
                       int bottom,
                       int right)
```
    Sets all margins (top, left, bottom, and right) to the given values.
    
    Parameters:
    
    top - the top margin
    
    left - the left margin
    
    bottom - the bottom margin
    
    right - the right margin
  - setTopMargin
```
public void setTopMargin(int margin)
```
    Sets the top margin
    
    Parameters:
    
    margin - the top margin
  - setLeftMargin
```
public void setLeftMargin(int margin)
```
    Sets the left margin
    
    Parameters:
    
    margin - the left margin
  - setBottomMargin
```
public void setBottomMargin(int margin)
```
    Sets the bottom margin
    
    Parameters:
    
    margin - the bottom margin
  - setRightMargin
```
public void setRightMargin(int margin)
```
    Sets the right margin
    
    Parameters:
    
    margin - the right margin
  - getBorderThickness
```
public int getBorderThickness()
```
    Returns the current setting for the border thickness
    
    Returns:
    
    the border thickness
  - setBorderThickness
```
public void setBorderThickness(int borderThickness)
```
    Sets the border thickness
    
    Parameters:
    
    borderThickness - the border thickness
  - getInsets
```
public Insets getInsets()
```
    returns the left, right, top, and bottom insets of the background of the current style, taking into account thickness and margins.
    
    Returns:
    
    an Insets object containing the inset values
  - paint
```
public void paint(Graphics g,
                  Color background,
                  int x,
                  int y,
                  int width,
                  int height)
```
    returns the left, right, top, and bottom insets of the background of the current style, taking into account thickness and margins.
    
    Parameters:
    
    g - the Graphics in which to paint
    
    background - the current background color (or null), used if available to calculate the border color if that is null.
    
    x - the x location of the upper-left point of the border
    
    y - the y location of the upper-left point of the border
    
    width - the width of the rectangle in which to draw the border
    
    height - the height of the rectangle in which to draw the border

Class Border

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

LINE

THREED_IN

THREED_OUT

ETCHED_IN

EMBOSSED_OUT

ROUND_RECT

Constructor Detail

Border

Method Detail

brighter

darker

clone

setNoInsets

getType

setType

getBorder

setBorder

getTopMargin

getLeftMargin

getBottomMargin

getRightMargin

setMargins

setMargins

setTopMargin

setLeftMargin

setBottomMargin

setRightMargin

getBorderThickness

setBorderThickness

getInsets

paint