com.ibm.notes.java.ui.views
Interface NotesUIView

All Superinterfaces:

IAdaptable, NotesUIElement

public interface NotesUIView
extends NotesUIElement

An Object that represents a specific View inside a Notes database.

A note about Calendar views. If the NotesUIView object represents a calendar view than the functionality of around actionable entries is limited. In all scenarios you will be able to get the first actionable entry from the NotesUIViewEntryCollection when calling getActionableEntries(), but you may not be able to reliably get the rest of the actionable entries if there are any.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

void	addViewEntryListener(ViewEntryListener listener) Add a listener that will get notified of view entry events.
NotesUIViewEntryCollection	getActionableEntries() Gets a list of view entries to perform an action on.
List<NotesUIViewColumn>	getColumns() Gets the columns in this view.
NotesViewData	getViewData() Gets the view data for this view.
void	print() Send the view to the printer.
void	removeViewEntryListener(ViewEntryListener listener) Stop listening for view entry events.

Methods inherited from interface com.ibm.notes.java.ui.NotesUIElement

activate, addCloseListener, close, getTitle, getUrl, getWindow, removeCloseListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getActionableEntries

NotesUIViewEntryCollection getActionableEntries()

Gets a list of view entries to perform an action on. This collection can contain the caret or selected entries in the view.

• If the view is a Java view, the gutter is enabled, and there is no selection, than this collection will contain the caret entry. If the view is a Java view, the gutter is enabled, and there is a selection than this collection will contain the selected entries.
• If the view is a Java view and the gutter is not enabled than this collection will contain the selected entries.
• If the view is a classic view and there is no selection than this collection will contain the caret entry. If the view is a classic view and there is a selection than this collection will contain the selected entries.

The collection returned will only contain one instance of each entry selected in the view. For example, if this NotesUIView represents a categorized view and the same entry appears twice under different categories and both of those entries are selected in the view, only the first one of those entries will be returned as part of this collection. The collection returned from calling this method is only a snapshot of the actionable entries, meaning is the actionable entries change after calling this method the object returned will not be updated. This method must be called again to get the updated collection.

Note: This method is not fully supported with calendar views. If the view is a calendar view we may or may not be able to provide the caller with the actionable entries in the view.

Returns:

a collection of view entries to perform an action on

Since:

8.5.2

addViewEntryListener

void addViewEntryListener(ViewEntryListener listener)

Add a listener that will get notified of view entry events.

Parameters:

listener - listener to be notified when an event occurs in the view

Since:

8.5.2

removeViewEntryListener

void removeViewEntryListener(ViewEntryListener listener)

Stop listening for view entry events.

Parameters:

listener - listener to be removed

Since:

8.5.2

print

void print()

Send the view to the printer.

Since:

8.5.1

getViewData

NotesViewData getViewData()

Gets the view data for this view.

Returns:

the view data for this view

Since:

8.5.1

getColumns

List<NotesUIViewColumn> getColumns()

Gets the columns in this view. Note there is a limit, in some situations, on the number of columns you can get from classic views (non-PIM views).

In the examples below view A is a classic view with more than 75 columns. View B is a classic view with any number of columns.

• If a database is opened to view A, then only the first 75 columns will be returned using this method. If a database is opened to view A, switches to view B, then switches back to view A, this method will return all the columns in view A.
• If view A is opened from a restored tab created in the previous Notes session and was opened automatically at startup, then this method will return all of the columns in view A.
• If view A is opened in a tab which was bookmarked in the startup folder in the Open list and the tab was created automatically at startup, then this method will only return the first 75 columns in the view.

Returns:

the columns in this view

Since:

8.5.2