com.ibm.commerce.tools.common.ui

Class DynamicTreeIconType

  • java.lang.Object
    • com.ibm.commerce.tools.common.ui.DynamicTreeIconType

  • public class DynamicTreeIconType
extends java.lang.Object
    Creates an icon type to be matched in DynamicTreeNode.iconType.

    An icon type can contain many icons. When a DynamicTreeNode.iconType matches a DynamicTreeIconType.iconType, the icon(s) specified in icons is displayed in front of this DynamicTreeNode in the client browser tree.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Constructor Summary

      Constructors 
      Constructor and Description
      DynamicTreeIconType()
      Default constructor.
      DynamicTreeIconType(java.lang.String iconType, com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] icons)
      Creates a new DynamicTreeIconType object loaded with an iconType and a list of DynamicTreeIcon objects.
      DynamicTreeIconType(java.lang.String iconType, java.lang.String icons)
      Creates a new DynamicTreeIconType object loaded with an iconType and a list of icon image values.
      DynamicTreeIconType(java.lang.String iconType, java.lang.String[] icons)
      Deprecated. 
      This method is replaced by DynamicTreeIconType(String, DynamicTreeIcon[])

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] getDynamicTreeIcons()
      Returns the icons field.
      java.lang.String[] getIcons()
      Deprecated. 
      This method is replaced by getDynamicTreeIcons()
      java.lang.String getIconType()
      Returns the icon type field.
      void iconToJS(java.lang.StringBuffer sb, int i)
      Converts the icons field to JavaScript.
      void setIcons(com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] newIcons)
      Sets the icons field
      void setIcons(java.lang.String[] newIcons)
      Deprecated. 
      This method is replaced by setIcons(DynamicTreeIcon[])
      void setIconType(java.lang.String newIconType)
      Sets the iconType field

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DynamicTreeIconType

        public DynamicTreeIconType()
        Default constructor.

      • DynamicTreeIconType

        public DynamicTreeIconType(java.lang.String iconType,
                           java.lang.String[] icons)
        Deprecated. This method is replaced by DynamicTreeIconType(String, DynamicTreeIcon[])
        Creates a new DynamicTreeIconType object loaded with an iconType and a list of icon image values.
        Parameters:
        iconType - the name of the icon type
        icons - an array of icon image files qualified from /web/images/tools/

      • DynamicTreeIconType

        public DynamicTreeIconType(java.lang.String iconType,
                           com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] icons)
        Creates a new DynamicTreeIconType object loaded with an iconType and a list of DynamicTreeIcon objects.
        Parameters:
        iconType - the name of the icon type
        icons - an array of DynamicTreeIcon objects

      • DynamicTreeIconType

        public DynamicTreeIconType(java.lang.String iconType,
                           java.lang.String icons)
        Creates a new DynamicTreeIconType object loaded with an iconType and a list of icon image values.
        Parameters:
        iconType - The name of this DynamicTreeIconType.
        icons - The icon image file qualified from /web/images/tools/ if relative path is used. This value is converted into an array and put into the icons field.

    • Method Detail

      • getIcons

        public java.lang.String[] getIcons()
        Deprecated. This method is replaced by getDynamicTreeIcons()
        Returns the icons field.
        Returns:
        the icons field.

      • getDynamicTreeIcons

        public com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] getDynamicTreeIcons()
        Returns the icons field.
        Returns:
        the icons field.

      • getIconType

        public java.lang.String getIconType()
        Returns the icon type field.
        Returns:
        the icon type field.

      • iconToJS

        public void iconToJS(java.lang.StringBuffer sb,
                     int i)
        Converts the icons field to JavaScript.

      • setIcons

        public void setIcons(java.lang.String[] newIcons)
        Deprecated. This method is replaced by setIcons(DynamicTreeIcon[])
        Sets the icons field
        Parameters:
        newIcons - An array of icon image paths qualified by /web/images/tools/. New Strings are created for each element in case a reference was passed.

      • setIcons

        public void setIcons(com.ibm.commerce.tools.common.ui.DynamicTreeIcon[] newIcons)
        Sets the icons field
        Parameters:
        newIcons - An array of icon image paths qualified by /web/images/tools/. New Strings are created for each element in case a reference was passed.

      • setIconType

        public void setIconType(java.lang.String newIconType)
        Sets the iconType field
        Parameters:
        newIconType - The iconType.
Skip navigation links