Package com.intellij.openapi.vcs

Interface CheckinProjectPanel

All Superinterfaces:

CommitMessageI, Refreshable

public interface CheckinProjectPanel
extends Refreshable, CommitMessageI

Interface for working with the checkin dialog user interface (retrieving the files included in the checkin operation, getting/setting the commit message and so on). The active check-in dialog can be retrieved from the using Refreshable.PANEL_KEY

See Also:

BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext)

Field Summary

Fields inherited from interface com.intellij.openapi.vcs.ui.Refreshable

PANEL, PANEL_KEY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommitActionName()
java.lang.String	getCommitMessage() Gets the description for the check-in.
CommitWorkflowHandler	getCommitWorkflowHandler()
javax.swing.JComponent	getComponent()
java.util.Collection<java.io.File>	getFiles() Returns the list of files selected for checkin, as File objects.
javax.swing.JComponent	getPreferredFocusedComponent()
Project	getProject() Returns the project in which the checkin is performed.
java.util.Collection<VirtualFile>	getRoots() Returns the list of roots for the check-in (roots of all modules under version control in a "checkin project" operation, the files/directories selected for check-in in a "checkin directory" or "checkin file" operation).
java.util.Collection<Change>	getSelectedChanges()
java.util.Collection<VirtualFile>	getVirtualFiles() Returns the list of files selected for checkin, as VirtualFile objects.
boolean	hasDiffs() Checks if the checkin operation has anything to check in.
boolean	vcsIsAffected(java.lang.String name) Checks whether any changes under vcs are included into commit operation

Methods inherited from interface com.intellij.openapi.vcs.ui.Refreshable

refresh, restoreState, saveState

Methods inherited from interface com.intellij.openapi.vcs.CommitMessageI

setCommitMessage

Method Detail

getComponent

javax.swing.JComponent getComponent()

getPreferredFocusedComponent

javax.swing.JComponent getPreferredFocusedComponent()

getCommitWorkflowHandler

CommitWorkflowHandler getCommitWorkflowHandler()

hasDiffs

boolean hasDiffs()

Checks if the checkin operation has anything to check in.

Returns:

true if any files need to be updated, added or deleted; false otherwise.

getVirtualFiles

java.util.Collection<VirtualFile> getVirtualFiles()

Returns the list of files selected for checkin, as VirtualFile objects. The returned list does not include files which will be deleted from the VCS during the check-in operation.

Returns:

the files selected for checkin.

getSelectedChanges

java.util.Collection<Change> getSelectedChanges()

getFiles

java.util.Collection<java.io.File> getFiles()

Returns the list of files selected for checkin, as File objects. The returned list includes files which will be deleted from the VCS during the check-in operation.

Returns:

the files selected for checkin.

getProject

Project getProject()

Returns the project in which the checkin is performed.

Returns:

the project instance.

vcsIsAffected

boolean vcsIsAffected(java.lang.String name)

Checks whether any changes under vcs are included into commit operation

getRoots

java.util.Collection<VirtualFile> getRoots()

Returns the list of roots for the check-in (roots of all modules under version control in a "checkin project" operation, the files/directories selected for check-in in a "checkin directory" or "checkin file" operation).

Returns:

the list of roots for check-in.

getCommitMessage

java.lang.String getCommitMessage()

Gets the description for the check-in.

Returns:

the description text.

getCommitActionName

java.lang.String getCommitActionName()