public class ResourceAndContainerGroup
extends java.lang.Object
implements org.eclipse.swt.widgets.Listener
Modifier and Type | Field and Description |
---|---|
static int |
PROBLEM_CONTAINER_EMPTY
Constant for empty container.
|
static int |
PROBLEM_NAME_INVALID
Constant for invalid name.
|
static int |
PROBLEM_NONE
Constant for no problem.
|
static int |
PROBLEM_PATH_INVALID
Constant for invalid path.
|
static int |
PROBLEM_PATH_OCCUPIED
Constant for path already occupied.
|
static int |
PROBLEM_PROJECT_DOES_NOT_EXIST
Constant for project does not exist.
|
static int |
PROBLEM_RESOURCE_EMPTY
Constant for empty resource.
|
static int |
PROBLEM_RESOURCE_EXIST
Constant for resource already exists.
|
Constructor and Description |
---|
ResourceAndContainerGroup(org.eclipse.swt.widgets.Composite parent,
org.eclipse.swt.widgets.Listener client,
java.lang.String resourceFieldLabel,
java.lang.String resourceType,
boolean showClosedProjects,
int heightHint)
Create an instance of the group to allow the user to enter/select a
container and specify a resource name.
|
Modifier and Type | Method and Description |
---|---|
boolean |
areAllValuesValid()
Returns a boolean indicating whether all controls in this group contain
valid values.
|
protected void |
createContents(org.eclipse.swt.widgets.Composite parent,
java.lang.String resourceLabelString,
int heightHint)
Creates this object's visual components.
|
boolean |
getAllowExistingResources()
Returns the flag indicating whether existing resources are permitted.
|
org.eclipse.core.runtime.IPath |
getContainerFullPath()
Returns the path of the currently selected container or null if no
container has been selected.
|
java.lang.String |
getProblemMessage()
Returns an error message indicating the current problem with the value of
a control in the group, or an empty message if all controls in the group
contain valid values.
|
int |
getProblemType()
Returns the type of problem with the value of a control in the group.
|
java.lang.String |
getResource()
Returns a string that is the name of the chosen resource, or an empty
string if no resource has been entered.
|
void |
handleEvent(org.eclipse.swt.widgets.Event e)
Handles events for all controls in the group.
|
void |
setAllowExistingResources(boolean value)
Sets the flag indicating whether existing resources are permitted.
|
void |
setContainerFullPath(org.eclipse.core.runtime.IPath path)
Sets the value of this page's container.
|
void |
setFocus()
Gives focus to the resource name field and selects its contents
|
void |
setResource(java.lang.String value)
Sets the value of this page's resource name.
|
void |
setResourceExtension(java.lang.String value)
Set the only file extension allowed for the resource name field.
|
protected boolean |
validateContainer()
Returns a
boolean indicating whether a container name
represents a valid container resource in the workbench. |
protected boolean |
validateControls()
Validates the values for each of the group's controls.
|
protected boolean |
validateFullResourcePath(org.eclipse.core.runtime.IPath resourcePath)
Returns a
boolean indicating whether the specified
resource path represents a valid new resource in the workbench. |
protected boolean |
validateResourceName()
Returns a
boolean indicating whether the resource name
rep- resents a valid resource name in the workbench. |
public static final int PROBLEM_NONE
public static final int PROBLEM_RESOURCE_EMPTY
public static final int PROBLEM_RESOURCE_EXIST
public static final int PROBLEM_PATH_INVALID
public static final int PROBLEM_CONTAINER_EMPTY
public static final int PROBLEM_PROJECT_DOES_NOT_EXIST
public static final int PROBLEM_NAME_INVALID
public static final int PROBLEM_PATH_OCCUPIED
public ResourceAndContainerGroup(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Listener client, java.lang.String resourceFieldLabel, java.lang.String resourceType, boolean showClosedProjects, int heightHint)
parent
- composite widget to parent the groupclient
- object interested in changes to the group's fields valueresourceFieldLabel
- label to use in front of the resource name fieldresourceType
- one word, in lowercase, to describe the resource to the user
(file, folder, project)showClosedProjects
- whether or not to show closed projectsheightHint
- height hint for the container selection widget grouppublic boolean areAllValuesValid()
protected void createContents(org.eclipse.swt.widgets.Composite parent, java.lang.String resourceLabelString, int heightHint)
parent
- org.eclipse.swt.widgets.CompositeheightHint
- height hint for the container selection widget grouppublic org.eclipse.core.runtime.IPath getContainerFullPath()
null
public java.lang.String getProblemMessage()
public int getProblemType()
public java.lang.String getResource()
setResourceExtension(String)
public void handleEvent(org.eclipse.swt.widgets.Event e)
handleEvent
in interface org.eclipse.swt.widgets.Listener
e
- org.eclipse.swt.widgets.Eventpublic void setAllowExistingResources(boolean value)
value
- public void setContainerFullPath(org.eclipse.core.runtime.IPath path)
path
- Full path to the container.public void setFocus()
public void setResource(java.lang.String value)
value
- new valuepublic void setResourceExtension(java.lang.String value)
value
- The resource extension without the '.' prefix (e.g. 'java',
'xml')protected boolean validateContainer()
boolean
indicating whether a container name
represents a valid container resource in the workbench. An error message
is stored for future reference if the name does not represent a valid
container.boolean
indicating validity of the container nameprotected boolean validateControls()
protected boolean validateFullResourcePath(org.eclipse.core.runtime.IPath resourcePath)
boolean
indicating whether the specified
resource path represents a valid new resource in the workbench. An error
message is stored for future reference if the path does not represent a
valid new resource path.resourcePath
- the path to validateboolean
indicating validity of the resource pathprotected boolean validateResourceName()
boolean
indicating whether the resource name
rep- resents a valid resource name in the workbench. An error message is
stored for future reference if the name does not represent a valid
resource name.boolean
indicating validity of the resource namepublic boolean getAllowExistingResources()
setAllowExistingResources(boolean)