Provides the tiles and other document information. More...

Inheritance diagram for org.libreoffice.TileProvider:

Public Member Functions
boolean	saveDocumentAs (String filePath, String format, boolean takeOwnership)
	Save the current document under the given path. More...

boolean	saveDocumentAs (String filePath, boolean takeOwnership)
	Saves the current document under the given path, using the default file format. More...

int	getPageWidth ()
	Returns the page width in pixels. More...

int	getPageHeight ()
	Returns the page height in pixels. More...

boolean	isReady ()

CairoImage	createTile (float x, float y, IntSize tileSize, float zoom)

void	rerenderTile (CairoImage image, float x, float y, IntSize tileSize, float zoom)
	Rerender and overwrite tile's image buffer directly. More...

void	changePart (int partIndex)
	Change the document part to the one specified by the partIndex input parameter. More...

int	getCurrentPartNumber ()
	Get the current document part number. More...

int	getPartsCount ()
	Get the total number of parts. More...

Bitmap	thumbnail (int size)

void	close ()
	Closes the document. More...

boolean	isDrawing ()
	Returns true if the current open document is a drawing. More...

boolean	isTextDocument ()
	Returns true if the current open document is a text document. More...

boolean	isSpreadsheet ()
	Returns true if the current open document is a spreadsheet. More...

boolean	isPresentation ()
	Returns true if the current open document is a presentation. More...

void	sendKeyEvent (KeyEvent keyEvent)
	Trigger a key event. More...

void	mouseButtonDown (PointF documentCoordinate, int numberOfClicks, float zoomFactor)
	Trigger a mouse button down event. More...

void	onSwipeLeft ()
	Trigger a swipe left event. More...

void	onSwipeRight ()
	Trigger a swipe left event. More...

void	mouseButtonUp (PointF documentCoordinate, int numberOfClicks, float zoomFactor)
	Trigger a mouse button up event. More...

void	postUnoCommand (String command, String arguments)
	Post a UNO command to LOK. More...

void	postUnoCommand (String command, String arguments, boolean notifyWhenFinished)
	This is the actual reference to the function in LOK, used for getting notified when uno:save event finishes. More...

void	setTextSelectionStart (PointF documentCoordinate)
	Send text selection start coordinate. More...

void	setTextSelectionEnd (PointF documentCoordinate)
	Send text selection end coordinate. More...

String	getTextSelection (String mimeType)
	get selected text More...

boolean	paste (String mimeType, String data)
	copy More...

void	setTextSelectionReset (PointF documentCoordinate)
	Send text selection reset coordinate. More...

void	setGraphicSelectionStart (PointF documentCoordinate)
	Send a request to change start the change of graphic selection. More...

void	setGraphicSelectionEnd (PointF documentCoordinate)
	Send a request to change end the change of graphic selection... More...

void	setDocumentSize (int pageWidth, int pageHeight)
	Set the new page size of the document when changed. More...

Detailed Description

Provides the tiles and other document information.

Definition at line 22 of file TileProvider.java.

Member Function Documentation

◆ changePart()

void org.libreoffice.TileProvider.changePart ( int partIndex )

Change the document part to the one specified by the partIndex input parameter.

Parameters

partIndex - part index to change to

◆ close()

void org.libreoffice.TileProvider.close ( )

Closes the document.

◆ createTile()

CairoImage org.libreoffice.TileProvider.createTile	(	float	x,
		float	y,
		IntSize	tileSize,
		float	zoom
	)

◆ getCurrentPartNumber()

int org.libreoffice.TileProvider.getCurrentPartNumber ( )

Get the current document part number.

Returns

◆ getPageHeight()

int org.libreoffice.TileProvider.getPageHeight ( )

Returns the page height in pixels.

◆ getPageWidth()

int org.libreoffice.TileProvider.getPageWidth ( )

Returns the page width in pixels.

◆ getPartsCount()

int org.libreoffice.TileProvider.getPartsCount ( )

Get the total number of parts.

◆ getTextSelection()

String org.libreoffice.TileProvider.getTextSelection ( String mimeType )

get selected text

Parameters

mimeType

References String.

◆ isDrawing()

boolean org.libreoffice.TileProvider.isDrawing ( )

Returns true if the current open document is a drawing.

◆ isPresentation()

boolean org.libreoffice.TileProvider.isPresentation ( )

Returns true if the current open document is a presentation.

◆ isReady()

boolean org.libreoffice.TileProvider.isReady ( )

◆ isSpreadsheet()

boolean org.libreoffice.TileProvider.isSpreadsheet ( )

Returns true if the current open document is a spreadsheet.

◆ isTextDocument()

boolean org.libreoffice.TileProvider.isTextDocument ( )

Returns true if the current open document is a text document.

◆ mouseButtonDown()

void org.libreoffice.TileProvider.mouseButtonDown	(	PointF	documentCoordinate,
		int	numberOfClicks,
		float	zoomFactor
	)

Trigger a mouse button down event.

Parameters

documentCoordinate	- coordinate relative to the document where the mouse button should be triggered
numberOfClicks	- number of clicks (1 - single click, 2 - double click)

◆ mouseButtonUp()

void org.libreoffice.TileProvider.mouseButtonUp	(	PointF	documentCoordinate,
		int	numberOfClicks,
		float	zoomFactor
	)

Trigger a mouse button up event.

Parameters

documentCoordinate	- coordinate relative to the document where the mouse button should be triggered
numberOfClicks	- number of clicks (1 - single click, 2 - double click)

◆ onSwipeLeft()

void org.libreoffice.TileProvider.onSwipeLeft ( )

Trigger a swipe left event.

◆ onSwipeRight()

void org.libreoffice.TileProvider.onSwipeRight ( )

Trigger a swipe left event.

◆ paste()

boolean org.libreoffice.TileProvider.paste	(	String	mimeType,
		String	data
	)

copy

Parameters

mimeType
data

Returns

◆ postUnoCommand() [1/2]

void org.libreoffice.TileProvider.postUnoCommand	(	String	command,
		String	arguments
	)

Post a UNO command to LOK.

Parameters

command - the .uno: command, like ".uno:Bold"

◆ postUnoCommand() [2/2]

void org.libreoffice.TileProvider.postUnoCommand	(	String	command,
		String	arguments,
		boolean	notifyWhenFinished
	)

This is the actual reference to the function in LOK, used for getting notified when uno:save event finishes.

Parameters

command
arguments
notifyWhenFinished

◆ rerenderTile()

void org.libreoffice.TileProvider.rerenderTile	(	CairoImage	image,
		float	x,
		float	y,
		IntSize	tileSize,
		float	zoom
	)

Rerender and overwrite tile's image buffer directly.

◆ saveDocumentAs() [1/2]

boolean org.libreoffice.TileProvider.saveDocumentAs	(	String	filePath,
		boolean	takeOwnership
	)

Saves the current document under the given path, using the default file format.

Parameters

takeOwnership (s. documentation for 'saveDocumentAs(String filePath, String format, boolean takeOwnership)')

◆ saveDocumentAs() [2/2]

boolean org.libreoffice.TileProvider.saveDocumentAs	(	String	filePath,
		String	format,
		boolean	takeOwnership
	)

Save the current document under the given path.

Parameters

takeOwnership Whether to take ownership of the new file, i.e. whether the current document is changed to the newly saved document (takeOwnership = true), as compared to just saving a copy of the current document or exporting to a different file format. Must be 'false' when using this method for export to e.g. PNG or PDF.

Returns: Whether saving was successful.

◆ sendKeyEvent()

void org.libreoffice.TileProvider.sendKeyEvent ( KeyEvent keyEvent )

Trigger a key event.

Parameters

keyEvent - contains information about key event

◆ setDocumentSize()

void org.libreoffice.TileProvider.setDocumentSize	(	int	pageWidth,
		int	pageHeight
	)

Set the new page size of the document when changed.

◆ setGraphicSelectionEnd()

void org.libreoffice.TileProvider.setGraphicSelectionEnd ( PointF documentCoordinate )

Send a request to change end the change of graphic selection...

◆ setGraphicSelectionStart()

void org.libreoffice.TileProvider.setGraphicSelectionStart ( PointF documentCoordinate )

Send a request to change start the change of graphic selection.

◆ setTextSelectionEnd()

void org.libreoffice.TileProvider.setTextSelectionEnd ( PointF documentCoordinate )

Send text selection end coordinate.

Parameters

documentCoordinate

◆ setTextSelectionReset()

void org.libreoffice.TileProvider.setTextSelectionReset ( PointF documentCoordinate )

Send text selection reset coordinate.

Parameters

documentCoordinate

◆ setTextSelectionStart()

void org.libreoffice.TileProvider.setTextSelectionStart ( PointF documentCoordinate )

Send text selection start coordinate.

Parameters

documentCoordinate

◆ thumbnail()

Bitmap org.libreoffice.TileProvider.thumbnail ( int size )

References Bitmap.

The documentation for this interface was generated from the following file:

TileProvider.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ changePart()

◆ close()

◆ createTile()

◆ getCurrentPartNumber()

◆ getPageHeight()

◆ getPageWidth()

◆ getPartsCount()

◆ getTextSelection()

◆ isDrawing()

◆ isPresentation()

◆ isReady()

◆ isSpreadsheet()

◆ isTextDocument()

◆ mouseButtonDown()

◆ mouseButtonUp()

◆ onSwipeLeft()

◆ onSwipeRight()

◆ paste()

◆ postUnoCommand() [1/2]

◆ postUnoCommand() [2/2]

◆ rerenderTile()

◆ saveDocumentAs() [1/2]

◆ saveDocumentAs() [2/2]

◆ sendKeyEvent()

◆ setDocumentSize()

◆ setGraphicSelectionEnd()

◆ setGraphicSelectionStart()

◆ setTextSelectionEnd()

◆ setTextSelectionReset()

◆ setTextSelectionStart()

◆ thumbnail()