org.hkijena.jipipe.desktop.app.settings

Class JIPipeDesktopProjectSettingsUI.ProjectMetadataSettingsSheetWrapper

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.settings.JIPipeDefaultProjectSettingsSheet

org.hkijena.jipipe.desktop.app.settings.JIPipeDesktopProjectSettingsUI.SettingsSheetWrapper

org.hkijena.jipipe.desktop.app.settings.JIPipeDesktopProjectSettingsUI.ProjectMetadataSettingsSheetWrapper

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeProjectSettingsSheet, JIPipeSettingsSheet

Enclosing class:

JIPipeDesktopProjectSettingsUI

public static class JIPipeDesktopProjectSettingsUI.ProjectMetadataSettingsSheetWrapper
extends JIPipeDesktopProjectSettingsUI.SettingsSheetWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
ProjectMetadataSettingsSheetWrapper(JIPipeProject project)

Method Summary

Modifier and Type	Method and Description
JIPipeDefaultProjectSettingsSheetCategory	getDefaultCategory() Returns one of the predefined categories
String	getDescription() Description of this settings sheet
void	getEnvironmentDependencies(List<JIPipeEnvironment> target) Gathers all known external environments.
Icon	getIcon() The icon of the settings sheet
String	getId() The unique ID of the settings sheet
String	getName() The name of the settings sheet as displayed in the UI
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter) Allows to override the visibility of sub-parameters inside the UI

Methods inherited from class org.hkijena.jipipe.desktop.app.settings.JIPipeDesktopProjectSettingsUI.SettingsSheetWrapper

getWrapped

Methods inherited from class org.hkijena.jipipe.api.settings.JIPipeDefaultProjectSettingsSheet

getCategory, getCategoryIcon

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, installUIOverrideParameterEditor, installUIParameterOptions, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

ProjectMetadataSettingsSheetWrapper

public ProjectMetadataSettingsSheetWrapper(JIPipeProject project)

Method Detail

getId

public String getId()

Description copied from interface: JIPipeSettingsSheet

The unique ID of the settings sheet

Returns:

the ID

getIcon

public Icon getIcon()

Description copied from interface: JIPipeSettingsSheet

The icon of the settings sheet

Returns:

the icon

getName

public String getName()

Description copied from interface: JIPipeSettingsSheet

The name of the settings sheet as displayed in the UI

Returns:

the name

getDescription

public String getDescription()

Description copied from interface: JIPipeSettingsSheet

Description of this settings sheet

Returns:

the description

getDefaultCategory

public JIPipeDefaultProjectSettingsSheetCategory getDefaultCategory()

Description copied from class: JIPipeDefaultProjectSettingsSheet

Returns one of the predefined categories

Specified by:

getDefaultCategory in class JIPipeDefaultProjectSettingsSheet

Returns:

the category

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterCollection subParameter)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of sub-parameters inside the UI

Parameters:

tree - the parameter tree that is used to access this parameter

subParameter - a sub parameter

Returns:

if the parameter is visible inside the UI

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

getEnvironmentDependencies

public void getEnvironmentDependencies(List<JIPipeEnvironment> target)

Description copied from interface: JIPipeProjectSettingsSheet

Gathers all known external environments. Environments should only be added if they are active/enabled.

Parameters:

target - the list where the external environments will be gathered