JumpList.Entry (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class JumpList.Entry

java.lang.Object
  org.netbeans.editor.JumpList.Entry

Enclosing class:: JumpList

public static final class JumpList.Entry
extends Object
extends Object

An entry in the list with JTextComponent and a position in its Document.

Method Summary

JTextComponent getComponent()
          Gets the component maintained by this entry.

int getPosition()
          Gets the offset of the position maintaind by this entry.

boolean setDot()
          Navigates to the component and position maintained by this entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Summary
`JTextComponent`	`getComponent()` Gets the component maintained by this entry.
`int`	`getPosition()` Gets the offset of the position maintaind by this entry.
`boolean`	`setDot()` Navigates to the component and position maintained by this entry.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getPosition

public int getPosition()

Gets the offset of the position maintaind by this entry.

Returns:: An offset within this entry's component's document or -1 if this entry is not valid anymore.

getComponent

public JTextComponent getComponent()

Gets the component maintained by this entry.

Returns:: The component or null if this entry is not valid anymore.

setDot

public boolean setDot()

Navigates to the component and position maintained by this entry.

This method will try to move focus to the component stored in this entry and set its caret to the position maintained by this entry.

Returns:: true if the navigation was successful, false otherwise.