Class PropCnrEditorProperties


  • public class PropCnrEditorProperties
    extends java.lang.Object
    The definition of the properties to edit for a property component.
    Author:
    Christopher Mindus
    • Constructor Detail

      • PropCnrEditorProperties

        public PropCnrEditorProperties​(PropertyEditorSetup pes,
                                       java.lang.Object[] setup)
        Creates the instance of the EditProperties for a property component.
        Parameters:
        pes - The setup data for the Designer or the Plug-in.
        setup - This array contains the name of the property followed by a "required flag".
      • PropCnrEditorProperties

        public PropCnrEditorProperties​(PropertyEditorSetup pes,
                                       java.lang.Object[] setup,
                                       java.lang.String itemAppender)
        Creates the instance of the EditProperties for a property component.
        Parameters:
        pes - The setup data for the Designer or the Plug-in.
        setup - This array contains the name of the property followed by a "required flag".
      • PropCnrEditorProperties

        public PropCnrEditorProperties​(PropCnrEditorProperties existing,
                                       java.lang.Object[] setup)
        Creates the instance of the EditProperties for a property component from an existing definition that can receive additional setup.
        Parameters:
        existing - An existing instance to add new data to.
      • PropCnrEditorProperties

        public PropCnrEditorProperties​(PropCnrEditorProperties existing,
                                       boolean useGroupButtons)
        Creates the instance of the EditProperties for a property component from an existing definition that can receive additional setup.
        Parameters:
        existing - An existing instance to add new data to.
        useGroupButtons - Flag to use group buttons or not.
    • Method Detail

      • getOriginalSetup

        public java.lang.Object[] getOriginalSetup()
        Returns the original setup data.
        Returns:
        The original setup data, null if not present.
      • useGroupButtons

        public boolean useGroupButtons()
        Gets the flag for group buttons.
      • setUseGroupButtons

        public void setUseGroupButtons​(boolean on)
        Sets the flag for group buttons.
      • getPropertyEditorInfos

        public java.util.ArrayList<PropertyEditorInfo> getPropertyEditorInfos​(PropCnr pc)
        Gets the PropertyEditorInfo array for the property editor for a single property.
      • getPropertyEditorInfo

        public PropertyEditorInfo getPropertyEditorInfo​(Atom atom)
        Gets a PropertyEditorInfo from a property Atom.
        Parameters:
        atom - The atom.
        Returns:
        An instance of PropertyEditorInfo if the atom is found, null otherwise.
      • getEmptySettingsMessage

        public java.lang.String getEmptySettingsMessage​(PropCnr property)
        When the group is not editable, this message is shown.
      • getEmptySettingsImage

        public org.eclipse.swt.graphics.Image getEmptySettingsImage​(PropCnr property)
        When the group is not editable, this image is shown.
        Returns:
        null for none.