Class PaletteEntryFactory

    • Constructor Detail

      • PaletteEntryFactory

        public PaletteEntryFactory()
    • Method Detail

      • createNewEntry

        public PaletteEntry createNewEntry​(Shell shell,
                                           PaletteEntry selected)
        This method is called when a new palette entry of the type supported by this PaletteEntryFactory is to be created.
        Parameters:
        shell - The Shell of the PaletteCustomizerDialog
        selected - The PaletteEntry that was selected in the outline when this action was launched. Will never be null .
        Returns:
        PaletteEntry The newly created PaletteEntry
      • createNewEntry

        protected abstract PaletteEntry createNewEntry​(Shell shell)
        Create the PaletteEntry
        Parameters:
        shell - The Shell of the PaletteCustomizerDialog; it can be used to create another warning or information dialog.
        Returns:
        The newly created entry
      • canCreate

        public boolean canCreate​(PaletteEntry selected)
        This method is called by the PaletteCustomizerDialog to determine whether to enable or disable this action on the toolbar and the context menu.

        This default implementation allows the creation of a new entry only in PaletteContainers with the following user permission: PERMISSION_FULL_MODIFICATION

        Parameters:
        selected - The selected PaletteEntry (Will never be null)
        Returns:
        true if, given the current selection, this PaletteEntryFactory can create a new PaletteEntry
      • determineContainerForNewEntry

        protected PaletteContainer determineContainerForNewEntry​(PaletteEntry selected)
        Given the current selection, this method determines the parent for the new entry to be created.

        Sub-classes may override this method.

        Parameters:
        selected - The selected entry
        Returns:
        The parent of the new entry to be created
      • determineTypeForNewEntry

        protected java.lang.Object determineTypeForNewEntry​(PaletteEntry selected)
        Given the current selection, this method determines the type of the new entry to be created.

        Sub-classes may override this method.

        Parameters:
        selected - The selected entry
        Returns:
        The type of the new entry to be created
      • determineIndexForNewEntry

        protected int determineIndexForNewEntry​(PaletteContainer c,
                                                PaletteEntry selected)
        Calculates the index at which the new entry is to be created, given the current selection.

        Sub-classes may override this method.

        Parameters:
        c - The parent container
        selected - The selected entry
        Returns:
        the index at which the new entry should be added in the given container (-1 indicates add at the end)
      • getImageDescriptor

        public ImageDescriptor getImageDescriptor()
        Returns:
        ImageDescriptor used to create the image to represent this factory
      • getLabel

        public java.lang.String getLabel()
        Returns:
        This factory's name
      • setImageDescriptor

        public void setImageDescriptor​(ImageDescriptor imgDesc)
        Sets the ImageDescriptor used to create the image to represent this factory
        Parameters:
        imgDesc - The new ImageDescriptor
      • setLabel

        public void setLabel​(java.lang.String newLabel)
        Sets this factory's name. It will be used to list this factory in the toolbar, context menu, etc.
        Parameters:
        newLabel - The new name for this factory