Package com._1c.g5.v8.dt.form.ui.commands

Class GotoEventHandlerHandler

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.core.commands.AbstractHandler

com._1c.g5.v8.dt.form.ui.commands.AbstractGotoEventHandlerHandler<EventHandlerContainer>

com._1c.g5.v8.dt.form.ui.commands.GotoEventHandlerHandler

All Implemented Interfaces:

org.eclipse.core.commands.IHandler, org.eclipse.core.commands.IHandler2

public class GotoEventHandlerHandler
extends AbstractGotoEventHandlerHandler<EventHandlerContainer>

Checks selected form element event handler existence and then selects and reveals it.

Command must be executed with event name command parameter and optionally with handler name command parameter if handler is not created yet and custom handler name is preferred.

See Also:

IFormCommands.COMMAND_GOTO_EVENT_HANDLER, IFormCommands.COMMAND_PARAMETER_HANDLER_NAME, IFormCommands.COMMAND_PARAMETER_EVENT_NAME

Field Summary

Fields

Modifier and Type	Field	Description
protected FormItemInformationService	formItemInformationService
protected IRuntimeVersionSupport	runtimeVersionSupport
protected IV8ProjectManager	v8projectManager

Fields inherited from class com._1c.g5.v8.dt.form.ui.commands.AbstractGotoEventHandlerHandler

bmModelManager, moduleEventsLookup

Constructor Summary

Constructors

Constructor	Description
GotoEventHandlerHandler()

Method Summary

Modifier and Type	Method	Description
protected EventHandlerContainer	extractEventOwner(org.eclipse.emf.ecore.EObject element, Form form, org.eclipse.core.commands.ExecutionEvent executionEvent)	Extracts event owner from given form element.
protected String	generateEventHandlerName(EventHandlerContainer eventOwner, org.eclipse.emf.ecore.EObject element, org.eclipse.core.commands.ExecutionEvent executionEvent)	Generates eventOwner event handler name.
protected Event	getCreatingEvent(org.eclipse.emf.ecore.EObject eventOwner, org.eclipse.core.commands.ExecutionEvent executionEvent, String handlerName)	Gets event for handler creation.
protected Event	getEvent(org.eclipse.emf.ecore.EObject eventOwner, org.eclipse.core.commands.ExecutionEvent executionEvent)	Extracts event for the provided form event owner and command execution event.
protected String	getEventHandlerName(EventHandlerContainer eventOwner, org.eclipse.emf.ecore.EObject element, org.eclipse.core.commands.ExecutionEvent executionEvent)	Returns eventOwner event handler name.
protected String	getEventName(org.eclipse.core.commands.ExecutionEvent executionEvent)	Returns the handler event english name provided by the execution event.
protected String	getHandlerName(org.eclipse.core.commands.ExecutionEvent executionEvent)	Returns the handler name provided by the execution event.
protected String	getProcedureDirective(org.eclipse.swt.widgets.Shell shell, boolean isRussian, EventHandlerContainer eventOwner, org.eclipse.emf.ecore.EObject element, org.eclipse.core.commands.ExecutionEvent executionEvent)	Returns procedure directive for chosen event, or empty string if there is no procedure for creating event handler.
protected boolean	isAllowedServerCall(EventHandlerContainer eventOwner, org.eclipse.emf.ecore.EObject element, org.eclipse.core.commands.ExecutionEvent executionEvent)	Returns whether creating event handler server call is allowed.
protected void	setEventHandler(EventHandlerContainer eventOwner, String eventHandlerName, org.eclipse.core.commands.ExecutionEvent executionEvent)	Sets eventOwner event handler.

Methods inherited from class com._1c.g5.v8.dt.form.ui.commands.AbstractGotoEventHandlerHandler

execute, getEditingContext, getForm, isCommandHandler, isMainItem, openOrCreateEventHandler, selectAndReveal, shouldCreateEvent

Methods inherited from class org.eclipse.core.commands.AbstractHandler

addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, isHandled, removeHandlerListener, setBaseEnabled, setEnabled

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Field Detail

formItemInformationService

@Inject
protected FormItemInformationService formItemInformationService

v8projectManager

@Inject
protected IV8ProjectManager v8projectManager

runtimeVersionSupport

@Inject
protected IRuntimeVersionSupport runtimeVersionSupport

Constructor Detail

GotoEventHandlerHandler

public GotoEventHandlerHandler()

Method Detail

extractEventOwner

protected EventHandlerContainer extractEventOwner(org.eclipse.emf.ecore.EObject element,
                                                  Form form,
                                                  org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Extracts event owner from given form element.

Specified by:

extractEventOwner in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

element - the form element to extract event owner from, cannot be null

form - the owner form, cannot be null

executionEvent - the current execution event, cannot be null

Returns:

the event owner, never null

getEventHandlerName

protected String getEventHandlerName(EventHandlerContainer eventOwner,
                                     org.eclipse.emf.ecore.EObject element,
                                     org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Returns eventOwner event handler name. Can return null if not provided.

Specified by:

getEventHandlerName in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

eventOwner - the owner of event, cannot be null

element - the currently selected form element, cannot be null

executionEvent - the current execution event, cannot be null

Returns:

the existing event handler name or null if none

generateEventHandlerName

protected String generateEventHandlerName(EventHandlerContainer eventOwner,
                                          org.eclipse.emf.ecore.EObject element,
                                          org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Generates eventOwner event handler name.

Specified by:

generateEventHandlerName in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

eventOwner - the owner of event, cannot be null

element - the currently selected form element, cannot be null

executionEvent - the current execution event, cannot be null

Returns:

generated event handler name, never null

setEventHandler

protected void setEventHandler(EventHandlerContainer eventOwner,
                               String eventHandlerName,
                               org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Sets eventOwner event handler.

Specified by:

setEventHandler in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

eventOwner - the owner of event, cannot be null

eventHandlerName - the event handler name to set, cannot be null

executionEvent - the current execution event, cannot be null

isAllowedServerCall

protected boolean isAllowedServerCall(EventHandlerContainer eventOwner,
                                      org.eclipse.emf.ecore.EObject element,
                                      org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Returns whether creating event handler server call is allowed.

Overrides:

isAllowedServerCall in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

eventOwner - the owner of event, cannot be null

element - the currently selected form element, cannot be null

executionEvent - the current execution event, cannot be null

Returns:

whether creating event handler server call is allowed

getProcedureDirective

protected String getProcedureDirective(org.eclipse.swt.widgets.Shell shell,
                                       boolean isRussian,
                                       EventHandlerContainer eventOwner,
                                       org.eclipse.emf.ecore.EObject element,
                                       org.eclipse.core.commands.ExecutionEvent executionEvent)

Description copied from class: AbstractGotoEventHandlerHandler

Returns procedure directive for chosen event, or empty string if there is no procedure for creating event handler.

Can return null if user cancelled event handler creation.

Overrides:

getProcedureDirective in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

shell - the parent shell to open question dialog on, cannot be null

isRussian - true if actual script variant is russian, false otherwise

eventOwner - the owner of event, cannot be null

element - the currently selected form element, cannot be null

executionEvent - the current execution event, cannot be null

Returns:

the procedure directive for chosen event, or empty string if there is no procedure for chosen event, or null if user cancelled event handler creation

getCreatingEvent

protected Event getCreatingEvent(org.eclipse.emf.ecore.EObject eventOwner,
                                 org.eclipse.core.commands.ExecutionEvent executionEvent,
                                 String handlerName)

Description copied from class: AbstractGotoEventHandlerHandler

Gets event for handler creation.

Specified by:

getCreatingEvent in class AbstractGotoEventHandlerHandler<EventHandlerContainer>

Parameters:

eventOwner - the owner of event, cannot be null

executionEvent - the current execution event, cannot be null

handlerName - the event handler name to create event with, cannot be null

Returns:

creating event, never null

getEvent

protected Event getEvent(org.eclipse.emf.ecore.EObject eventOwner,
                         org.eclipse.core.commands.ExecutionEvent executionEvent)

Extracts event for the provided form event owner and command execution event.

Parameters:

eventOwner - the form event owner, cannot be null

executionEvent - the command execution event, cannot be null

Returns:

event for the provided form event owner and command execution event, never null

getHandlerName

protected String getHandlerName(org.eclipse.core.commands.ExecutionEvent executionEvent)

Returns the handler name provided by the execution event. Can return null.

Parameters:

executionEvent - the command execution event, cannot be null

Returns:

the handler name provided by the execution event or null if not provided

getEventName

protected String getEventName(org.eclipse.core.commands.ExecutionEvent executionEvent)

Returns the handler event english name provided by the execution event. Can return null.

Parameters:

executionEvent - the command execution event, cannot be null

Returns:

the handler event english name provided by the execution event or null if not provided