com.jniwrapper.win32.jexcel
Class Range

java.lang.Object
  com.jniwrapper.win32.jexcel.BaseClass
      com.jniwrapper.win32.jexcel.RangePresentation
          com.jniwrapper.win32.jexcel.Range

public class Range

extends com.jniwrapper.win32.jexcel.RangePresentation

This class represents a range of cells in a Worksheet.

Nested Class Summary

static class	Range.FindLookIn This class is an enumeration of information types to be searched.
static class	Range.SearchAttributes This class is used for specification find attributes.

Field Summary

protected com.jniwrapper.win32.excel.Interior	_interior
protected static com.jniwrapper.util.Logger	_log
protected com.jniwrapper.win32.excel.Range	_pureRange
protected com.jniwrapper.win32.excel.Range	_range

Constructor Summary

Range(Cell cell)
Creates a range that contains a single cell.

Method Summary

java.util.Set	cells() Returns the set of range cells.
void	clear() Clears the content of the cell or range.
void	delete(int shift) Delete range from worksheet.
boolean	equals(java.lang.Object obj)
Cell	find(java.util.Date what, Range.SearchAttributes attributes) Returns the first cell that contains the data specified by what argument.
Cell	find(double what, Range.SearchAttributes attributes) Returns the first cell that contains the data specified by what argument.
Cell	find(long what, Range.SearchAttributes attributes) Returns the first cell that contains the data specified by what argument.
Cell	find(java.lang.String what, Range.SearchAttributes attributes) Returns the first cell that contains the data specified by what argument.
Cell	findNext() Returns the cell that contains the next occurence of the data.
java.lang.String	getAddress() Returns the absolute address of the cell or range.
Application	getApplication() Returns the parent application.
Border	getBorder(Border.Kind kind) Returns the border of interest.
int	getCellCount() Returns the number of cells in the range.
java.util.List	getCells() Returns the list of range cells in default CellsOrder.LEFT2RIGHT_TOP2BOTTOM order.
java.util.List	getCells(CellsOrder cellsOrder) Returns the list of cells, sorted in the specified order.
int	getColumnCount() Returns the number of columns in the range.
double	getColumnWidth() Returns the column width.
Font	getFont() Returns the text font.
TextAlignment	getHorizontalAlignment() Returns the horizontal text alignment kind.
java.awt.Color	getInteriorColor() Returns the interior color.
InteriorPattern	getInteriorPattern() Returns the interior pattern kind.
java.awt.Color	getInteriorPatternColor() Returns the interior pattern color.
Range	getIntersection(Range range) Returns the intersection of the current range and the specified one.
java.lang.String	getName() Returns the name of the range.
java.lang.String	getNumberFormat() Returns the string representation of the number format.
com.jniwrapper.win32.automation.OleMessageLoop	getOleMessageLoop() Returns the message loop thread for processing native peer function calls.
Worksheet	getParent() Returns the parent worksheet.
com.jniwrapper.win32.excel.Range	getPeer() Returns the appropriate native peer.
int	getRowCount() Returns the number of rows in the range.
double	getRowHeight() Returns the row height.
TextOrientation	getTextOrientation() Returns the text orientation kind.
TextAlignment	getVerticalAlignment() Returns the vertical text alignment kind.
Range	include(Range range) Enlarges the range by adding a new range specified by the range parameter.
Range	include(java.lang.String range) Enlarges the range by adding a new range specified by its string representation.
boolean	intersects(Range range) Returns true if the current range intersects the range specified by the range parameter.
void	merge() Merges all cells of the range, at that all data in cells will be lost.
void	print(int copies) Prints the specified number of copies of the range.
void	setBorder(Border.Kind kind, Border border) Sets up the specified kind of border.
void	setColumnWidth(double width) Sets up the column width.
void	setFont(Font font) Sets up the text font.
void	setHorizontalAlignment(TextAlignment textAlignment) Sets up the horizontal text alignment kind.
void	setInteriorColor(java.awt.Color color) Sets up the interior color.
void	setInteriorPattern(InteriorPattern pattern) Sets up the interior pattern kind.
void	setInteriorPatternColor(java.awt.Color color) Sets up the interior pattern color.
void	setName(java.lang.String rangeName) Sets up the range name, so that the range become named and could be accessed by the name.
void	setNumberFormat(java.lang.String numberFormat) Sets up the number format.
void	setRowHeight(double height) Sets up the row height.
void	setTextOrientation(TextOrientation textOrientation) Sets up the text orientation kind.
void	setValue2(com.jniwrapper.win32.automation.types.Variant value) Sets cell content in the range.
void	setVerticalAlignment(TextAlignment textAlignment) Sets up the vertical text alignment kind.
void	sort(int row, boolean ascending, boolean caseSensetive) Sorts columns of the range in accordance with data of the specified row.
void	sort(java.lang.String columnName, boolean ascending, boolean caseSensetive) Sorts rows of the range in accordance with data of the specified column identified by given name.
java.lang.String	toString()
void	unmerge() Unmerge cells of the range.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_log

protected static final com.jniwrapper.util.Logger _log

_range

protected com.jniwrapper.win32.excel.Range _range

_pureRange

protected com.jniwrapper.win32.excel.Range _pureRange

_interior

protected com.jniwrapper.win32.excel.Interior _interior

Constructor Detail

Range

public Range(Cell cell)

Creates a range that contains a single cell.

Parameters:

cell -

See Also:

Cell

Method Detail

include

public Range include(Range range)

Enlarges the range by adding a new range specified by the range parameter.

Parameters:

range - is the range to be included.

Returns:

the enlarged range.

include

public Range include(java.lang.String range)

Enlarges the range by adding a new range specified by its string representation.

Parameters:

range - is the string representation of the range to be included.

Returns:

the enlarged range.

getCellCount

public int getCellCount()

Returns the number of cells in the range.

Returns:

the number of cells in the range.

getColumnCount

public int getColumnCount()

Returns the number of columns in the range.

Returns:

the number of columns in the range.

getRowCount

public int getRowCount()

Returns the number of rows in the range.

Returns:

the number of rows in the range.

intersects

public boolean intersects(Range range)

Returns true if the current range intersects the range specified by the range parameter.

Parameters:

range - is the range to be checked for intersection.

Returns:

true if the current range intersects the range specified by the range parameter.

getIntersection

public Range getIntersection(Range range)

Returns the intersection of the current range and the specified one. If the ranges don't intersect the return value is null.

Parameters:

range -

Returns:

the intersection of the current range and the specified one. If the ranges don't intersect the return value is null.

merge

public void merge()

Merges all cells of the range, at that all data in cells will be lost.

unmerge

public void unmerge()

Unmerge cells of the range.

getCells

public java.util.List getCells()

Returns the list of range cells in default CellsOrder.LEFT2RIGHT_TOP2BOTTOM order.

Each element of the list is an instance of Cell class.

Returns:

the list of range cells.

See Also:

Cell

getCells

public java.util.List getCells(CellsOrder cellsOrder)

Returns the list of cells, sorted in the specified order.

Each element of the list is an instance of Cell class.

Parameters:

cellsOrder - specifies how to sort the cells in the list.

Returns:

sorted list of cells.

cells

public java.util.Set cells()

Returns the set of range cells. Each element of the set is an instance of Cell class.

Returns:

the set of range cells.

See Also:

Cell

print

public void print(int copies)
           throws javax.print.PrintException

Prints the specified number of copies of the range.

Parameters:

copies - is the number of copies to be printed.

Throws:

java.lang.IllegalArgumentException - if number of copies is negative.

javax.print.PrintException - if print problems occured.

See Also:

Application.setActivePrinter(String)

find

public Cell find(java.lang.String what,
                 Range.SearchAttributes attributes)

Returns the first cell that contains the data specified by what argument. If the range doesn't contain the specified string the return value is null. To find the next occurence of the data in the range use findNext() method.

Parameters:

what - specifies the string to be found.

attributes - specifies search attributes.

Returns:

the first cell that contains the data specified by what argument.

See Also:

Range.SearchAttributes, findNext()

find

public Cell find(java.util.Date what,
                 Range.SearchAttributes attributes)

Returns the first cell that contains the data specified by what argument. If the range doesn't contain the specified date the return value is null. To find the next occurence of the data in the range use findNext() method.

Parameters:

what - specifies the date to be found.

attributes - specifies search attributes.

Returns:

the first cell that contains the data specified by what argument.

See Also:

Range.SearchAttributes, findNext()

find

public Cell find(long what,
                 Range.SearchAttributes attributes)

Returns the first cell that contains the data specified by what argument. If the range doesn't contain the specified long value the return value is null. To find the next occurence of the data in the range use findNext() method.

Parameters:

what - specifies the long value to be found.

attributes - specifies search attributes.

Returns:

the first cell that contains the data specified by what argument.

See Also:

Range.SearchAttributes, findNext()

find

public Cell find(double what,
                 Range.SearchAttributes attributes)

Returns the first cell that contains the data specified by what argument. If the range doesn't contain the specified double value the return value is null. To find the next occurence of the data in the range use findNext() method.

Parameters:

what - specifies the double value to be found.

attributes - specifies search attributes.

Returns:

the first cell that contains the data specified by what argument.

See Also:

Range.SearchAttributes, findNext()

findNext

public Cell findNext()

Returns the cell that contains the next occurence of the data. This method uses find attributes which are specified in the previous call of find(java.lang.String, com.jniwrapper.win32.jexcel.Range.SearchAttributes) method.

Returns:

the cell that contains the next occurence of the data.

See Also:

find(java.lang.String, com.jniwrapper.win32.jexcel.Range.SearchAttributes)

sort

public void sort(java.lang.String columnName,
                 boolean ascending,
                 boolean caseSensetive)
          throws ExcelException

Sorts rows of the range in accordance with data of the specified column identified by given name.

Parameters:

columnName - sort rows in accordance to data of the column identified by given name.

ascending - if true the data will be sorted in ascending order, otherwise in descending order.

caseSensetive - if true the data will be case-sensetive sorted.

Throws:

ExcelException - if the cells cannot be sorted.

sort

public void sort(int row,
                 boolean ascending,
                 boolean caseSensetive)
          throws ExcelException

Sorts columns of the range in accordance with data of the specified row.

Parameters:

row - sort columns in accordance to data of this row.

ascending - if true the data will be sorted in ascending order, otherwise in descending order.

caseSensetive - if true the data will be case-sensetive sorted.

Throws:

ExcelException - if the cells cannot be thrown.

equals

public boolean equals(java.lang.Object obj)

getAddress

public java.lang.String getAddress()

Returns the absolute address of the cell or range.

Returns:

the absolute address of the cell or range.

getFont

public Font getFont()

Returns the text font.

Returns:

the text font.

setFont

public void setFont(Font font)

Sets up the text font.

Parameters:

font - is the font to be set up.

getBorder

public Border getBorder(Border.Kind kind)

Returns the border of interest.

Parameters:

kind - specifies which fragement of border to return.

Returns:

the border of interest.

Throws:

java.lang.IllegalArgumentException - if the kind argument is null.

setBorder

public void setBorder(Border.Kind kind,
                      Border border)

Sets up the specified kind of border.

Parameters:

kind - specifies the border kind.

border - is the border to be set up.

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

getVerticalAlignment

public TextAlignment getVerticalAlignment()

Returns the vertical text alignment kind. The return value may be one of the following values: TextAlignment.BOTTOM, TextAlignment.CENTER, TextAlignment.DISTRIBUTED, TextAlignment.TOP and TextAlignment.JUSTIFY.

Returns:

the vertical text alignment kind.

See Also:

TextAlignment

setVerticalAlignment

public void setVerticalAlignment(TextAlignment textAlignment)

Sets up the vertical text alignment kind. The method can take one of the following values: TextAlignment.BOTTOM, TextAlignment.CENTER, TextAlignment.DISTRIBUTED, TextAlignment.TOP and TextAlignment.JUSTIFY.

Parameters:

textAlignment - is the vertical text alignment kind to be set up.

Throws:

java.lang.IllegalArgumentException - if the target text alignment is null or cannot be applied.

See Also:

TextAlignment

getHorizontalAlignment

public TextAlignment getHorizontalAlignment()

Returns the horizontal text alignment kind. The return value may be one of the following values: TextAlignment.CENTER, TextAlignment.DISTRIBUTED, TextAlignment.FILL, TextAlignment.GENERAL, TextAlignment.JUSTIFY, TextAlignment.LEFT and TextAlignment.RIGHT.

Returns:

the horizontal text alignment kind.

See Also:

TextAlignment

setHorizontalAlignment

public void setHorizontalAlignment(TextAlignment textAlignment)

Sets up the horizontal text alignment kind. The method can take one of the following values: TextAlignment.CENTER, TextAlignment.DISTRIBUTED, TextAlignment.FILL, TextAlignment.GENERAL, TextAlignment.JUSTIFY, TextAlignment.LEFT and TextAlignment.RIGHT.

Parameters:

textAlignment - is the horizontal text alignment kind to be set up.

Throws:

java.lang.IllegalArgumentException - if the target text alignment is null or cannot be applied.

See Also:

TextAlignment

getTextOrientation

public TextOrientation getTextOrientation()

Returns the text orientation kind.

Returns:

the text orientation kind.

See Also:

TextOrientation

setTextOrientation

public void setTextOrientation(TextOrientation textOrientation)

Sets up the text orientation kind.

Parameters:

textOrientation - is the text orientation kind to be set up.

Throws:

java.lang.IllegalArgumentException - if the tanget text orientation is null

See Also:

TextOrientation

getParent

public Worksheet getParent()

Returns the parent worksheet.

Returns:

the parent worksheet.

See Also:

Worksheet

setName

public void setName(java.lang.String rangeName)

Sets up the range name, so that the range become named and could be accessed by the name.

Parameters:

rangeName - is the name to be set up.

Throws:

java.lang.IllegalArgumentException - if the target range name is null or cannot be set up.

delete

public void delete(int shift)

Delete range from worksheet.

Parameters:

shift - - XlDeleteShiftDirection constant which specifies shifting direction.

getName

public java.lang.String getName()

Returns the name of the range. If the name is not present the return value is null.

Returns:

the name of the range.

getColumnWidth

public double getColumnWidth()

Returns the column width.

Returns:

the column width.

setColumnWidth

public void setColumnWidth(double width)

Sets up the column width.

Parameters:

width - is the column width to be set up.

Throws:

java.lang.IllegalArgumentException - if the specifed width is negative or cannot be set up.

getRowHeight

public double getRowHeight()

Returns the row height.

Returns:

the row height.

setRowHeight

public void setRowHeight(double height)

Sets up the row height.

Parameters:

height - is the row height to be set up.

Throws:

java.lang.IllegalArgumentException - if the specified height is negative or cannot be set up.

setValue2

public void setValue2(com.jniwrapper.win32.automation.types.Variant value)

Sets cell content in the range. If provided value is a simple type, it is replicated across all cells. In array case, each cell gets corresponding value from the array. The method is named according to used Excel interface.

Parameters:

value - - simple value or SimpleArray wrapped into Variant

getNumberFormat

public java.lang.String getNumberFormat()

Returns the string representation of the number format.

Returns:

the string representation of the number format.

setNumberFormat

public void setNumberFormat(java.lang.String numberFormat)

Sets up the number format.

Parameters:

numberFormat - is the string representation of the number format to be set up.

Throws:

java.lang.IllegalArgumentException - if the specified number format cannot be set up.

clear

public void clear()

Clears the content of the cell or range.

setInteriorPattern

public void setInteriorPattern(InteriorPattern pattern)

Sets up the interior pattern kind.

Parameters:

pattern - is the interior pattern kind to be set up.

See Also:

InteriorPattern

getInteriorPattern

public InteriorPattern getInteriorPattern()

Returns the interior pattern kind.

Returns:

the interior pattern kind.

setInteriorColor

public void setInteriorColor(java.awt.Color color)

Sets up the interior color.

Parameters:

color - is the color to be set up.

getInteriorColor

public java.awt.Color getInteriorColor()

Returns the interior color.

Returns:

the interior color.

setInteriorPatternColor

public void setInteriorPatternColor(java.awt.Color color)

Sets up the interior pattern color.

Parameters:

color - is the color to be set up.

getInteriorPatternColor

public java.awt.Color getInteriorPatternColor()

Returns the interior pattern color.

Returns:

the interior pattern color.

toString

public java.lang.String toString()

getPeer

public com.jniwrapper.win32.excel.Range getPeer()

Returns the appropriate native peer.

Returns:

the appropriate native peer.

getOleMessageLoop

public com.jniwrapper.win32.automation.OleMessageLoop getOleMessageLoop()

Returns the message loop thread for processing native peer function calls.

Returns:

the message loop thread for processing native peer function calls.

getApplication

public Application getApplication()

Returns the parent application.

Returns:

the parent application.