com.highqsoft.odsx.command

Class OdsxATFFilterCommand

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkCommand

com.highqsoft.odsx.command.OdsxATFFilterCommand

All Implemented Interfaces:

FwkCommandInterface, FwkControlledByInterface, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable

public class OdsxATFFilterCommand
extends FwkCommand

The atf filter editor command.
The CommandName is CreateATF.

This command uses ASCOBA to create the ATF file.
The environment variable ASCOBA_INI must be available.
The command find the right service via the type definition of the service. There are three possible entries.

• ATF-ASCII to write a plain ascii ATF file.
• ATF-BLOCK to write a block binary ATF file.
• ATF-CHANNEL to write a channel binary ATF file.

It will use the property listed below

Property Keyword	Datatype	Default	Description
OdsxATFFilter.Text.Create	String	OdsxATFFilter.Text.Create	The text key for the command.
Icon.ATF_Save	String	com/highqsoft/fwk/images/ATF_Save.gif	The icon for the command.
OdsxSessionFactory.ATF.Directory	String	the home directory	The starting directory.
OdsxATFFilter.Text.NormalATF	String	OdsxATFFilter.Text.NormalATF	The text string for the radio button to save as ASCII ATF.
OdsxATFFilter.Text.BinBlock	String	OdsxATFFilter.Text.BinBlock	The text string for the radio button to save as CHANNEL mode ATF.
OdsxATFFilter.Text.BinChannel	String	OdsxATFFilter.Text.BinChannel	The text string for the radio button to save as CHANNEL mode ATF.
OdsxATFFilter.Text.BinChannel	String	OdsxATFFilter.Text.WithReference	The text string for the radio button to write the atf with reference.
OdsxATFFilter.Text.BinChannel	String	OdsxATFFilter.Text.Verbose	The text string for the radio button to write the atf verbose.
OdsxATFFilter.Text.BinChannel	String	OdsxATFFilter.Text.Verbose	The text string for the radio button to write the atf verbose.
OdsxATFFilter.ATF.WithRef	Boolean	true	This flag signals the object to call ascoba with the reference flag.
OdsxATFFilter.ATF.Verbose	Boolean	false	This flag signals the object to call ascoba with the verbose flag.
OdsxATFFilterCommand.ATF.Enabled	Boolean	false	Set this flag to have the ATF creation command in the popup menu of a tree element. Read the ATHOS and ASCOBA system documentation first!

Since:

$Date: 2017/04/06 13:29:50 $

Version:

$Revision: 1.17 $

Author:

Ulrich Bleicher

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OdsxATFFilterCommand.AtfSaveDialog
class	OdsxATFFilterCommand.ExecThread The execution thread.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkCommand

actionListeners, buttonClass, commandName, helpID, icon, iconKey, instruction, menuEventEnabled, menuItemClass, menuListeners, mnemonic, properties, radioGroupState, registry, sensitive, separator, text, textKey, toggle, toggleState, toolBarEnabled, toolTipKey, toolTipText, visible

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, ICON, iconCount, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
OdsxATFFilterCommand(FwkControllerInterface controller) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	commandAvailableForSession(OdsxSessionInterface session) Returns a boolean whether the command is usable for current session.
boolean	execute(java.util.EventObject ev) The executer method.
java.lang.String	getVersion() Return the version string of the FWK component.
static boolean	hasServices() Returns a boolean whether the command has usable services found.
protected java.lang.String	replaceFirstEscapeSeq(java.lang.String in, java.lang.String esc, java.lang.String rep, boolean enclose) The escape sequenz method.

Methods inherited from class com.highqsoft.fwk.FwkCommand

addActionListener, addCommand, addCommand, addMenuListener, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getActionListenerArray, getButtonClass, getCommand, getCommandName, getCommands, getController, getGroup, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getToolTipText, getVisibility, groupExists, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeCommand, removeFromGroup, removeMenuListener, setAsParent, setButtonClass, setCommandName, setCommands, setController, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, toString, unregister

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

OdsxATFFilterCommand

public OdsxATFFilterCommand(FwkControllerInterface controller)

The constructor.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkCommand

hasServices

public static boolean hasServices()

Returns a boolean whether the command has usable services found.

Returns:

true if there are usable services.

commandAvailableForSession

public static boolean commandAvailableForSession(OdsxSessionInterface session)

Returns a boolean whether the command is usable for current session.

Returns:

true if there are usable services.

replaceFirstEscapeSeq

protected java.lang.String replaceFirstEscapeSeq(java.lang.String in,
                                     java.lang.String esc,
                                     java.lang.String rep,
                                     boolean enclose)

The escape sequenz method. Replace the first escape sequenz with the replace string.

Parameters:

in - The default string.

esc - The escape sequenz.

rep - The too replace string.

enclose - Boolean, enclose rep string in "" if there is a blank in it.

Returns:

String The new string.

execute

public boolean execute(java.util.EventObject ev)

The executer method.

Specified by:

execute in interface FwkCommandInterface

Overrides:

execute in class FwkCommand

Parameters:

the - event.

Returns:

true if a listener was found that executes this command.