org.simpleods

Class BorderStyle

java.lang.Object

org.simpleods.BorderStyle

public class BorderStyle
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file BorderStyle.java is part of SimpleODS.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BORDER_DOUBLE Flag to indicate a border style 'Double', used by setBorderStyle().
static int	BORDER_SOLID Flag to indicate a border style 'Solid', used by setBorderStyle().
static int	POSITION_ALL Flag to indicate that all borders should be shown, used by setPosition().
static int	POSITION_BOTTOM Flag to indicate that the bottom border should be shown, used by setPosition().
static int	POSITION_LEFT Flag to indicate that the left border should be shown, used by setPosition().
static int	POSITION_RIGHT Flag to indicate that the right border should be shown, used by setPosition().
static int	POSITION_TOP Flag to indicate that the top border should be shown, used by setPosition().

Constructor Summary

Constructors

Constructor and Description
BorderStyle(java.lang.String sSize, java.lang.String sColor, int nStyle, int nPos) sSize is a length value expressed as a number followed by a unit of measurement e.g. 0.1cm or 4px.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBorderColor() Get the currently set border color.
java.lang.String	getBorderSize() Gets the current value of border size.
int	getBorderStyle() Gets the current border Style.
int	getPosition() Returns the border positions as numerical value.
void	setBorderColor(java.lang.String borderColor) Set the border color to sColor.
void	setBorderSize(int borderSize) Set the border size in points to the given value.
void	setBorderSize(java.lang.String borderSize) Adds the border size, e.g. '0.1cm'. borderSize is a length value expressed as a number followed by a unit of measurement e.g. 0.1cm or 4px The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).
void	setBorderStyle(int borderStyle) Sets the border style.
void	setBorderStyleDouble() Sets the border size to double.
void	setBorderStyleSolid() Sets the border size to solid.
void	setPosition(int position) Sets the position of the border, e.g.
java.lang.String	toString()
void	unsetBorderStyle() Resets any previously set BorderStyle.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

POSITION_TOP

public static final int POSITION_TOP

Flag to indicate that the top border should be shown, used by setPosition().

See Also:

Constant Field Values

POSITION_BOTTOM

public static final int POSITION_BOTTOM

Flag to indicate that the bottom border should be shown, used by setPosition().

See Also:

Constant Field Values

POSITION_LEFT

public static final int POSITION_LEFT

Flag to indicate that the left border should be shown, used by setPosition().

See Also:

Constant Field Values

POSITION_RIGHT

public static final int POSITION_RIGHT

Flag to indicate that the right border should be shown, used by setPosition().

See Also:

Constant Field Values

POSITION_ALL

public static final int POSITION_ALL

Flag to indicate that all borders should be shown, used by setPosition().

See Also:

Constant Field Values

BORDER_SOLID

public static final int BORDER_SOLID

Flag to indicate a border style 'Solid', used by setBorderStyle().

See Also:

Constant Field Values

BORDER_DOUBLE

public static final int BORDER_DOUBLE

Flag to indicate a border style 'Double', used by setBorderStyle().

See Also:

Constant Field Values

Constructor Detail

BorderStyle

public BorderStyle(java.lang.String sSize,
           java.lang.String sColor,
           int nStyle,
           int nPos)

sSize is a length value expressed as a number followed by a unit of measurement e.g. 0.1cm or 4px.
The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
and pt (points; 72points equal one inch).

Parameters:

sSize - The size of the border

sColor - The color of the border in format '#rrggbb'

nStyle - The style of the border, BorderStyle.BORDER_SOLID or BorderStyle.BORDER_DOUBLE

nPos - The position to put the border on the cell, BorderStyle.POSITION_TOP,BorderStyle.POSITION_BOTTOM, BorderStyle.POSITION_LEFT,BorderStyle.POSITION_RIGHT or BorderStyle.POSITION_ALL

Method Detail

getBorderSize

public java.lang.String getBorderSize()

Gets the current value of border size.

Returns:

The size as string, e.g. '0.1cm'

setBorderSize

public final void setBorderSize(java.lang.String borderSize)

Adds the border size, e.g. '0.1cm'. borderSize is a length value
expressed as a number followed by a unit of measurement e.g. 0.1cm or 4px
The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).

Parameters:

borderSize - The border size as a unit of measurement

setBorderSize

public void setBorderSize(int borderSize)

Set the border size in points to the given value.

Parameters:

borderSize - - The border size as int , e.g. 2 or 3

getBorderColor

public java.lang.String getBorderColor()

Get the currently set border color.

Returns:

The color in format #rrggbb

setBorderColor

public final void setBorderColor(java.lang.String borderColor)

Set the border color to sColor.

Parameters:

borderColor - The color to be used in format #rrggbb e.g. #ff0000 for a red border.

getBorderStyle

public int getBorderStyle()

Gets the current border Style.

Returns:

BorderStyle.BORDER_SOLID or BorderStyle.BORDER_DOUBLE

setBorderStyle

public final void setBorderStyle(int borderStyle)

Sets the border style.

Parameters:

borderStyle - BorderStyle.BORDER_SOLID, BorderStyle.BORDER_DOUBLE

setBorderStyleSolid

public void setBorderStyleSolid()

Sets the border size to solid.

setBorderStyleDouble

public void setBorderStyleDouble()

Sets the border size to double.

unsetBorderStyle

public void unsetBorderStyle()

Resets any previously set BorderStyle.

getPosition

public int getPosition()

Returns the border positions as numerical value.

Returns:

The position as one of POSITION_TOP,POSITION_BOTTOM,POSITION_LEFT,POSITION_RIGHT or POSITION_ALL.

setPosition

public final void setPosition(int position)

Sets the position of the border, e.g. BorderStyle.POSITION_BOTTOM to set the border at the cell bottom.

Parameters:

position - The position as one of POSITION_TOP,POSITION_BOTTOM,POSITION_LEFT,POSITION_RIGHT or POSITION_ALL.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object