org.kde.koala
Class KSimpleFileFilter

java.lang.Object
  org.kde.koala.KFileFilter
      org.kde.koala.KSimpleFileFilter

All Implemented Interfaces:

org.kde.qt.QtSupport

public class KSimpleFileFilter
extends KFileFilter

A simple file filter that can filter hidden dot files, by name, by mime type and by mode.

Constructor Summary

	KSimpleFileFilter() Creates a new filter.
protected	KSimpleFileFilter(java.lang.Class dummy)

Method Summary

void	dispose() Delete the wrapped C++ instance ahead of finalize()
boolean	filterDotFiles() Checks whether filtering dot files is enabled.
boolean	filterSpecials() Checks whether it filters "." and "..", default is true.
protected void	finalize() Deletes the wrapped C++ instance
boolean	isDisposed() Has the wrapped C++ instance been deleted?
java.util.ArrayList	mimeFilters() Returns the list of mime types.
long	modeFilter() Returns the mode filter, as set by setModeFilter().
boolean	passesFilter(KFileItem item) Checks the given item.
void	setFilterDotFiles(boolean filter) Enable or disable filtering hidden dot files.
void	setFilterSpecials(boolean filter) Filters "." and "..", default is true.
void	setMimeFilters(java.lang.String[] mimeFilters) Sets a list of mime filters.
void	setModeFilter(long mode) Sets the mode filter.
void	setNameFilters(java.lang.String nameFilters) Sets a list of regular expressions to filter by name.
void	setNameFilters(java.lang.String nameFilters, boolean caseSensitive)
void	setNameFilters(java.lang.String nameFilters, boolean caseSensitive, char separator) Sets a list of regular expressions to filter by name.

Methods inherited from class java.lang.Object

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

Constructor Detail

KSimpleFileFilter

protected KSimpleFileFilter(java.lang.Class dummy)

KSimpleFileFilter

public KSimpleFileFilter()

Creates a new filter. By default, it filters only hidden dot files and "." and "..".

Method Detail

setFilterDotFiles

public void setFilterDotFiles(boolean filter)

Enable or disable filtering hidden dot files. This option is enabled by default.

Parameters:

filter - true to enable filtering dot files, false to disable

See Also:

filterDotFiles()

filterDotFiles

public boolean filterDotFiles()

Checks whether filtering dot files is enabled. This option is enabled by default.

Returns:

true if filtering is enabled, false otherwise

See Also:

setFilterDotFiles(boolean)

setFilterSpecials

public void setFilterSpecials(boolean filter)

Filters "." and "..", default is true.

Parameters:

filter - true to enable, false otherwise

filterSpecials

public boolean filterSpecials()

Checks whether it filters "." and "..", default is true.

Returns:

true if enabled, false otherwise

setNameFilters

public void setNameFilters(java.lang.String nameFilters,
                           boolean caseSensitive,
                           char separator)

Sets a list of regular expressions to filter by name. The file will only pass if its name matches one of the regular expressions.

Parameters:

nameFilters - a list of regular expressions, separated by the character separator

caseSensitive - if true, matches case sensitive. False otherwise

separator - the separator in the nameFilter

setNameFilters

public void setNameFilters(java.lang.String nameFilters,
                           boolean caseSensitive)

setNameFilters

public void setNameFilters(java.lang.String nameFilters)

Sets a list of regular expressions to filter by name. The file will only pass if its name matches one of the regular expressions.

Parameters:

nameFilters - a list of regular expressions, separated by space (' ')

setMimeFilters

public void setMimeFilters(java.lang.String[] mimeFilters)

Sets a list of mime filters. A file can only pass if its mime type is contained in this list.

Parameters:

mimeFilters - the list of mime types

See Also:

#setMimeFilter

mimeFilters

public java.util.ArrayList mimeFilters()

Returns the list of mime types.

Returns:

the list of mime types

See Also:

#mimeFilter

setModeFilter

public void setModeFilter(long mode)

Sets the mode filter. If the mode is 0, the filter is disabled. When enabled, a file will only pass if the files mode ANDed with mode is not zero.

Parameters:

mode - the new mode. 0 to disable

See Also:

modeFilter()

modeFilter

public long modeFilter()

Returns the mode filter, as set by setModeFilter().

Returns:

the mode filter, 0 if disabled

See Also:

setModeFilter(long)

passesFilter

public boolean passesFilter(KFileItem item)

Checks the given item.

Overrides:

passesFilter in class KFileFilter

Parameters:

item - the item to filter

Returns:

true if the item passes the filter, false otherwise

finalize

protected void finalize()
                 throws java.lang.InternalError

Deletes the wrapped C++ instance

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.InternalError

dispose

public void dispose()

Delete the wrapped C++ instance ahead of finalize()

isDisposed

public boolean isDisposed()

Has the wrapped C++ instance been deleted?