org.kie.workbench.common.widgets.client.handlers

Interface NewResourceHandler

All Known Implementing Classes:

DefaultNewResourceHandler

public interface NewResourceHandler

Definition of Handler to support creation of new resources

Method Summary

Modifier and Type	Method and Description
void	acceptContext(org.guvnor.common.services.project.context.ProjectContext context, com.google.gwt.core.client.Callback<Boolean,Void> callback) Indicates if the NewResourceHandler can create a resource to this path
boolean	canCreate() Asks if the resource handler can be created or not.
void	create(org.guvnor.common.services.project.model.Package pkg, String baseFileName, NewResourcePresenter presenter) An entry-point for the creation of the new resource
org.uberfire.mvp.Command	getCommand(NewResourcePresenter newResourcePresenter) A command to execute instead of defaulting to the NewResourceView.
String	getDescription() A description of the new resource type
List<org.uberfire.commons.data.Pair<String,? extends com.google.gwt.user.client.ui.IsWidget>>	getExtensions() Return a List of Widgets that the NewResourceHandler can use to gather additional parameters for the new resource.
com.google.gwt.user.client.ui.IsWidget	getIcon() An icon representing the new resource type
org.uberfire.workbench.type.ResourceTypeDefinition	getResourceType() Get the ResourceType represented by the Handler
void	validate(String baseFileName, org.uberfire.ext.editor.commons.client.validation.ValidatorWithReasonCallback callback) Provide NewResourceHandlers with the ability to validate additional parameters before the creation of the new resource

Method Detail

getDescription

String getDescription()

A description of the new resource type

Returns:

getIcon

com.google.gwt.user.client.ui.IsWidget getIcon()

An icon representing the new resource type

Returns:

getResourceType

org.uberfire.workbench.type.ResourceTypeDefinition getResourceType()

Get the ResourceType represented by the Handler

Returns:

resource type

canCreate

boolean canCreate()

Asks if the resource handler can be created or not. For example a lack of a certain role can return false.

Returns:

If true this resource handler can be added.

create

void create(org.guvnor.common.services.project.model.Package pkg,
            String baseFileName,
            NewResourcePresenter presenter)

An entry-point for the creation of the new resource

Parameters:

pkg - the Package context where new resource should be created

baseFileName - the base name of the new resource

presenter - underlying presenter

getExtensions

List<org.uberfire.commons.data.Pair<String,? extends com.google.gwt.user.client.ui.IsWidget>> getExtensions()

Return a List of Widgets that the NewResourceHandler can use to gather additional parameters for the new resource. The List is of Pairs, where each Pair consists of a String caption and IsWidget editor.

Returns:

null if no extension is provided

validate

void validate(String baseFileName,
              org.uberfire.ext.editor.commons.client.validation.ValidatorWithReasonCallback callback)

Provide NewResourceHandlers with the ability to validate additional parameters before the creation of the new resource

Parameters:

baseFileName - The base file name for the new item (excluding extension)

callback - Callback depending on validation result

acceptContext

void acceptContext(org.guvnor.common.services.project.context.ProjectContext context,
                   com.google.gwt.core.client.Callback<Boolean,Void> callback)

Indicates if the NewResourceHandler can create a resource to this path

getCommand

org.uberfire.mvp.Command getCommand(NewResourcePresenter newResourcePresenter)

A command to execute instead of defaulting to the NewResourceView. If this returns null the NewResourceView is shown by default.

Parameters:

newResourcePresenter -

Returns: