Class gui.GuiStepUtils
Defined in: GuiStepUtils.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Helper functions to retrieve information about an ODF document using a step iterator
|
| Method Attributes | Method Name and Description |
|---|---|
| <inner> |
getContentRect(stepIterator)
Returns the client rectangle for the content bounds at the step iterator's current position.
|
| <inner> |
moveToFilteredStep(stepIterator, direction, scanners)
Advance the step iterator in the specified direction until an accepted step is identified
by a token scanner.
|
Class Detail
gui.GuiStepUtils()
Helper functions to retrieve information about an ODF document using a step iterator
Method Detail
<inner>
{?ClientRect}
getContentRect(stepIterator)
Returns the client rectangle for the content bounds at the step iterator's current position.
Note, if the selected content is really collapsed whitespace, this function will return null.
- Parameters:
- {!core.StepIterator} stepIterator
- Returns:
- {?ClientRect}
<inner>
{!boolean}
moveToFilteredStep(stepIterator, direction, scanners)
Advance the step iterator in the specified direction until an accepted step is identified
by a token scanner.
- Parameters:
- {!core.StepIterator} stepIterator
- {!core.StepDirection} direction
- {!Array.} scanners
- Returns:
- {!boolean} Return true if a step was found that satisfied one of the scanners
