sysmodelmgr/com.symbian.smt.gui/src/com/symbian/smt/gui/smtwidgets/IFileInputValidator.java
author terytkon
Thu, 11 Mar 2010 19:08:43 +0200
changeset 0 522a326673b6
permissions -rw-r--r--
Moved swconfigapps content under oss repository.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     2
// All rights reserved.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     3
// This component and the accompanying materials are made available
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     5
// which accompanies this distribution, and is available
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     7
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     8
// Initial Contributors:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    10
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    11
// Contributors:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    12
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    13
// Description:
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    14
// IFileInputValidator
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    15
//
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    16
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    17
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    18
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    19
package com.symbian.smt.gui.smtwidgets;
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    20
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    21
import org.eclipse.jface.dialogs.IInputValidator;
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    22
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    23
/**
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    24
 * This is an extension of the IInputValidator interface which caters for
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    25
 * validation of local files and URLs.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    26
 * <p>
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    27
 * While isValid() is invoked dynamically as the user types his input (as per
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    28
 * the standard IInputValidator interface), the methods
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    29
 * <code>isFileReadable()</code> and <code>isUrlResourceReadable</code> defined
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    30
 * by this interface are invoked when the user presses the dialog's OK button,
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    31
 * as these operations may take longer to execute.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    32
 * <p>
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    33
 * The third method, <code>isUrl()</code>, is a utility method that determines
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    34
 * whether a given String is a URL or a simple file path.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    35
 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    36
 * @author barbararosi-schwartz
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    37
 * 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    38
 */
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    39
public interface IFileInputValidator extends IInputValidator {
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    40
	
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    41
	// The unconventional method signature follows the pattern of 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    42
	// IInputValidator's isValid() method.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    43
	public String isFileReadable(String filePath);
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    44
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    45
	// The unconventional method signature follows the pattern of 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    46
	// IInputValidator's isValid() method.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    47
	public boolean isUrl(String filePath) throws InvalidPathException;
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    48
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    49
	// The unconventional method signature follows the pattern of 
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    50
	// IInputValidator's isValid() method.
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    51
	public String isUrlResourceReadable(String urlPath);
522a326673b6 Moved swconfigapps content under oss repository.
terytkon
parents:
diff changeset
    52
}