berry::RadioState Class Reference

#include <berryRadioState.h>

Inheritance diagram for berry::RadioState:

Collaboration diagram for berry::RadioState:

Public Member Functions
	RadioState ()
void	SetInitializationData (const SmartPointer< IConfigurationElement > &config, const QString &propertyName, const Object::Pointer &data) override
void	Load (const mitk::IPreferences *store, const std::string &preferenceKey) override
void	Save (mitk::IPreferences *store, const std::string &preferenceKey) override
void	SetValue (const Object::Pointer &value) override
Public Member Functions inherited from berry::IExecutableExtension
virtual	~IExecutableExtension ()

Static Public Attributes
static const QString	STATE_ID
static const QString	PARAMETER_ID

Detailed Description

This state supports a radio-button like command, where the value of the parameterized command is stored as state. The command must define a state using the STATE_ID id and a string commandParameter using the PARAMETER_ID id. Menu contributions supplied by org.eclipse.ui.menus can then set the PARAMETER_ID.

When parsing from the registry, this state understands two parameters: default, which is the default value for this item; and persisted, which is whether the state should be persisted between sessions. The default parameter has no default value and must be specified in one of its forms, and the persisted parameter defaults to true. If only one parameter is passed (i.e., using the class name followed by a colon), then it is assumed to be the default parameter.

See also

HandlerUtil::updateRadioState(org.eclipse.core.commands.Command, String)

HandlerUtil::matchesRadioState(org.eclipse.core.commands.ExecutionEvent)

Definition at line 41 of file berryRadioState.h.

Constructor & Destructor Documentation

RadioState()

berry::RadioState::RadioState

(

)

Member Function Documentation

Load()

void berry::RadioState::Load ( const mitk::IPreferences *  store, const std::string &  preferenceKey  )

override

Save()

void berry::RadioState::Save ( mitk::IPreferences *  store, const std::string &  preferenceKey  )

override

SetInitializationData()

void berry::RadioState::SetInitializationData ( const SmartPointer< IConfigurationElement > &  config, const QString &  propertyName, const Object::Pointer &  data  )

overridevirtual

This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.

Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example

    <action run="com.example.BaseAction"/>

In the above example, this method would be called with a reference to the <action> element (first argument), and "run" as the name of the attribute that defined this executable extension (second argument).

The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.

There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:

(1) by specifying adapter data as part of the implementation class attribute value. The Java class name can be followed by a ":" separator, followed by any adapter data in string form. For example, if the extension point specifies an attribute "run" to contain the name of the extension implementation, an adapter can be configured as

<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>

(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become

<action>
  <run class="com.xyz.ExternalAdapter">
    <parameter name="exec" value="./cmds/util.exe"/>
    <parameter name="opt"  value="3"/>
  </run>
</action>

Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.

In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:

• null, if no adapter data was supplied
• in case (1), the initialization data string is passed as a String
• in case (2), the initialization data is passed as a Hashtable containing the actual parameter names and values (both Strings)

Parameters

config	the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration properties
propertyName	the name of an attribute of the configuration element used on the createExecutableExtension(String) call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.
data	adapter data in the form of a String, a Hashtable, or null.

Exceptions

CoreException

if error(s) detected during initialization processing

See also

IConfigurationElement::createExecutableExtension

Implements berry::IExecutableExtension.

SetValue()

void berry::RadioState::SetValue ( const Object::Pointer &  value )

override

Member Data Documentation

PARAMETER_ID

const QString berry::RadioState::PARAMETER_ID

static

The parameter ID for a radio state understood by the system.

Definition at line 54 of file berryRadioState.h.

STATE_ID

const QString berry::RadioState::STATE_ID

static

The state ID for a radio state understood by the system.

Definition at line 49 of file berryRadioState.h.

---

The documentation for this class was generated from the following file:

• berryRadioState.h