cern::laser::guiplatform::category::CategoryBean Class Reference

Inheritance diagram for cern::laser::guiplatform::category::CategoryBean:
Inheritance graph
[legend]
Collaboration diagram for cern::laser::guiplatform::category::CategoryBean:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CategoryBean (Category category)
void setSelected (boolean flag)
boolean isSelected ()
void setChildrenSelectionState (int state)
int getChildrenSelectionState ()
Category getCategory ()
java.awt.Image getNodeIcon ()
String getName ()
String getPath ()
String getDisplayName ()
Integer getCategoryId ()
String getShortDescription ()
String[] getNodeActions ()
String getNodeDefaultAction ()
Object clone () throws CloneNotSupportedException
void setCloned ()
PropertyInfo[] getPropertyInfo ()

Static Public Attributes

static final int STATE_CHILDREN_NOT_SELECTED = 1
static final int STATE_CHILDREN_PARTIALY_SELECTED = 2
static final int STATE_CHILDREN_ALL_SELECTED = 3

Static Package Attributes

static Logger logger = LogFactory.getLogger(CategoryBean.class.getName())

Private Attributes

Category category = null
boolean isCloned = false
int childrenSelectionState = STATE_CHILDREN_NOT_SELECTED
boolean isSelected = false

Static Private Attributes

static final String[] nodeActions
static final String[] clonedNodeActions
static final String defaultNodeActionSelected = RemoveCategoryAction.class.getName()
static final String defaultNodeActionNotSelected = AddCategoryAction.class.getName()
static final String defaultClonedNodeAction = RemoveCategoryAction.class.getName()

Detailed Description

Author:
pawlowsk

Constructor & Destructor Documentation

cern::laser::guiplatform::category::CategoryBean::CategoryBean ( Category  category  )  [inline]

Creates a new instance of CategoryTest

Referenced by clone().

Member Function Documentation

Object cern::laser::guiplatform::category::CategoryBean::clone (  )  throws CloneNotSupportedException [inline]

from Cloneable interface

References category, CategoryBean(), and setCloned().

Category cern::laser::guiplatform::category::CategoryBean::getCategory (  )  [inline]

References category.

Referenced by cern::laser::guiplatform::windows::search::CategorySelectorWindow::getChoosenCategories().

Integer cern::laser::guiplatform::category::CategoryBean::getCategoryId (  )  [inline]

References category, and cern::laser::client::data::Category::getCategoryId().

Referenced by cern::laser::guiplatform::actions::category::ShowAlarmByCategoryAction::performAction().

int cern::laser::guiplatform::category::CategoryBean::getChildrenSelectionState (  )  [inline]

References childrenSelectionState.

Referenced by getNodeIcon().

String cern::laser::guiplatform::category::CategoryBean::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 category, and cern::laser::client::data::Category::getName().

String cern::laser::guiplatform::category::CategoryBean::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 category, and cern::laser::client::data::Category::getName().

String [] cern::laser::guiplatform::category::CategoryBean::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 clonedNodeActions, isCloned, and nodeActions.

String cern::laser::guiplatform::category::CategoryBean::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 defaultClonedNodeAction, defaultNodeActionNotSelected, defaultNodeActionSelected, isCloned, and isSelected().

java.awt.Image cern::laser::guiplatform::category::CategoryBean::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 getChildrenSelectionState(), isCloned, isSelected(), STATE_CHILDREN_ALL_SELECTED, STATE_CHILDREN_NOT_SELECTED, and STATE_CHILDREN_PARTIALY_SELECTED.

Referenced by setChildrenSelectionState(), and setSelected().

String cern::laser::guiplatform::category::CategoryBean::getPath (  )  [inline]

References category, and cern::laser::client::data::Category::getPath().

Referenced by cern::laser::guiplatform::actions::category::ShowAlarmByCategoryAction::performAction().

PropertyInfo [] cern::laser::guiplatform::category::CategoryBean::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::category::CategoryBean::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.

References category, and cern::laser::client::data::Category::getDescription().

boolean cern::laser::guiplatform::category::CategoryBean::isSelected (  )  [inline]

Referenced by getNodeDefaultAction(), getNodeIcon(), and setSelected().

void cern::laser::guiplatform::category::CategoryBean::setChildrenSelectionState ( int  state  )  [inline]

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

Referenced by cern::laser::guiplatform::windows::category::ChooseCategoryPanel::updateState().

void cern::laser::guiplatform::category::CategoryBean::setCloned (  )  [inline]

References isCloned.

Referenced by clone(), cern::laser::guiplatform::windows::category::ChoosenCategoryExplorer::ChoosenCategoryNodeManager::initChildrenMap(), and cern::laser::guiplatform::windows::category::ChoosenCategoryExplorer::updateChoosenCategories().

void cern::laser::guiplatform::category::CategoryBean::setSelected ( boolean  flag  )  [inline]

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

Referenced by cern::laser::guiplatform::windows::category::ChooseCategoryPanel::updateSelection().

Member Data Documentation

Category cern::laser::guiplatform::category::CategoryBean::category = null [private]

category

Referenced by clone(), getCategory(), getCategoryId(), getDisplayName(), getName(), getPath(), and getShortDescription().

int cern::laser::guiplatform::category::CategoryBean::childrenSelectionState = STATE_CHILDREN_NOT_SELECTED [private]

Referenced by getChildrenSelectionState(), and setChildrenSelectionState().

final String [] cern::laser::guiplatform::category::CategoryBean::clonedNodeActions [static, private]
Initial value:
 new String[] {          
                    DeleteChoosenCategoryAction.class.getName(),
                    DeleteAllChoosenCategoryAction.class.getName(),
                    null,
                    ShowAlarmByCategoryAction.class.getName(), }

Referenced by getNodeActions().

final String cern::laser::guiplatform::category::CategoryBean::defaultClonedNodeAction = RemoveCategoryAction.class.getName() [static, private]

Referenced by getNodeDefaultAction().

final String cern::laser::guiplatform::category::CategoryBean::defaultNodeActionNotSelected = AddCategoryAction.class.getName() [static, private]

Referenced by getNodeDefaultAction().

final String cern::laser::guiplatform::category::CategoryBean::defaultNodeActionSelected = RemoveCategoryAction.class.getName() [static, private]

Referenced by getNodeDefaultAction().

boolean cern::laser::guiplatform::category::CategoryBean::isCloned = false [private]

indicates that this bean is cloned or not

Referenced by getNodeActions(), getNodeDefaultAction(), getNodeIcon(), and setCloned().

boolean cern::laser::guiplatform::category::CategoryBean::isSelected = false [private]

Referenced by cern::laser::guiplatform::windows::category::ChooseCategoryPanel::updateState().

Logger cern::laser::guiplatform::category::CategoryBean::logger = LogFactory.getLogger(CategoryBean.class.getName()) [static, package]

logger

final String [] cern::laser::guiplatform::category::CategoryBean::nodeActions [static, private]
Initial value:
 new String[] {       
                    AddCategoryAction.class.getName(),
                    AddSubCategoriesAction.class.getName(),
                    null,
                    RemoveCategoryAction.class.getName(),
                    RemoveSubCategoriesAction.class.getName(),
                    null,
                    ShowAlarmByCategoryAction.class.getName(), }

Referenced by getNodeActions().

final int cern::laser::guiplatform::category::CategoryBean::STATE_CHILDREN_ALL_SELECTED = 3 [static]

Referenced by getNodeIcon().

final int cern::laser::guiplatform::category::CategoryBean::STATE_CHILDREN_NOT_SELECTED = 1 [static]

Referenced by getNodeIcon().

final int cern::laser::guiplatform::category::CategoryBean::STATE_CHILDREN_PARTIALY_SELECTED = 2 [static]

Referenced by getNodeIcon().

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