com.jidesoft.document

Interface IDocumentGroup

All Known Implementing Classes:

TdiGroup

public interface IDocumentGroup

An interface to represent the concept of document group.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(DocumentComponent document) Adds a document to the this document group.
void	addDocument(DocumentComponent document, int index) Adds a document to the this document group.
Component	getDocumentAt(int index) Gets document at position index.
int	getDocumentCount() Gets document count in this group.
Component	getSelectedDocument() Gets component of the selected document in this group.
int	getSelectedIndex() Gets component of the selected document in this group.
int	indexOfDocument(Component component) Gets the index of the document.
void	moveSelectedDocumentTo(int index) Moves selected document to another index.
void	removeDocument(DocumentComponent document) Removes document.
void	removeDocument(int index) Removes document at index.
void	setSelectedDocument(Component component) Sets the selected document.
void	updateComponent(DocumentComponent document) Deprecated. replaced by updateComponent(DocumentComponent, java.awt.Component)
void	updateComponent(DocumentComponent document, Component oldComponent) Updates the component of document.
void	updateTitle(DocumentComponent document) Updates the title of document.

Method Detail

addDocument

void addDocument(DocumentComponent document)

Adds a document to the this document group.

Parameters:

document - document to be added

addDocument

void addDocument(DocumentComponent document,
               int index)

Adds a document to the this document group.

Parameters:

document - document to be added

index - the index of the document where it will be added.

removeDocument

void removeDocument(int index)

Removes document at index.

Parameters:

index - index of the document to be removed

removeDocument

void removeDocument(DocumentComponent document)

Removes document.

Parameters:

document - document to be removed

updateTitle

void updateTitle(DocumentComponent document)

Updates the title of document. You should call this method if the title of the document changed.

Parameters:

document - the document

updateComponent

@Deprecated
void updateComponent(DocumentComponent document)

Deprecated. replaced by updateComponent(DocumentComponent, java.awt.Component)

Updates the component of document. You should call this method if the component of the document changed.

Parameters:

document - the document

updateComponent

void updateComponent(DocumentComponent document,
                   Component oldComponent)

Updates the component of document. You should call this method if the component of the document changed.

Parameters:

document - the document

oldComponent - the old component of the document

getSelectedDocument

Component getSelectedDocument()

Gets component of the selected document in this group.

Returns:

the component of the selected document

getSelectedIndex

int getSelectedIndex()

Gets component of the selected document in this group.

Returns:

the index of the selected document

setSelectedDocument

void setSelectedDocument(Component component)

Sets the selected document.

Parameters:

component - component of the selected document

getDocumentCount

int getDocumentCount()

Gets document count in this group.

Returns:

document count

getDocumentAt

Component getDocumentAt(int index)

Gets document at position index.

Parameters:

index - the index of the document

Returns:

the document at position index

indexOfDocument

int indexOfDocument(Component component)

Gets the index of the document.

Parameters:

component - the component

Returns:

index of the document

moveSelectedDocumentTo

void moveSelectedDocumentTo(int index)

Moves selected document to another index.

Parameters:

index - the index of the document