com.aspose.gridjs

Interface IGridJsService

All Known Implementing Classes:

GridJsService

public interface IGridJsService

Reprensents the basic operation apis interface used in controller actions.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addImage(java.lang.String p, java.lang.String uid, java.io.InputStream filestream) Applies the add image from local file operation.
java.lang.String	addImageByURL(java.lang.String p, java.lang.String uid, java.io.InputStream filestream, java.lang.String imageurl) Applies the add image from remote URL operation.
boolean	checkInCacheForCollaborative(java.lang.String uid) Check wether workbook instance is in memory cache .this method is apply for Collaborative mode only.
java.lang.String	copyImage(java.lang.String p, java.lang.String uid) Applies the copy image operation.
java.lang.StringBuilder	detailFileJsonWithUid(java.lang.String filePath, java.lang.String uid) Gets JSON string for the file by the specified unique id.
void	detailStreamJson(java.io.OutputStream stream, java.lang.String filePath) Write the JSON string for the Workbook to the stream
void	detailStreamJsonWithUid(java.io.OutputStream stream, java.lang.String filePath, java.lang.String uid) Write the JSON string for the file to the stream by the specified unique id.
java.lang.String	download(java.lang.String p, java.lang.String uid, java.lang.String filename) Applies the download file operation
java.io.InputStream	getFile(java.lang.String fileid) Get file stream
java.io.InputStream	image(java.lang.String uid, java.lang.String picid) Get Stream of image.
java.lang.String	imageUrl(java.lang.String baseURL, java.lang.String picid, java.lang.String uid) Gets the image URL.
java.lang.StringBuilder	lazyLoadingJson(java.lang.String sheetName, java.lang.String uid) Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.
void	lazyLoadingStreamJson(java.io.OutputStream stream, java.lang.String sheetName, java.lang.String uid) Writes the JSON string of the specified sheet in the file from the cache using the specified unique id to the stream..
java.lang.String	load(java.lang.String uid, java.lang.String filename) Gets the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON.
byte[]	ole(java.lang.String uid, java.lang.String sheetname, int oleid, java.lang.String label) Gets the byte array data of the embedded ole object .
java.lang.String	updateCell(java.lang.String p, java.lang.String uid) Applies the update operation.

Method Detail

updateCell

java.lang.String updateCell(java.lang.String p,
                          java.lang.String uid)

Applies the update operation.

Parameters:

p - The JSON format string of update operation.

uid - The unique id for the file cache.

checkInCacheForCollaborative

boolean checkInCacheForCollaborative(java.lang.String uid)

Check wether workbook instance is in memory cache .this method is apply for Collaborative mode only.

Parameters:

uid -

Returns:

detailFileJsonWithUid

java.lang.StringBuilder detailFileJsonWithUid(java.lang.String filePath,
                                            java.lang.String uid)

Gets JSON string for the file by the specified unique id. .

Parameters:

filePath - The file path

uid - The unique id for the file cache.

detailStreamJsonWithUid

void detailStreamJsonWithUid(java.io.OutputStream stream,
                           java.lang.String filePath,
                           java.lang.String uid)

Write the JSON string for the file to the stream by the specified unique id.

Parameters:

stream - The stream that will be written

filePath - The file path

uid - The unique id for the file cache.

detailStreamJson

void detailStreamJson(java.io.OutputStream stream,
                    java.lang.String filePath)

Write the JSON string for the Workbook to the stream

Parameters:

stream - The stream that will be written

filePath - The file path

lazyLoadingJson

java.lang.StringBuilder lazyLoadingJson(java.lang.String sheetName,
                                      java.lang.String uid)

Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.

Parameters:

sheetName - the sheet name.

uid - The unique id for the file cache.

lazyLoadingStreamJson

void lazyLoadingStreamJson(java.io.OutputStream stream,
                         java.lang.String sheetName,
                         java.lang.String uid)

Writes the JSON string of the specified sheet in the file from the cache using the specified unique id to the stream..

Parameters:

stream - The stream that will be written

sheetName - The sheet name.

uid - The unique id for the file cache.

addImage

java.lang.String addImage(java.lang.String p,
                        java.lang.String uid,
                        java.io.InputStream filestream)

Applies the add image from local file operation.

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

addImageByURL

java.lang.String addImageByURL(java.lang.String p,
                             java.lang.String uid,
                             java.io.InputStream filestream,
                             java.lang.String imageurl)

Applies the add image from remote URL operation.

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

copyImage

java.lang.String copyImage(java.lang.String p,
                         java.lang.String uid)

Applies the copy image operation.

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

Returns:

The JSON string result

load

java.lang.String load(java.lang.String uid,
                    java.lang.String filename)

Gets the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON.

Parameters:

uid - The unique id for the file cache.

filename - Specifies the file name in the JSON. If set to null,the default filename is: book1.

Returns:

The JSON string

image

java.io.InputStream image(java.lang.String uid,
                        java.lang.String picid)

Get Stream of image.

Parameters:

uid - The unique id for the file cache.

picid - The image id.

Returns:

The image stream

ole

byte[] ole(java.lang.String uid,
         java.lang.String sheetname,
         int oleid,
         java.lang.String label)

Gets the byte array data of the embedded ole object .

Parameters:

uid - The unique id for the file cache.

sheetname - The worksheet name.

oleid - The id for the embedded ole object.

label - The display label of the embedded ole object.

Returns:

The byte array data of the embedded ole object .

imageUrl

java.lang.String imageUrl(java.lang.String baseURL,
                        java.lang.String picid,
                        java.lang.String uid)

Gets the image URL.

Parameters:

baseURL - The base action URL.

picid - The image id.

uid - The unique id for the file cache.

Returns:

The image URL

getFile

java.io.InputStream getFile(java.lang.String fileid)

Get file stream

Parameters:

fileid - the file id

Returns:

The stream of the file

download

java.lang.String download(java.lang.String p,
                        java.lang.String uid,
                        java.lang.String filename)

Applies the download file operation

Parameters:

p - The JSON parameter

uid - The unique id for the file cache.

filename - The file name

Returns:

The file URL