net.sf.mpxj

Interface View

All Known Implementing Classes:

AbstractMppView, AbstractView, GanttChartView, GanttChartView12, GanttChartView14, GanttChartView9, GenericView, GenericView12, GenericView14, GenericView9, SplitView9, View8

public interface View

This interface represents a view of a set of project data that has been instantiated within an MS Project file. View data is instantiated when a user first looks at a view in MS Project. Each "screen" in MS Project, for example the Gantt Chart, the Resource Sheet and so on are views. If a user has not looked at a view (for example the Resource Usage view), information about that view will not be present in the MPP file.

Method Summary

Modifier and Type	Method and Description
Integer	getID() This method is used to retrieve the unique view identifier.
String	getName() This method is used to retrieve the view name.
Table	getTable() Retrieve an instance of the Table class representing the table part of this view.
String	getTableName() Retrieve the name of the table part of the view.
ViewType	getType() Retrieves the view type.

Method Detail

getID

Integer getID()

This method is used to retrieve the unique view identifier. This value identifies the view within the file. It does not identify the type of view represented by an instance of this class.

Returns:

view identifier

getName

String getName()

This method is used to retrieve the view name. Note that internally in MS Project the view name will contain an ampersand (&) used to flag the letter that can be used as a shortcut for this view. The ampersand is stripped out by MPXJ.

Returns:

view name

getType

ViewType getType()

Retrieves the view type.

Returns:

view type

getTableName

String getTableName()

Retrieve the name of the table part of the view.

Returns:

table name

getTable

Table getTable()

Retrieve an instance of the Table class representing the table part of this view.

Returns:

table instance