Uses of Class
ca.corbett.extras.properties.AbstractProperty
Packages that use AbstractProperty
Package
Description
Contains code that enables your applications to define dynamic extensions that can be
packaged into jar files and loaded at runtime to alter the behaviour of your application,
or even to supplement your application with additional behaviour.
Contains UI classes for the app-extensions code, most notably the ExtensionManagerDialog.
Contains utility classes related to audio handling (playback and recording).
Contains utilities and components related to image handling.
Contains the LogConsole and associated classes - useful for showing log information
for your Swing application at runtime.
Contains a custom Properties implementation to augment the one provided by java.
Contains the PropertiesDialog abstract class and its two supported implementations.
-
Uses of AbstractProperty in ca.corbett.extensions
Fields in ca.corbett.extensions with type parameters of type AbstractPropertyModifier and TypeFieldDescriptionprotected List<AbstractProperty> AppExtension.configPropertiesList of configuration properties for this extension.Methods in ca.corbett.extensions that return types with arguments of type AbstractPropertyModifier and TypeMethodDescriptionprotected abstract List<AbstractProperty> AppExtension.createConfigProperties()Extensions must implement this method to create and return a list of AbstractProperty instances representing the config for this extension.protected abstract List<AbstractProperty> AppProperties.createInternalProperties()Override this to specify whatever properties your application needs.ExtensionManager.getAllEnabledExtensionProperties()Invoke this to interrogate each enabled extension for their config properties, if any, and return them in a list.final List<AbstractProperty> AppExtension.getConfigProperties()Return a list of configuration properties for this extension. -
Uses of AbstractProperty in ca.corbett.extensions.ui
Method parameters in ca.corbett.extensions.ui with type arguments of type AbstractPropertyModifier and TypeMethodDescriptionprotected booleanExtensionDetailsPanel.hasVisibleProps(List<AbstractProperty> configProps) Returns true if the given list of properties is not null, not empty, and has at least one config property that is exposed to the user.ExtensionDetailsPanel.setConfigProperties(List<AbstractProperty> configProps) You can supply a list of configuration properties for the extension, in which case a hyperlink field will be shown to display a preview of those properties.protected voidExtensionDetailsPanel.showConfigPreview(List<AbstractProperty> configProps) Shows a read-only preview of the given properties list, with default values populated. -
Uses of AbstractProperty in ca.corbett.extras.audio
Subclasses of AbstractProperty in ca.corbett.extras.audioModifier and TypeClassDescriptionclassRepresents a preferences object that can be used with AudioUtil.generateWaveform(). -
Uses of AbstractProperty in ca.corbett.extras.image
Subclasses of AbstractProperty in ca.corbett.extras.imageModifier and TypeClassDescriptionclassRepresents configuration options for ImagePanel.final classRepresents a configuration preset for logo images, to be used with LogoGenerator. -
Uses of AbstractProperty in ca.corbett.extras.logging
Subclasses of AbstractProperty in ca.corbett.extras.loggingModifier and TypeClassDescriptionfinal classA LogConsoleTheme represents a set of LogConsoleStyle objects that can be applied within the LogConsole. -
Uses of AbstractProperty in ca.corbett.extras.properties
Subclasses of AbstractProperty in ca.corbett.extras.propertiesModifier and TypeClassDescriptionclassRepresents a property that can either be on or off.classWraps a ButtonField, and allows you to add buttons to a FormPanel dynamically.classThis property wraps an empty CollapsiblePanelField and allows you to add subfields dynamically to it when the property's FormField is created.classRepresents a property that can either be a solid colour, a gradient, or both.classRepresents a single-select chooser field that allows selection from a list of items.classRepresents a property that can store some floating point value.classRepresents a field that contains a directory name.classEnumProperty<T extends Enum<?>>Represents a multi-choice property, very similar to a ComboProperty, except that the options come from a supplied enum instead of a List of String values.classRepresents a property field to allow selection of a file.classRepresents a property field that allows storing a Font, along with associated style and optional color attributes.classRepresents an html label, which can have multiple hyperlinks with custom actions.classRepresents a property that can store some integer value.classA property implementation for storing KeyStroke values.classAn extremely simple property which represents a static label.classListProperty<T>Wraps a ListField to allow for a multi-select property.classRepresents an AbstractProperty wrapper around the ListSubset form field.classRepresents a property that can store a long text (multi-line) value.classclassAn AbstractProperty to wrap a Margins instance.classThis property wraps an empty PanelField and allows you to add subfields dynamically to it when the property's FormField is created.classA property to represent a password, which should by default be hidden in the UI.classclassFields in ca.corbett.extras.properties with type parameters of type AbstractPropertyModifier and TypeFieldDescriptionprotected final List<AbstractProperty> PropertiesManager.propertiesMethods in ca.corbett.extras.properties that return AbstractPropertyModifier and TypeMethodDescriptionAbstractProperty.addAllExtraAttributes(Map<String, Object> newAttributes) Adds the map of extra attributes to our existing list.AbstractProperty.addBottomPadding(int bottom) Will add the specified amount of bottom padding to the generated FormField's margins.AbstractProperty.addFormFieldChangeListener(PropertyFormFieldChangeListener listener) Register to receive a change notification when a generated FormField's value is changed by the user.AbstractProperty.addFormFieldGenerationListener(FormFieldGenerationListener listener) Register to receive a notification when this AbstractProperty instance generates a FormField.AbstractProperty.addInnerPadding(int inner) Will add the specified amount of inner padding (internal spacing) to the generated FormField's margins.AbstractProperty.addLeftPadding(int left) Will add the specified amount of left padding to the generated FormField's margins.AbstractProperty.addPadding(int left, int top, int right, int bottom, int inner) Add the specified padding values to the generated FormField's margins.AbstractProperty.addRightPadding(int right) Will add the specified amount of right padding to the generated FormField's margins.AbstractProperty.addTopPadding(int top) Will add the specified amount of top padding to the generated FormField's margins.PropertiesManager.getProperty(String fullyQualifiedName) Returns a specific AbstractProperty by its fully qualified name, if it exists.PropertyFormFieldValueChangedEvent.property()Returns the value of thepropertyrecord component.AbstractProperty.setAllExtraAttributes(Map<String, Object> newAttributes) Clears any extra attributes currently held by this AbstractProperty and then accepts the given list of attributes.AbstractProperty.setEnabled(boolean enable) Setting a property to disabled will prevent this property from appearing in the PropertiesDialog.AbstractProperty.setExposed(boolean expose) Sets whether this property is to be exposed in the UI.AbstractProperty.setExtraAttribute(String name, Object value) Set an arbitrary extra attribute to this property.AbstractProperty.setHelpText(String helpText) Sets optional help text for this property.AbstractProperty.setInitiallyEditable(boolean initiallyEditable) Set whether this property is to be editable by default when shown on a PropertiesDialog.AbstractProperty.setInitiallyVisible(boolean initiallyVisible) Sets whether this property is to be visible by default when shown on a PropertiesDialog.AbstractProperty.setPropertyLabel(String label) Sets or updates the human-readable label for this property.Methods in ca.corbett.extras.properties that return types with arguments of type AbstractPropertyModifier and TypeMethodDescriptionPropertiesManager.getProperties(String category, String subCategory) Returns a list of all non-hidden PropertyFields in the given category and subcategory.static List<AbstractProperty> PropertiesManager.getProperties(List<AbstractProperty> props, String category, String subCategory) Scans the given properties list and returns a list of all non-hidden properties that belong to the given category and subcategory.Methods in ca.corbett.extras.properties with parameters of type AbstractPropertyModifier and TypeMethodDescriptionintPropertyComparator.compare(AbstractProperty o1, AbstractProperty o2) voidFormFieldGenerationListener.formFieldGenerated(AbstractProperty property, FormField formField) Fired after the given AbstractProperty has generated the FormField, but before the generated FormField has been supplied to whatever requested it (the application config dialog typically).Method parameters in ca.corbett.extras.properties with type arguments of type AbstractPropertyModifier and TypeMethodDescriptionPropertiesManager.getCategories(List<AbstractProperty> props) Extracts and returns a list of all top-level property categories for all non-hidden properties in the given list, in the order that they are discovered within that list.static List<AbstractProperty> PropertiesManager.getProperties(List<AbstractProperty> props, String category, String subCategory) Scans the given properties list and returns a list of all non-hidden properties that belong to the given category and subcategory.PropertiesManager.getSubcategories(String category, List<AbstractProperty> props) Scans the given property list and returns a list of all subcategories within the named category have at least one non-hidden property.Constructors in ca.corbett.extras.properties with parameters of type AbstractPropertyModifierConstructorDescriptionPropertyFormFieldValueChangedEvent(AbstractProperty property, ActionEvent sourceEvent, FormPanel formPanel, FormField formField) Creates an instance of aPropertyFormFieldValueChangedEventrecord class.Constructor parameters in ca.corbett.extras.properties with type arguments of type AbstractPropertyModifierConstructorDescriptionPropertiesManager(Properties propsInstance, List<AbstractProperty> props, String name) Creates a PropertiesManager instance backed onto the given Properties object (which may be a FileBasedProperties instance for disk persistence, or a Properties instance for in-memory), and a list of AbstractProperty objects that we will manage.PropertiesManager(File propsFile, List<AbstractProperty> props, String name) Creates a PropertiesManager instance backed onto the given File object, and a list of AbstractProperty objects that we will manage. -
Uses of AbstractProperty in ca.corbett.extras.properties.dialog
Fields in ca.corbett.extras.properties.dialog with type parameters of type AbstractPropertyModifier and TypeFieldDescriptionprotected final List<AbstractProperty> PropertiesDialog.propertiesMethod parameters in ca.corbett.extras.properties.dialog with type arguments of type AbstractPropertyModifier and TypeMethodDescriptionstatic PropertiesDialogPropertiesDialog.createActionPanelDialog(Window owner, String title, List<AbstractProperty> properties, boolean addPanelHeaders) Returns a new PropertiesDialog instance with the "action panel" style, where properties are grouped into ActionGroups and laid out in an ActionPanel rather than a tabbed pane.static PropertiesDialogPropertiesDialog.createClassicDialog(Window owner, String title, List<AbstractProperty> properties, boolean alwaysShowSubcategoryLabels) Creates and returns a "classic"-style PropertiesDialog, where each top-level category is represented as a tab in a tabbed pane, and subcategories are separated by header labels.Constructor parameters in ca.corbett.extras.properties.dialog with type arguments of type AbstractPropertyModifierConstructorDescriptionActionPanelPropertiesDialog(Window owner, String title, List<AbstractProperty> properties, boolean addPanelHeaders) It's generally preferable to use the create factory methods in the parent PropertiesDialog class, but you can directly instantiate this class if you want.protectedPropertiesDialog(Window owner, String title, List<AbstractProperty> properties) Use the static factory methods to create a new PropertiesDialog instance.TabPanePropertiesDialog(Window owner, String title, List<AbstractProperty> properties, boolean alwaysShowSubcategoryLabels) It's generally preferable to use the create factory methods in the parent PropertiesDialog class, but you can directly instantiate this class if you want.