cern::laser::guiplatform::configuration::ConfigurationBean Class Reference

Inheritance diagram for cern::laser::guiplatform::configuration::ConfigurationBean:
Inheritance graph
[legend]
Collaboration diagram for cern::laser::guiplatform::configuration::ConfigurationBean:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ConfigurationBean (Configuration conf) throws LaserConsoleException
String getName ()
String getDisplayName ()
String[] getNodeActions ()
String getNodeDefaultAction ()
java.awt.Image getNodeIcon ()
cern.gp.beans.PropertyInfo[] getPropertyInfo ()
boolean getIsDefault ()
void setIsDefault (boolean flag)
String getShortDescription ()

Private Attributes

Configuration conf = null
String name = null
boolean isDefault = false

Static Private Attributes

static final Logger logger

Detailed Description

This is configuration bean (configuration wrapper)

Author:
pawlowsk

Constructor & Destructor Documentation

cern::laser::guiplatform::configuration::ConfigurationBean::ConfigurationBean ( Configuration  conf  )  throws LaserConsoleException [inline]

Creates a new instance of ConfigurationBean

In the future there shuold be only one constructor public ConfugurationBean(Configuration conf)

Configuration -- object which comes from business API

References conf, cern::laser::console::Configuration::getName(), cern::laser::console::Configuration::isDefault(), isDefault, and name.

Member Function Documentation

String cern::laser::guiplatform::configuration::ConfigurationBean::getDisplayName (  )  [inline]

Returns the internal display name of the associated bean. If null is returned a default name will be used.

  • Property name : displayName
  • Visibility : normal (visible in a property sheet)
  • Default value (when null is returned from this method) : if getName() is available it is used instead of getDisplayName(), else beanInfo.getBeanDescriptor().getDisplayName() is used
Returns:
the internal display name of the associated bean or null

Reimplemented from cern::gp::beans::BeanSupport.

References name.

boolean cern::laser::guiplatform::configuration::ConfigurationBean::getIsDefault (  )  [inline]

This matehod returns "isDefault" status for this configuration

Returns:
true if this configuration is default, otherwise false

References isDefault.

Referenced by cern::laser::guiplatform::windows::user::UserExplorer::UserNodeManager::findDefaultConfiguration(), and cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::performAction().

String cern::laser::guiplatform::configuration::ConfigurationBean::getName (  )  [inline]

only for testing Only for testing

Parameters:
name configuration name This constructor should be used only for testing
name conf name
isDefault shows whether this configuration is default configuration

Reimplemented from cern::gp::beans::BeanSupport.

References name.

Referenced by cern::laser::guiplatform::windows::user::UserExplorer::UserNodeManager::getConfigurationNames(), and cern::laser::guiplatform::windows::user::UserExplorer::ConfigurationNodeManger::initChildrenList().

String [] cern::laser::guiplatform::configuration::ConfigurationBean::getNodeActions (  )  [inline]

Returns an array of qualified name of actions for the node representing the associated bean. Null can be used in the array to represent a separator.

  • Property name : nodeActions
  • Visibility : hidden (not visible in a property sheet)
  • Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getActions(beanInfo.getBeanDescriptor())
Returns:
an array of qualified name of actions for a node representing the bean.

Reimplemented from cern::gp::beans::BeanSupport.

String cern::laser::guiplatform::configuration::ConfigurationBean::getNodeDefaultAction (  )  [inline]

Returns the qualified name of the default action for the node representing the associated bean. The default action is the one triggered when the user double-clic on the node. If null is returned a default default action will be used.

  • Property name : nodeDefaultAction
  • Visibility : hidden
  • Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getDefaultAction(beanInfo.getBeanDescriptor())
Returns:
the qualified name of the default action for the node or null representing the associated bean.

Reimplemented from cern::gp::beans::BeanSupport.

java.awt.Image cern::laser::guiplatform::configuration::ConfigurationBean::getNodeIcon (  )  [inline]

Returns the icon in 16x16 size used to display the node representing the associated bean. If null is returned a default icon will be used.

  • Property name : nodeIcon
  • Visibility : hidden (not visible in a property sheet)
  • Default value (when null is returned from this method) : beanInfo.getIcon()
Returns:
the icon in 16x16 size used to display the node representing the associated bean or null

Reimplemented from cern::gp::beans::BeanSupport.

References isDefault.

Referenced by setIsDefault().

cern.gp.beans.PropertyInfo [] cern::laser::guiplatform::configuration::ConfigurationBean::getPropertyInfo (  )  [inline]

Returns an array of PropertyInfo specifying information on some properties.

Each PropertyInfo of this array defines information for one property of this bean. Defining a PropertyInfo for a given property is usefull when there is no explicit BeanInfo for the bean and when the property have non default characteristics such as, for instance, a specific PropertyEditor.

  • Property name : propertyInfo
  • Visibility : hidden (not visible in a property sheet)
  • Default value (when null is returned from this method) : use PropertyDescriptors from BeanInfo
Returns:
true is the value of the properties can be cached in the node, false else or null for default behavior

Reimplemented from cern::gp::beans::BeanSupport.

String cern::laser::guiplatform::configuration::ConfigurationBean::getShortDescription (  )  [inline]

Returns a short description of the associated bean (used in tooltip for instance). If null is returned a default description will be used.

  • Property name : shortDescription
  • Visibility : normal (visible in a property sheet)
  • Default value (when null is returned from this method) : beanInfo.getBeanDescriptor(). getShortDescription()
Returns:
a short description of the associated bean or null

Reimplemented from cern::gp::beans::BeanSupport.

void cern::laser::guiplatform::configuration::ConfigurationBean::setIsDefault ( boolean  flag  )  [inline]

References cern::gp::beans::BeanSupport::fireNodeIconPropertyChange(), getNodeIcon(), and isDefault.

Referenced by cern::laser::guiplatform::windows::user::UserExplorer::UserNodeManager::addConfiguration(), and cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::performAction().

Member Data Documentation

Configuration cern::laser::guiplatform::configuration::ConfigurationBean::conf = null [private]

Referenced by ConfigurationBean().

boolean cern::laser::guiplatform::configuration::ConfigurationBean::isDefault = false [private]

if this configuration is default

Referenced by ConfigurationBean(), getIsDefault(), getNodeIcon(), and setIsDefault().

final Logger cern::laser::guiplatform::configuration::ConfigurationBean::logger [static, private]
Initial value:
 
        LogFactory.getLogger(ConfigurationBean.class.getName())
String cern::laser::guiplatform::configuration::ConfigurationBean::name = null [private]

configuration name

Referenced by ConfigurationBean(), getDisplayName(), and getName().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2