de.frame4j.io

Class FileVisitor.Ask

java.lang.Object

de.frame4j.io.FileVisitor.Ask

All Implemented Interfaces:

FileVisitor, Serializable

Direct Known Subclasses:

FileVisitor.AskConsImpl, FileVisitor.AskGrafImpl

Enclosing interface:

FileVisitor

@MinDoc(copyright="Copyright  2001 - 2002, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="see enclosing interface FileVisitor",
        lastModified="see enclosing interface FileVisitor",
        lastModifiedBy="see enclosing interface FileVisitor",
        usage="a (base for a) visitor for files",
        purpose="ask a question on the visited file (or directory)")
public abstract static class FileVisitor.Ask
extends Object
implements FileVisitor, Serializable

An implementation of FileVisitor: Ask a question on a file.

Objects of inheriting classes implement a FileVisitor, the method FileVisitor.visit(File) of which asks a question on the file or directory visited. Inheriting classes are FileVisitor.AskConsImpl and FileVisitor.AskGrafImpl.

© Copyright 2004 Albrecht Weinert.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.io.FileVisitor

FileVisitor.Ask, FileVisitor.AskConsImpl, FileVisitor.AskGrafImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ansPrompt Appendix to the question respectively answer suggestions.
protected String	append Text for middle button.
protected String	askPatt The question.
boolean	deleteMode Delete mode.
protected String	lower Lower line / explanation.
int	maxWait Maximum wait time for user response in 1/10 s.
protected String	no Text for right (reject) button.
protected String	yes Text for left (acknowledge) button.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Ask(boolean deleteMode, PropMap prop) Make an Ask object (sole constructor).

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose the Ask object.
int	set(PropMap prop) Set by a PropMap.
int	set(PropMap prop1, PropMap prop2) Set by (two) PropMaps.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.io.FileVisitor

visit

Field Detail

deleteMode

public final boolean deleteMode

Delete mode.

Delete mode means displaying / offering only two not three possible answers to the user as well as switching some property keys.

askPatt

protected String askPatt

The question.

askPatt is a one line pattern for the message formatter TextHelper.messageFormat(StringBuilder, CharSequence, Object). The spot {0} will be replaced by the file path.

Example:
"{0} löschen ?" (German) or
"Delete {0} ?" (English)

When setting from a PropMap or AppLangMap the key used is "faskpatt". That (nationalised) message pattern can, of course be used elsewhere.

ansPrompt

protected String ansPrompt

Appendix to the question respectively answer suggestions.

ansPrompt is to be shown as second line in a window respectively as not RET/LF terminated prompt in the console case.
It will be used as is (it no message format pattern).

When setting from a PropMap or AppLangMap the key used is either "faskpmt" or "daskpmt" for deleteMode false / true.

lower

protected String lower

Lower line / explanation.

Shall be shown as lower line in case of window.

When setting from a PropMap or AppLangMap the key used is either "fasklow" or "dasklow" for deleteMode false / true.

yes

protected String yes

Text for left (acknowledge) button.

Property key (deleteMode false) : "faskyes"
respectively (true) "daskyes".

no

protected String no

Text for right (reject) button.

Property key : "faskno"

append

protected String append

Text for middle button.

The middle button is intended for the "append" answer.
The button (in case of graphical implementation) shall only be displayed if the text here is not empty.

Property key (deleteMode false) : "faskappquot;
If deleteMode is true append is forced to null.

maxWait

public int maxWait

Maximum wait time for user response in 1/10 s.

A value < 0 means unlimited waiting / blocking.
A value < 50 (5 seconds) is to short for most humans to give a sound answer. It should be raised to 50.

default: 180 (= 18s)

Constructor Detail

Ask

protected Ask(boolean deleteMode,
              PropMap prop)

Make an Ask object (sole constructor).

This constructor forces inheriting classes (respectively their constructors) to finally determine the deleteMode before.
Additionally a PropMap may be provided to set all properties on construction.

Method Detail

set

public int set(PropMap prop1,
               PropMap prop2)

Set by (two) PropMaps.

The properties of this object will be set by those of prop1 and as substitute prop2. Find the keys in the documentation of the object variables.

Returns:

number of the set properties; -1, if prop1 is null

See Also:

set(PropMap)

set

public int set(PropMap prop)

Set by a PropMap.

The properties of this object will be set by those of prop and as substitute by that of an AppLangMap object determined by the rules of the Prop.valueLang(CharSequence).

Find the keys in the documentation of the object variables.

Returns:

number of the set properties; -1, if prop1 is null

See Also:

* Schlüssel siehe in den Einzelbeschreibungen der Variablen.
, set(PropMap, PropMap), AppLangMap.getMap(CharSequence), PropMap.getLanguage()

dispose

public void dispose()

Dispose the Ask object.

This method shall free all resources of this Ask object. It shall be called by the application when using this Ask object the last time.

This implementation does nothing.