org.openbp.jaspira.option
Class PathOption

java.lang.Object
  org.openbp.common.generic.description.DescriptionObjectImpl
      org.openbp.common.generic.description.DisplayObjectImpl
          org.openbp.jaspira.option.Option
              org.openbp.jaspira.option.StringOption
                  org.openbp.jaspira.option.PathOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.swing.tree.TreeNode, Copyable, DescriptionObject, Displayable, DisplayObject, Validatable

public class PathOption
extends StringOption

A path option holds a file or directory path. Its ui supports choosing the path using a file chooser dialog.

Author:

Jens Ferchland

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openbp.jaspira.option.Option

DFLT_PRIORITY, priorityComparator, PROPERTY_CONDITION, PROPERTY_HEADING, PROPERTY_ICON, PROPERTY_OPTION_PARENT, PROPERTY_PRIO, PROPERTY_TYPE, TYPE_GROUP, TYPE_OPTION, TYPE_SUB_GROUP

Fields inherited from interface org.openbp.common.generic.Copyable

COPY_DEEP, COPY_FIRST_LEVEL, COPY_SHALLOW

Constructor Summary

PathOption(ResourceCollection res, java.lang.String optionName, java.lang.String defaultValue, javax.swing.filechooser.FileFilter filter, boolean dirSelection)
Resource constructor.

PathOption(java.lang.String optionName, java.lang.String displayName, java.lang.String description, java.lang.String defaultValue, Option parent, int prio, javax.swing.filechooser.FileFilter filter, boolean dirSelection)
Value constructor.

Method Summary

OptionWidget

createOptionWidget() Returns the widget for this option.

Methods inherited from class org.openbp.jaspira.option.StringOption

loadFromString, saveToString

Methods inherited from class org.openbp.jaspira.option.Option

addOptionChild, children, getAllowsChildren, getCachedOptionWidget, getChildAt, getChildCount, getCondition, getDefaultValue, getHeading, getIcon, getIndex, getOptionChildren, getParent, getPriority, getType, getValue, install, isLeaf, loadOptionValue, removeOptionChild, resetCachedOptionWidget, saveOptionValue, setValue, toString, uninstall

Methods inherited from class org.openbp.common.generic.description.DisplayObjectImpl

copyFrom, getDisplayName, getDisplayText, setDisplayName

Methods inherited from class org.openbp.common.generic.description.DescriptionObjectImpl

clone, compareTo, getDescription, getDescriptionEscape, getDescriptionText, getName, setDescription, setDescriptionEscape, setName, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbp.common.generic.description.DescriptionObject

clone, getDescription, getDescriptionText, getName, setDescription, setName

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

PathOption

public PathOption(ResourceCollection res,
                  java.lang.String optionName,
                  java.lang.String defaultValue,
                  javax.swing.filechooser.FileFilter filter,
                  boolean dirSelection)

Resource constructor.

Parameters:

res - Resource defining the option

optionName - Name of the option

defaultValue - Default Value of the option

filter - File name filter for the file selection dialog

dirSelection - true Select directories
false Select regular files

PathOption

public PathOption(java.lang.String optionName,
                  java.lang.String displayName,
                  java.lang.String description,
                  java.lang.String defaultValue,
                  Option parent,
                  int prio,
                  javax.swing.filechooser.FileFilter filter,
                  boolean dirSelection)

Value constructor.

Parameters:

optionName - Name of the option

displayName - Display name of the option

description - Description of the option

defaultValue - Default Value of the option

parent - Option parent or null

prio - Priority of the option

filter - File name filter for the file selection dialog

dirSelection - true Select directories
false Select regular files

Method Detail

createOptionWidget

public OptionWidget createOptionWidget()

Description copied from class: Option

Returns the widget for this option.

Overrides:

createOptionWidget in class StringOption

Returns:

The widget

See Also:

Option.createOptionWidget()