Package com.intellij.dvcs.push.ui

Class VcsPushDialog

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.dvcs.push.ui.VcsPushDialog

All Implemented Interfaces:

VcsPushUi, DataProvider

Direct Known Subclasses:

GitPushAfterCommitDialog

public class VcsPushDialog
extends DialogWrapper
implements VcsPushUi, DataProvider

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.ui.DialogWrapper

DialogWrapper.CancelAction, DialogWrapper.DialogStyle, DialogWrapper.DialogWrapperAction, DialogWrapper.DialogWrapperExitAction, DialogWrapper.DoNotAskOption, DialogWrapper.IdeModalityType, DialogWrapper.OkAction

Field Summary

Fields

Modifier and Type	Field and Description
protected PushController	myController
protected Project	myProject

Fields inherited from class com.intellij.openapi.ui.DialogWrapper

CANCEL_EXIT_CODE, CLOSE_EXIT_CODE, DEFAULT_ACTION, DIALOG_CONTENT_PANEL_PROPERTY, ERROR_FOREGROUND_COLOR, FOCUSED_ACTION, IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY, myCancelAction, myCheckBoxDoNotShowDialog, myDisposable, myHelpAction, myOKAction, myPerformAction, myPreferredFocusedComponent, NEXT_USER_EXIT_CODE, OK_EXIT_CODE

Fields inherited from interface com.intellij.dvcs.push.ui.VcsPushUi

VCS_PUSH_DIALOG

Constructor Summary

Constructors

Constructor and Description
VcsPushDialog(Project project, java.util.Collection<? extends Repository> allRepos, java.util.List<? extends Repository> selectedRepositories, Repository currentRepo, PushSource pushSource)
VcsPushDialog(Project project, java.util.List<? extends Repository> selectedRepositories, Repository currentRepo)

Method Summary

Modifier and Type	Method and Description
boolean	canPush() Checks if push is available right now for selected repositories and their targets.
protected javax.swing.Action []	createActions() Creates actions for dialog.
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected javax.swing.border.Border	createContentPaneBorder() Creates border for dialog's content pane.
protected javax.swing.JPanel	createOptionsPanel()
protected javax.swing.JPanel	createSouthAdditionalPanel() Additional panel in the lower left part of dialog to the left from additional buttons
protected javax.swing.JComponent	createSouthPanel() Creates panel located at the south of the content pane.
protected void	doOKAction() This method is invoked by default implementation of "OK" action.
protected ValidationInfo	doValidate() Validates user input and returns null if everything is fine or validation description with component where problem has been found.
void	enableOkActions(boolean value)
void	executeAfterRunningPrePushHandlers(Task.Backgroundable activity) Runs pre-push handlers under a modal progress, if they succeed, schedules the given background task, and closes the push dialog.
VcsPushOptionValue	getAdditionalOptionValue(PushSupport support) Returns special push options, usually selected by user at the bottom of the push dialog.
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
protected java.lang.String	getDimensionServiceKey() Returns key for persisting dialog dimensions.
protected java.lang.String	getHelpId() Returns the help identifier, or null if no help is available.
protected javax.swing.Action	getOKAction()
javax.swing.JComponent	getPreferredFocusedComponent()
java.util.Map<PushSupport<Repository,PushSource,PushTarget>,java.util.Collection<PushInfo>>	getSelectedPushSpecs() Returns push specifications (what is being pushed, where from and where to) collected from the push dialog, grouped per PushSupports, which means in fact per-VCS.
protected boolean	postponeValidation() Allows to postpone first start of validation
void	push(boolean forcePush) Runs pre-push handlers under a modal progress, and after that starts push in a background task.
PrePushHandler.Result	runPrePushHandlersInModalTask()
void	updateOkActions()

Methods inherited from class com.intellij.openapi.ui.DialogWrapper

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createButtonsPanel, createCancelAction, createContentPane, createDefaultActions, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, createNorthPanel, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createTitlePane, dispose, disposeIfNeeded, doCancelAction, doCancelAction, doHelpAction, doValidateAll, extractMnemonic, findInstance, findInstanceFromFocus, getButton, getCancelAction, getContentPane, getContentPanel, getDimensionKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHorizontalStretch, getInitialLocation, getLocation, getOwner, getPeer, getPreferredSize, getRootPane, getSize, getStyle, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, init, initValidation, isAutoAdjustable, isCenterStrictedToPreferredSize, isDisposed, isModal, isModalProgress, isMoveHelpButtonLeft, isNorthStrictedToPreferredSize, isOK, isOKActionEnabled, isProgressDialog, isResizable, isShowing, isSouthStrictedToPreferredSize, isToDispatchTypeAhead, isTypeAheadEnabled, isVisible, layoutButtonsPanel, pack, processDoNotAskOnOk, repaint, setAutoAdjustable, setButtonsAlignment, setButtonsMargin, setCancelButtonIcon, setCancelButtonText, setCrossClosesWindow, setDoNotAskOption, setErrorInfoAll, setErrorText, setErrorText, setHelpTooltip, setHorizontalStretch, setInitialLocationCallback, setLocation, setLocation, setModal, setOKActionEnabled, setOKButtonIcon, setOKButtonMnemonic, setOKButtonText, setOKButtonTooltip, setResizable, setSize, setTitle, setUndecorated, setValidationDelay, setVerticalStretch, shouldAddErrorNearButtons, shouldCloseOnCross, show, showAndGet, showAndGetOk, startTrackingValidation, toBack, toBeShown, toFront, unregisterKeyboardActions, updateErrorInfo, validate

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

myController

protected final PushController myController

Constructor Detail

VcsPushDialog

public VcsPushDialog(Project project,
                     java.util.List<? extends Repository> selectedRepositories,
                     Repository currentRepo)

VcsPushDialog

public VcsPushDialog(Project project,
                     java.util.Collection<? extends Repository> allRepos,
                     java.util.List<? extends Repository> selectedRepositories,
                     Repository currentRepo,
                     PushSource pushSource)

Method Detail

createContentPaneBorder

protected javax.swing.border.Border createContentPaneBorder()

Description copied from class: DialogWrapper

Creates border for dialog's content pane. By default content pane has has empty border with (8,12,8,12) insets. Subclasses can return null for no border.

Overrides:

createContentPaneBorder in class DialogWrapper

Returns:

content pane border

createSouthAdditionalPanel

protected javax.swing.JPanel createSouthAdditionalPanel()

Description copied from class: DialogWrapper

Additional panel in the lower left part of dialog to the left from additional buttons

Overrides:

createSouthAdditionalPanel in class DialogWrapper

Returns:

panel to be shown or null if it's not required

createSouthPanel

protected javax.swing.JComponent createSouthPanel()

Description copied from class: DialogWrapper

Creates panel located at the south of the content pane. By default that panel contains dialog's buttons. This default implementation uses createActions() and createJButtonForAction(Action) methods to construct the panel.

Overrides:

createSouthPanel in class DialogWrapper

Returns:

south panel

createCenterPanel

protected javax.swing.JComponent createCenterPanel()

Description copied from class: DialogWrapper

Factory method. It creates panel with dialog options. Options panel is located at the center of the dialog's content pane. The implementation can return null value. In this case there will be no options panel.

Specified by:

createCenterPanel in class DialogWrapper

createOptionsPanel

protected javax.swing.JPanel createOptionsPanel()

getDimensionServiceKey

protected java.lang.String getDimensionServiceKey()

Description copied from class: DialogWrapper

Returns key for persisting dialog dimensions.

Default implementation returns null (no persisting).

Overrides:

getDimensionServiceKey in class DialogWrapper

Returns:

dimension service key

doValidate

protected ValidationInfo doValidate()

Description copied from class: DialogWrapper

Validates user input and returns null if everything is fine or validation description with component where problem has been found.

Overrides:

doValidate in class DialogWrapper

Returns:

null if everything is OK or validation descriptor

See Also:

Validation errors guidelines

postponeValidation

protected boolean postponeValidation()

Description copied from class: DialogWrapper

Allows to postpone first start of validation

Overrides:

postponeValidation in class DialogWrapper

Returns:

false if start validation in init() method

doOKAction

protected void doOKAction()

Description copied from class: DialogWrapper

This method is invoked by default implementation of "OK" action. It just closes dialog with OK_EXIT_CODE. This is convenient place to override functionality of "OK" action. Note that the method does nothing if "OK" action isn't enabled.

Overrides:

doOKAction in class DialogWrapper

createActions

protected javax.swing.Action [] createActions()

Description copied from class: DialogWrapper

Creates actions for dialog.

By default "OK" and "Cancel" actions are returned. The "Help" action is automatically added if DialogWrapper.getHelpId() returns non-null value.

Each action is represented by JButton created by DialogWrapper.createJButtonForAction(Action). These buttons are then placed into south panel of dialog.

Overrides:

createActions in class DialogWrapper

Returns:

dialog actions

See Also:

DialogWrapper.createSouthPanel(), DialogWrapper.createJButtonForAction(javax.swing.Action)

canPush

public boolean canPush()

Description copied from interface: VcsPushUi

Checks if push is available right now for selected repositories and their targets.

E.g. push is not allowed, when a target is being edited, or when a repository without any remotes is selected.

Specified by:

canPush in interface VcsPushUi

getSelectedPushSpecs

public java.util.Map<PushSupport<Repository,PushSource,PushTarget>,java.util.Collection<PushInfo>> getSelectedPushSpecs()

Description copied from interface: VcsPushUi

Returns push specifications (what is being pushed, where from and where to) collected from the push dialog, grouped per PushSupports, which means in fact per-VCS.

Although no type specification is given, it is guaranteed that in the returned Map each PushSupport is the one which corresponds to its RepoPushSpecs (all of which are of course of same types).

Specified by:

getSelectedPushSpecs in interface VcsPushUi

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

component which should be focused when the dialog appears on the screen.

getOKAction

protected javax.swing.Action getOKAction()

Overrides:

getOKAction in class DialogWrapper

Returns:

default implementation of "OK" action. This action just invokes doOKAction() method.

See Also:

DialogWrapper.doOKAction()

getHelpId

protected java.lang.String getHelpId()

Description copied from class: DialogWrapper

Returns the help identifier, or null if no help is available.

Overrides:

getHelpId in class DialogWrapper

push

public void push(boolean forcePush)

Description copied from interface: VcsPushUi

Runs pre-push handlers under a modal progress, and after that starts push in a background task.

Specified by:

push in interface VcsPushUi

executeAfterRunningPrePushHandlers

public void executeAfterRunningPrePushHandlers(Task.Backgroundable activity)

Description copied from interface: VcsPushUi

Runs pre-push handlers under a modal progress, if they succeed, schedules the given background task, and closes the push dialog.

Specified by:

executeAfterRunningPrePushHandlers in interface VcsPushUi

runPrePushHandlersInModalTask

public PrePushHandler.Result runPrePushHandlersInModalTask()

updateOkActions

public void updateOkActions()

enableOkActions

public void enableOkActions(boolean value)

getAdditionalOptionValue

public VcsPushOptionValue getAdditionalOptionValue(PushSupport support)

Description copied from interface: VcsPushUi

Returns special push options, usually selected by user at the bottom of the push dialog.

Specified by:

getAdditionalOptionValue in interface VcsPushUi

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.