The DocumentOverlay is an overlay over the document. More...

Collaboration diagram for org.libreoffice.overlay.DocumentOverlay:

Classes
class	DocumentOverlayLayer
	DocumentOverlayLayer responsibility is to get the changes to the viewport and report them to DocumentOverlayView. More...

Public Member Functions
	DocumentOverlay (LibreOfficeMainActivity context, LayerView layerView)

void	setPartPageRectangles (List< RectF > rectangles)

void	showCursor ()
	Show the cursor at the defined cursor position on the overlay. More...

void	hideCursor ()
	Hide the cursor at the defined cursor position on the overlay. More...

void	showPageNumberRect ()
	Show the page number rectangle on the overlay. More...

void	hidePageNumberRect ()
	Hide the page number rectangle on the overlay. More...

void	positionCursor (final RectF position)
	Position the cursor to the input position on the overlay. More...

void	showSelections ()
	Show selections on the overlay. More...

void	hideSelections ()
	Hide selections on the overlay. More...

void	changeSelections (final List< RectF > selections)
	Change the list of selections. More...

void	showGraphicSelection ()
	Show the graphic selection on the overlay. More...

void	hideGraphicSelection ()
	Hide the graphic selection. More...

void	changeGraphicSelection (final RectF rectangle)
	Change the graphic selection rectangle to the input rectangle. More...

void	showHandle (final SelectionHandle.HandleType type)
	Show the handle (of input type) on the overlay. More...

void	hideHandle (final SelectionHandle.HandleType type)
	Hide the handle (of input type). More...

void	positionHandle (final SelectionHandle.HandleType type, final RectF rectangle)
	Position the handle (of input type) position to the input rectangle. More...

RectF	getCurrentCursorPosition ()

void	setCalcHeadersController (CalcHeadersController calcHeadersController)

void	showCellSelection (final RectF cellCursorRect)

void	showHeaderSelection (final RectF cellCursorRect)

void	showAdjustLengthLine (final boolean isRow, final CalcHeadersView view)

Private Attributes
final DocumentOverlayView	mDocumentOverlayView

final DocumentOverlayLayer	mDocumentOverlayLayer

final long	hidePageNumberRectDelayInMilliseconds = 500

Static Private Attributes
static final String	LOGTAG = DocumentOverlay.class.getSimpleName()

Detailed Description

The DocumentOverlay is an overlay over the document.

This class is responsible to setup the document overlay view, report visibility and position of its elements when they change and report any changes to the viewport.

Definition at line 29 of file DocumentOverlay.java.

Constructor & Destructor Documentation

◆ DocumentOverlay()

org.libreoffice.overlay.DocumentOverlay.DocumentOverlay	(	LibreOfficeMainActivity	context,
		LayerView	layerView
	)

inline

Definition at line 69 of file DocumentOverlay.java.

References org.mozilla.gecko.gfx.LayerView.addLayer(), org.libreoffice.overlay.DocumentOverlayView.initialize(), Log, org.libreoffice.overlay.DocumentOverlay.LOGTAG, org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayLayer, org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and R.

Member Function Documentation

◆ changeGraphicSelection()

void org.libreoffice.overlay.DocumentOverlay.changeGraphicSelection ( final RectF rectangle )

inline

Change the graphic selection rectangle to the input rectangle.

Definition at line 196 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlayView.changeGraphicSelection(), org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, rectangle(), and run().

Referenced by org.libreoffice.InvalidationHandler.graphicSelection().

◆ changeSelections()

void org.libreoffice.overlay.DocumentOverlay.changeSelections ( final List< RectF > selections )

inline

Change the list of selections.

Definition at line 163 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlayView.changeSelections(), org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and run().

Referenced by org.libreoffice.InvalidationHandler.textSelection().

◆ getCurrentCursorPosition()

RectF org.libreoffice.overlay.DocumentOverlay.getCurrentCursorPosition ( )

inline

Definition at line 237 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlayView.getCurrentCursorPosition(), and org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView.

Referenced by org.libreoffice.LibreOfficeMainActivity.getCurrentCursorPosition().

◆ hideCursor()

void org.libreoffice.overlay.DocumentOverlay.hideCursor ( )

inline

Hide the cursor at the defined cursor position on the overlay.

Definition at line 97 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlayView.hideCursor(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and run().

Referenced by org.libreoffice.InvalidationHandler.cursorVisibility(), org.libreoffice.InvalidationHandler.handleNoneState(), and org.libreoffice.InvalidationHandler.messageRetrieved().

◆ hideGraphicSelection()

void org.libreoffice.overlay.DocumentOverlay.hideGraphicSelection ( )

inline

Hide the graphic selection.

Definition at line 185 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlayView.hideGraphicSelection(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and run().

Referenced by org.libreoffice.InvalidationHandler.handleNoneState(), and org.libreoffice.InvalidationHandler.handleTransitionState().

◆ hideHandle()

void org.libreoffice.overlay.DocumentOverlay.hideHandle ( final SelectionHandle.HandleType type )

inline

Hide the handle (of input type).

Definition at line 218 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlayView.hideHandle(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and type.

Referenced by org.libreoffice.InvalidationHandler.cursorVisibility(), org.libreoffice.InvalidationHandler.handleNoneState(), org.libreoffice.InvalidationHandler.handleTransitionState(), and org.libreoffice.InvalidationHandler.messageRetrieved().

◆ hidePageNumberRect()

void org.libreoffice.overlay.DocumentOverlay.hidePageNumberRect ( )

inline

Hide the page number rectangle on the overlay.

Definition at line 119 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlayView.hidePageNumberRect(), org.libreoffice.overlay.DocumentOverlay.hidePageNumberRectDelayInMilliseconds, org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and run().

◆ hideSelections()

void org.libreoffice.overlay.DocumentOverlay.hideSelections ( )

inline

Hide selections on the overlay.

Definition at line 152 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlayView.hideSelections(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and run().

Referenced by org.libreoffice.InvalidationHandler.handleNoneState(), and org.libreoffice.InvalidationHandler.handleTransitionState().

◆ positionCursor()

void org.libreoffice.overlay.DocumentOverlay.positionCursor ( final RectF position )

inline

Position the cursor to the input position on the overlay.

Definition at line 130 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlayView.changeCursorPosition(), org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, position(), and run().

Referenced by org.libreoffice.InvalidationHandler.invalidateCursor().

◆ positionHandle()

void org.libreoffice.overlay.DocumentOverlay.positionHandle	(	final SelectionHandle.HandleType	type,
		final RectF	rectangle
	)

inline

Position the handle (of input type) position to the input rectangle.

Definition at line 229 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, org.libreoffice.overlay.DocumentOverlayView.positionHandle(), rectangle(), run(), and type.

Referenced by org.libreoffice.InvalidationHandler.invalidateCursor(), org.libreoffice.InvalidationHandler.textSelectionEnd(), and org.libreoffice.InvalidationHandler.textSelectionStart().

◆ setCalcHeadersController()

void org.libreoffice.overlay.DocumentOverlay.setCalcHeadersController ( CalcHeadersController calcHeadersController )

inline

Definition at line 241 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and org.libreoffice.overlay.DocumentOverlayView.setCalcHeadersController().

Referenced by org.libreoffice.overlay.CalcHeadersController.CalcHeadersController().

◆ setPartPageRectangles()

void org.libreoffice.overlay.DocumentOverlay.setPartPageRectangles ( List< RectF > rectangles )

inline

Definition at line 79 of file DocumentOverlay.java.

References org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, and org.libreoffice.overlay.DocumentOverlayView.setPartPageRectangles().

◆ showAdjustLengthLine()

void org.libreoffice.overlay.DocumentOverlay.showAdjustLengthLine	(	final boolean	isRow,
		final CalcHeadersView	view
	)

inline

Definition at line 261 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showAdjustLengthLine().

◆ showCellSelection()

void org.libreoffice.overlay.DocumentOverlay.showCellSelection ( final RectF cellCursorRect )

inline

Definition at line 245 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showCellSelection().

Referenced by org.libreoffice.InvalidationHandler.invalidateCellCursor().

◆ showCursor()

void org.libreoffice.overlay.DocumentOverlay.showCursor ( )

inline

Show the cursor at the defined cursor position on the overlay.

Definition at line 86 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showCursor().

Referenced by org.libreoffice.InvalidationHandler.cursorVisibility(), and org.libreoffice.InvalidationHandler.handleCursorState().

◆ showGraphicSelection()

void org.libreoffice.overlay.DocumentOverlay.showGraphicSelection ( )

inline

Show the graphic selection on the overlay.

Definition at line 174 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showGraphicSelection().

Referenced by org.libreoffice.InvalidationHandler.handleGraphicSelectionState().

◆ showHandle()

void org.libreoffice.overlay.DocumentOverlay.showHandle ( final SelectionHandle.HandleType type )

inline

Show the handle (of input type) on the overlay.

Definition at line 207 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), org.libreoffice.overlay.DocumentOverlayView.showHandle(), and type.

Referenced by org.libreoffice.InvalidationHandler.cursorVisibility(), org.libreoffice.InvalidationHandler.handleCursorState(), and org.libreoffice.InvalidationHandler.handleSelectionState().

◆ showHeaderSelection()

void org.libreoffice.overlay.DocumentOverlay.showHeaderSelection ( final RectF cellCursorRect )

inline

Definition at line 253 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showHeaderSelection().

Referenced by org.libreoffice.InvalidationHandler.textSelection().

◆ showPageNumberRect()

void org.libreoffice.overlay.DocumentOverlay.showPageNumberRect ( )

inline

Show the page number rectangle on the overlay.

Definition at line 108 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showPageNumberRect().

Referenced by org.mozilla.gecko.gfx.JavaPanZoomController.FlingRunnable.animateFrame().

◆ showSelections()

void org.libreoffice.overlay.DocumentOverlay.showSelections ( )

inline

Show selections on the overlay.

Definition at line 141 of file DocumentOverlay.java.

References org.libreoffice.LOKitShell.getMainHandler(), org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView, run(), and org.libreoffice.overlay.DocumentOverlayView.showSelections().

Referenced by org.libreoffice.InvalidationHandler.handleSelectionState().

Member Data Documentation

◆ hidePageNumberRectDelayInMilliseconds

final long org.libreoffice.overlay.DocumentOverlay.hidePageNumberRectDelayInMilliseconds = 500

private

Definition at line 35 of file DocumentOverlay.java.

Referenced by org.libreoffice.overlay.DocumentOverlay.hidePageNumberRect().

◆ LOGTAG

final String org.libreoffice.overlay.DocumentOverlay.LOGTAG = DocumentOverlay.class.getSimpleName()

staticprivate

Definition at line 30 of file DocumentOverlay.java.

Referenced by org.libreoffice.overlay.DocumentOverlay.DocumentOverlay().

◆ mDocumentOverlayLayer

final DocumentOverlayLayer org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayLayer

private

Definition at line 33 of file DocumentOverlay.java.

Referenced by org.libreoffice.overlay.DocumentOverlay.DocumentOverlay().

◆ mDocumentOverlayView

final DocumentOverlayView org.libreoffice.overlay.DocumentOverlay.mDocumentOverlayView

private

Definition at line 32 of file DocumentOverlay.java.

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

DocumentOverlay.java

Classes

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DocumentOverlay()

Member Function Documentation

◆ changeGraphicSelection()

◆ changeSelections()

◆ getCurrentCursorPosition()

◆ hideCursor()

◆ hideGraphicSelection()

◆ hideHandle()

◆ hidePageNumberRect()

◆ hideSelections()

◆ positionCursor()

◆ positionHandle()

◆ setCalcHeadersController()

◆ setPartPageRectangles()

◆ showAdjustLengthLine()

◆ showCellSelection()

◆ showCursor()

◆ showGraphicSelection()

◆ showHandle()

◆ showHeaderSelection()

◆ showPageNumberRect()

◆ showSelections()

Member Data Documentation

◆ hidePageNumberRectDelayInMilliseconds

◆ LOGTAG

◆ mDocumentOverlayLayer

◆ mDocumentOverlayView