cern::laser::guiplatform::beans::DisplayColumnBean Class Reference

Inheritance diagram for cern::laser::guiplatform::beans::DisplayColumnBean:

Collaboration diagram for cern::laser::guiplatform::beans::DisplayColumnBean:

Public Member Functions
	DisplayColumnBean (String propName, String displayName, String iconPath, boolean enabled)
	DisplayColumnBean ()
String	getName ()
boolean	isEnabled ()
java.awt.Image	getNodeIcon ()
cern.gp.beans.PropertyInfo[]	getPropertyInfo ()
String	getDisplayName ()
String	getNodeDefaultAction ()
String[]	getNodeActions ()
String	getShortDescription ()
void	disable ()
void	enable ()
Protected Member Functions
java.awt.Image	getNodeIconFromPathname (String newPathname)
Package Attributes
boolean	enabled = false
Static Package Attributes
static Logger	logger
Private Attributes
String	name = null
String	displayName = null
String	iconPath = null
Static Private Attributes
static final String	defaultNodeAction
static final String[]	nodeActions

Detailed Description

Author:: pawlowsk

Constructor & Destructor Documentation

cern::laser::guiplatform::beans::DisplayColumnBean::DisplayColumnBean	(	String	propName,
		String	displayName,
		String	iconPath,
		boolean	enabled
	)			`[inline]`

Creates a new instance of DisplayColumnBean

Parameters:

	propName	property name
	displayName	property display name
	iconPath	icon path
	enabled	if column is enabled

References name.

cern::laser::guiplatform::beans::DisplayColumnBean::DisplayColumnBean ( ) [inline]

This constructor should be used only with setRootNode method

Member Function Documentation

void cern::laser::guiplatform::beans::DisplayColumnBean::disable ( ) [inline]

tell the object that implements this nterfaces to be disabled

Implements cern::laser::guiplatform::capabilities::DisableCapability.

References enabled, cern::gp::beans::BeanSupport::fireNodeIconPropertyChange(), iconPath, logger, and name.

void cern::laser::guiplatform::beans::DisplayColumnBean::enable ( ) [inline]

tell the object that implements this nterfaces to be enabled

Implements cern::laser::guiplatform::capabilities::EnableCapability.

References enabled, cern::gp::beans::BeanSupport::fireNodeIconPropertyChange(), iconPath, logger, and name.

String cern::laser::guiplatform::beans::DisplayColumnBean::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 displayName.

String cern::laser::guiplatform::beans::DisplayColumnBean::getName ( ) [inline]

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

Property name : name
Visibility : normal (visible in a property sheet)
Default value (when null is returned from this method) : a unique name generated using BeanUtils. generateUniqueBeanName()

Returns:: the internal name of the associated bean or null.

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

References name.

Referenced by cern::laser::guiplatform::windows::DisplayableColumnExplorer::DisplayableColumnNodeManager::getEnabledColumns().

String [] cern::laser::guiplatform::beans::DisplayColumnBean::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.

References nodeActions.

String cern::laser::guiplatform::beans::DisplayColumnBean::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.

References defaultNodeAction.

java.awt.Image cern::laser::guiplatform::beans::DisplayColumnBean::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 getNodeIconFromPathname(), and iconPath.

java.awt.Image cern::laser::guiplatform::beans::DisplayColumnBean::getNodeIconFromPathname ( String newIconPathname ) [inline, protected]

Returns the icon image from the pathname of the icon.

The pathname should be relative to the package of this bean and be contained in the classpath. For instance if this bean is in cern.gp.beans and the icon is stored in cern/gp/beans/images/MyIcon.gif the pathname to give would be images/MyIcon.gif.

Parameters:

newIconPathname

The new value of the Icon pathname.

Returns:: the image defined by the icon pathname or null if it cannot be found or loaded.

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

Referenced by getNodeIcon().

cern.gp.beans.PropertyInfo [] cern::laser::guiplatform::beans::DisplayColumnBean::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::beans::DisplayColumnBean::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.

boolean cern::laser::guiplatform::beans::DisplayColumnBean::isEnabled ( ) [inline]

This method indicates whether this column is enabled

Returns:: true if columns is enabled false if not

References enabled.

Referenced by cern::laser::guiplatform::windows::DisplayableColumnExplorer::DisplayableColumnNodeManager::getEnabledColumns().

Member Data Documentation

final String cern::laser::guiplatform::beans::DisplayColumnBean::defaultNodeAction [static, private]

Initial value:

 
        cern.laser.guiplatform.actions.EnableColumnAction.class.getName()

defaultNodeAction

Referenced by getNodeDefaultAction().

String cern::laser::guiplatform::beans::DisplayColumnBean::displayName = null [private]

display name for property name

Referenced by getDisplayName().

boolean cern::laser::guiplatform::beans::DisplayColumnBean::enabled = false [package]

if column is enabled

Referenced by disable(), enable(), and isEnabled().

String cern::laser::guiplatform::beans::DisplayColumnBean::iconPath = null [private]

icon name

Referenced by disable(), enable(), and getNodeIcon().

Logger cern::laser::guiplatform::beans::DisplayColumnBean::logger [static, package]

Initial value:

        LogFactory.getLogger(DisplayColumnBean.class.getName())

Referenced by disable(), and enable().

String cern::laser::guiplatform::beans::DisplayColumnBean::name = null [private]

displayable column name (this is property name from DisplayableChangeEventAdapter

Referenced by disable(), DisplayColumnBean(), enable(), and getName().

final String [] cern::laser::guiplatform::beans::DisplayColumnBean::nodeActions [static, private]

Initial value:

 
        new String [] {
            cern.laser.guiplatform.actions.EnableColumnAction.class.getName(),
            cern.laser.guiplatform.actions.DisableColumnAction.class.getName(),
            cern.laser.guiplatform.actions.MoveUpConfChangeEventAction.class.getName(),
            cern.laser.guiplatform.actions.MoveDownConfChangeEventAction.class.getName()
        }

nodeActions

Referenced by getNodeActions().

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

DisplayColumnBean.java

cern::laser::guiplatform::beans::DisplayColumnBean Class Reference

Public Member Functions

Protected Member Functions

Package Attributes

Static Package Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation