given an array of values, legends, bubble sizes (optional) and a category range,
update (replace) the charts series with this data
NOTE: String arrays come in reverse order from plugins, so this method
adds series LIFO i.e.
shares this meme with a group
creates group if it does not exist
specifies access level:
NO_ACCESS_LEVEL =-1;
APPEND_LEVEL = 0;
READ_LEVEL = 1;
UPDATE_LEVEL = 2;
CREATE_LEVEL = 3;
DELETE_LEVEL = 4;
OWNER_LEVEL = 5;
------------------------------------------------------------
add a single email address to the system and perform default provisioning and setup
if user is not in system, create temp user for sharing purposes
if email IS in system then assign user to the share group
send email alerts and invites
example REST URL:
http://192.168.1.100:8080/workbook/id/null/txt/sharing/adduser/5007/read
?email=sales@acme.com
&password=newpass
------------------------------------------------------------
add a list of email addresses (users) to a share group
if user is not in system, create temp user for sharing purposes
if email IS in system then assign user to the share group
optionally send email alerts and invites
example REST URL:
http://192.168.1.100:8080/workbook/id/99/txt/sharing/addusers/5007/read
?emails=sales@acme.com,info@acme.com
&subject=new doc
&comments=you must check this out
------------------------------------------------------------
add a validation record
------------------------------------------------------------
http://127.0.0.1:8080/workbook/id/23/json/sheet/addvalidation/Sheet1!undefined/?valuetype=integer&condition=between&errorboxtext=12131&errorboxtitle=321&ignoreblank=1¶meter1=1¶meter2=3
Inserts a new worksheet and places it at the end of the workbook
The source bytes from the WorkSheet are from a serialized
WorkSheet created by the WorkSheetHandle getSerialBytes()
method.
Inserts a new worksheet and places it at the end of the workbook
The source bytes from the WorkSheet are from a serialized
WorkSheet created by the WorkSheetHandle getSerialBytes()
method.
Create a BeanBoundCell passing in the CellHandle that it represents,
the Object to which it is bound, and the field/index in the
Object containing its values.
Create a BeanBoundCell passing in the CellHandle that it represents,
the Object to which it is bound, and the field/index in the
Object containing its values.
Calculate the value of the formula and return it as an object
Calling calculate will ignore the WorkBook formula calculation flags
and forces calculation of the entire formula stack
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
Check acccess for different methods based on userid, memeid, and methodcalled
This method cannot be reached unless the user has at least read permissions
to the meme, so methods that only read can return true without checking.
converts a URL string description to the original meme-stored
description
TODO: howto handle changed description names? 404? show docs_list by date?
------------------------------------------------------------
Converts a string representation of a date into a valid calendar object
date must be in format mm/dd/yy (or yyyy)
------------------------------------------------------------
converts a meme string description to a URL
description
TODO: howto handle changed description names? 404? show docs_list by date?
------------------------------------------------------------
copy(Map) -
Static method in class com.extentech.ExtenXLS.plugin.builtin.PluginSheet
duplicate the sheet, return an array of all sheet tabs for updates
creates a macro from form data from a CellRange into a data sheet
TODO: Move to a Macro form handler
------------------------------------------------------------
Create a DataBoundCell passing in the CellHandle that it represents,
the DataObject to which it is bound, and the field/index in the
DataObject containing its values.
Create a DataBoundCell passing in the CellHandle that it represents,
the DataObject to which it is bound, and the field/index in the
DataObject containing its values.
DateConverter Provides helper methods to convert String and Java dates to Excel-compatible
numeric dates which are represented as number of days since Jan 01, 1900.
removes a list of email addresses (users) from a share group
optionally send email alerts and invites
------------------------------------------------------------
announce a message event to the workbook users
messages typically consist of a chat messages between concurrent
workbook users
------------------------------------------------------------
EVENT_TOKEN -
Static variable in interface com.extentech.ExtenXLS.plugin.Plugin
This constructor is used by the getGUIBuilderInstance method to
provide an instance of this class which has not had it's GUI elements
initialized (ie, initGUI is not called in this constructor).
A basic WorkBook User Interface
Provides basic formatting, execution of formulas, ability to add and edit Cells, and ability
to create new, edit existing, and save WorkBooks.
A basic WorkBook User Interface
Provides basic formatting, execution of formulas, ability to add and edit Cells, and ability
to create new, edit existing, and save WorkBooks.
This constructor is used by the getGUIBuilderInstance method to
provide an instance of this class which has not had it's GUI elements
initialized (ie, initGUI is not called in this constructor).
Takes an int array representing a row and column
and formats it as a cell address, taking into account
relative or absolute refs
The index is zero-based.
get a NamedRange from the workbook
NOTE!!! GET JSON FOR A NAMED RANGE WILL INCLUDE
ALL CELLS
------------------------------------------------------------
get(Map) -
Static method in class com.extentech.ExtenXLS.plugin.builtin.PluginRow
get a row from the workbook
------------------------------------------------------------
get(Map) -
Static method in class com.extentech.ExtenXLS.plugin.builtin.PluginSheet
Get an xml representation of a worksheet from the bound workbook
------------------------------------------------------------
returns Border Colors of Cell
ie: top, left, bottom, right
returns null or 1 color for each of 4 sides
1,1,1,1 represents a border all around the cell
1,1,0,0 represents on the top left edge of the cell
returns Border Colors of Cell
ie: top, left, bottom, right
returns null or 1 color for each of 4 sides
1,1,1,1 represents a border all around the cell
1,1,0,0 represents on the top left edge of the cell
return the image bounds
images bounds are as follows:
bounds[0]= column # of top left position (0-based) of the shape
bounds[1]= x offset within the top-left column (0-1023)
bounds[2]= row # for top left corner
bounds[3]= y offset within the top-left corner (0-1023)
bounds[4]= column # of the bottom right corner of the shape
bounds[5]= x offset within the cell for the bottom-right corner (0-1023)
bounds[6]= row # for bottom-right corner of the shape
bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
Returns a byte Array containing the
valid file containing this WorkBook
and associated Storages (such as VB files
and PivotTables.)
This is the actual file data and that can be
read from and written to FileOutputStreams and
ServletOutputStreams.
returns a Java Calendar object from a CellHandle
containing an Excel-Formatted Date
The Excel date format does not map 100% accurately to Java dates,
due to the limitation of the precision of the Excel floating-point
value record.
As many of these methods will be returning cell xml, this is just a utility from the handle
this should give us the ability to make modifications on output to xml as we go along without
changing a bunch of code
------------------------------------------------------------
look at cell data and retrieve current series and axis scale info in JSONObject form
used upon chart updating
This is an internal method that is not useful to the end user.
returns a Java Date from a Cellhandle
containing an Excel-formatted Date
The Excel date format does not map 100% accurately to Java dates,
due to the limitation of the precision of the Excel floating-point
value record.
returns a Java Date from either a Integer or Double cast as an Object
containing an Excel-formatted Date
The Excel date format does not map 100% accurately to Java dates,
due to the limitation of the precision of the Excel floating-point
value record.
returns edge status of Cell within Range
ie: top, left, bottom, right
returns 0 or 1 for 4 sides
1,1,1,1 is a single cell in a range
1,1,0,0 is on the top left edge of the range
Return a byte representing the error style for this ValidationHandle
These map to the static final ints ERROR_* in ValidationHandle
------------------------------------------------------------
get the Color of the Cell Foreground
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
get the Background Color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
convert a CellRange into an HTML/AJAX form
TODO:
- allow for XSLT processing/styles
- configurable forms with event processing/validation
- move code to helper class encapsulating functionality
------------------------------------------------------------
Returns the Formatting record id for this Cell
This can be used with 'setFormatId(int i)' to copy
the formatting from one Cell to another (ie:
a template cell to a new cell)
Get a row representing the header of the worksheet (ie A, B, C) with widths and styles applied to specific col
------------------------------------------------------------
get recordy byte def
as a String
public static String getRecordByteDef(XLSRecord rec){
byte[] b = rec.read();
StringBuffer sb = new StringBuffer("byte[] rbytes = {");
for(int t = 0;tgetManualGridLineColor() -
Method in class com.extentech.ExtenXLS.WorkSheetHandle
Get whether to use manual grid color in the output sheet.
get the messages for the workbook
messages typically consist of a chat messages between concurrent
workbook users, cellbinder updates,
------------------------------------------------------------
get a list of the workbook users
messages typically consist of a chat messages between concurrent
workbook users
------------------------------------------------------------
returns NON Localized Java Date from either a Integer or Double cast as an Object
containing an Excel-formatted Date
The Excel date format does not map 100% accurately to Java dates,
due to the limitation of the precision of the Excel floating-point
value record.
Extract any relevant request parameters and system settings
to be mapped into spreadsheet parameters
------------------------------------------------------------
convert twips to pixels
------------------------------------------------------------
In addition to a calculated size unit derived from the average size
of the default characters 0-9, Excel uses the 'twips' measurement
which is defined as:
1 twip = 1/20 point or 20 twips = 1 point
1 twip = 1/567 centimeter or 567 twips = 1 centimeter
1 twip = 1/1440 inch or 1440 twips = 1 inch
1 pixel = 0.75 points
1 pixel * 1.3333 = 1 point
1 twip * 20 = 1 point
Return the range of data this ValidationHandle refers to as a string
Will not contain worksheet identifier, as ValidationHandles are specific
to a worksheet.
Get the XML for a worksheet
Add the ability to return a maximum number of rows and cols
-1 returns all cols/rows
------------------------------------------------------------
convert pixels to twips
------------------------------------------------------------
In addition to a calculated size unit derived from the average size
of the default characters 0-9, Excel uses the 'twips' measurement
which is defined as:
1 pixel = 0.75 points
1 pixel * 1.3333 = 1 point
1 twip * 20 = 1 point
Get the validation type of this ValidationHandle as a byte
These bytes map to the VALUE_* static values in
ValidationHandle
------------------------------------------------------------
Inspects a string to determine if it is a date
Looks for a pattern such as mm/dd/yy, m/d/yy, mm/dd/yyyy etc
------------------------------------------------------------
return the list of FaceBook connections (Friends)
return type is determined by underlying service mode
------------------------------------------------------------
http://wiki.developers.facebook.com/index.php/Friends.get
return the list of Twitter connections (Friends)
return type is determined by underlying service mode
------------------------------------------------------------
Load the class, which is the neccessary implementation of the Classloader abstract
If the resolve argument is true, it must
also call resolveClass(), which will do things like verify the presence
of the superclass.
Load the data definition: loads RDF (report definition format) Records
from database and initializes the ReportFactory
------------------------------------------------------------
Load the data definition: loads RDF (report definition format) Records
from database and initializes the ReportFactory
------------------------------------------------------------
Command line parameters:
-x initialize Excel Template
-o name of output file or "stdout" for System.out
-xls
-xml output XML representation of file
-bindfile transform using XML Report Definition File (RDF)
example:
read in template.xls, output templateout.xml in XML format
-xtemplate.xls -otemplateout.xml -fxml
read in template.xls, output to stdout in XLS format
-xtemplate.xls -ostdout -fxls
Popups up a list of stored templates for the user (will prompt for a user name and password if none have already been defined)
and allows selection from the list
If selection is successful, will retrieve the XML bytes from the server and write the converted XLS to a temporary file (few!).
Allows choosing of an existing DOML Filename WITHOUT working directory limitations
Sets rdfname with fully qualified doml filename
or "" if error/cancel
Given an xml file and a series of cell ranges mapped to an xpath-type string, use XppPullParsing to traverse
thru xml, matching the xpath fieldbindings and inputting values to the mapped cell ranges
Convert the URL into RESTful Commands
------------------------------------------------------------
eg:
insert a new sheet named "New Sheet" at index 0
http://127.0.0.1:8080/workbook/id/1113/xml/sheet/add/New Sheet/0
eg:
insert a new cell at "New Sheet!A1" with the initial value of "Hello World!"
http://127.0.0.1:8080/workbook/id/1113/xls/cell/add/New Sheet!A1/Hello World!
eg:
insert a new cell at "New Sheet!A2" with the initial value of "=SUM(10+11)"
http://127.0.0.1:8080/workbook/id/1113/xls/cell/add/New Sheet!A2/=SUM(10+11)
PIE -
Static variable in class com.extentech.ExtenXLS.ChartHandle
PluginClass loader is a classloader implementation for ExtenXLS_SSE plugins
By moving the plugin directory out of the loaded CLASSPATH we enhance security
in how we trust the classes we are calling.
posts form data from a CellRange into a data sheet
TODO: Move to a NamedRange form handler
------------------------------------------------------------
Handle differences in number of nodes + attributes for the root element
only (must handle by hand since DetailedDiff appears to have problems in
root-level comparisons)
removes a list of email addresses (users) from a share group
optionally send email alerts and invites
------------------------------------------------------------
takes XML mapping file *based* on RDF Format
and workbook and create XML based on cellrange elements in RDF and values in book
reads in nodes
where parambinding string is in the form of:
leafnode|xx|xx:xx:Node-type[:subnode-type ...]]
Attempts to run a plugin, returns null if the plugin does not exist
checks user security based on plugin being run
------------------------------------------------------------
Attempts to run a plugin, returns null if the plugin does not exist
checks user security based on plugin being run
------------------------------------------------------------
send a chat message to the workbook users
messages typically consist of a chat messages between concurrent
workbook users
------------------------------------------------------------
The Service method feeds and invokes the ReportFactory with values from
the request, session, application, as well as
merges Request Parameters with the XLS template.
provides a pluggable service interface to allow integration of 3rd
party apis such as zimbra, FaceBook, and Twitter
------------------------------------------------------------
set the background color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
set the Background Color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
sets the image bounds
images bounds are as follows:
bounds[0]= column # of top left position (0-based) of the shape
bounds[1]= x offset within the top-left column (0-1023)
bounds[2]= row # for top left corner
bounds[3]= y offset within the top-left corner (0-1023)
bounds[4]= column # of the bottom right corner of the shape
bounds[5]= x offset within the cell for the bottom-right corner (0-1023)
bounds[6]= row # for bottom-right corner of the shape
bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
set the Cell Background Color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
makes the cell a solid pattern background if no pattern was already present
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
Set a column handle on this format handle, so all changes applied to this format will be applied to the entire column
------------------------------------------------------------
the definition is the tokenized string containing
the information needed to create the form fields
ie: "^contacts|10872|$('id,email:contacts:email:>')||
Set the error style for this ValidationHandle record
These map to the static final ints ERROR_* from ValidationHandle
------------------------------------------------------------
Excel File URL in actuality does not match documentation -
for most file urls, use .setURL above with a URL prefixed by file://
setFileURL is only used for links in the current file
setFileURL with additional optional information: description + textMark text
NOTE:
Excel File URL in actuality does not match documentation -
for most file urls, use .setURL above with a URL prefixed by file://
setFileURL is only used for links in the current file *
set the Color of the Cell Foreground pattern
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
set the Foreground Color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
set the foreground Color for this Format
NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
and Background color= the PATTERN color for all patterns != Solid
For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background Color=64 (white).
Sets the Formatting record id for this Cell
This can be used with 'getFormatId()' to copy
the formatting from one Cell to another (ie:
a template cell to a new cell)
sets the underlying image bytes to the bytes from a new image
essentially swapping the image bytes for another, while retaining
all other image properties (borders, etc.)
------------------------------------------------------------
set the marker format style for this chart
one of:
0 = no marker
1 = square
2 = diamond
3 = triangle
4 = X
5 = star
6 = Dow-Jones
7 = standard deviation
8 = circle
9 = plus sign
Set a row handle on this format handle, so all changes applied to this format will be applied to the entire row
------------------------------------------------------------
set sharing status of meme
valid values are:
PUBLIC
PRIVATE
SHARED
For PUBLIC access to function properly, the anonymous "Everyone" group
must be given READ permission to the resource.
set sharing status of meme
valid values are:
PUBLIC
PRIVATE
SHARED
For PUBLIC access to function properly, the anonymous "Everyone" group
must be given READ permission to the resource.
set the value of this cell to String s
NOTE: will not check for formula references or do any data conversions
Useful when strings may start with = but you do not want to convert
to a formula value
set the value of this cell to Unicodestring s
NOTE: will not check for formula references or do any data conversions
Useful when strings may start with = but you do not want to convert
to a formula value
Set the int Value of the Cell
setting a Boolean Cell type to a zero or a negative
number will set the Cell to 'false', setting
it to '1' or more will set it to true.
Set the validation type of this ValidationHandle as a byte
These bytes map to the VALUE_* static values in
ValidationHandle
------------------------------------------------------------
apply simple databinding to tokenized spreadsheet
posting data to this takes parameter which
------------------------------------------------------------
Need to figure out a unique identifier for these -- if there
is one in the BIFF8 information, that would be best
------------------------------------------------------------
This is a Data service adapter for the Twitter REST API
http://apiwiki.twitter.com/REST+API+Documentation
------------------------------------------------------------
ValidationHandle allows for manipulation of the validation cells in Excel
Using the ValidationHandle, the affected range of validations can be modified,
along with many of the error messages and actual validation upon the cells.
The WorkBookHandle provides a handle to the XLS file
and includes convenience methods for working with the WorkSheets
and Cell values within the XLS file.
for example:
WorkBookHandle book = new WorkBookHandle("testxls.xls");
WorkSheetHandle sheet1 = book.getWorkSheet("Sheet1");
CellHandle cell = sheet1.getCell("B22");
For usability reasons, ExtenXLS will convert the internal Excel 'Mulblank' record
type to the 'Blank' record type when parsing the file.
------------------------------------------------------------
WorkBookLoader.java
WorkBookLoader is an application-scoped object that handles loading,
unloading and delivery of Spreadsheet data in various formats.
Expose the WorkBook as RESTful Web Services
------------------------------------------------------------
At this time, the servlet does not strictly follow the REST architecture,
because it allows GET commands to modify resource state.
The WorkSheetHandle provides a handle to a Worksheet within an XLS file
and includes convenience methods for working with the Cell values within the sheet.
for example:
WorkBookHandle book = new WorkBookHandle("testxls.xls");
WorkSheetHandle sheet1 = book.getWorkSheet("Sheet1");
CellHandle cell = sheet1.getCell("B22");
Saves this WorkBookHandle to filename and path fname
if the filename ends with ".xlsx" or ".xlsm",
the template will be written in Excel 2007 (XLSX) Format.