Package com.nomagic.magicdraw.core.options

Class OptionsGroup

java.lang.Object

com.nomagic.magicdraw.core.options.OptionsGroup

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AbstractPropertyOptionsGroup

@OpenApi
public abstract class OptionsGroup
extends java.lang.Object
implements java.lang.Cloneable

Represents general application options.

See Also:

AbstractPropertyOptionsGroup, EnvironmentOptions

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<OptionsGroup>	children
private boolean	enabled
private javax.swing.Icon	icon
protected static javax.swing.Icon	ICON_ENVIRONMENT_OPTIONS
private java.lang.String	id
private OptionsGroup	parent
private boolean	visible

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionsGroup(java.lang.String id, boolean visible)
protected	OptionsGroup(java.lang.String id, javax.swing.Icon icon, boolean visible)

Method Summary

Modifier and Type	Method	Description
void	add(OptionsGroup group)
protected void	afterLoad(com.nomagic.magicdraw.lic.MDVersion version, boolean pluginsLoaded)
void	afterSave()
void	beforeLoad(boolean pluginsLoaded)
abstract com.nomagic.magicdraw.ui.dialogs.options.BaseOptionsPanel	createOptionsPanel()	Creates options panel for editing the properties.
void	firstInit(boolean pluginsLoaded)
com.nomagic.ui.banners.Banner	getBanner()
java.util.List<OptionsGroup>	getChildren()
javax.swing.Icon	getGroupIcon()	Returns icon to display with options.
SwingImageIcon	getIcon()	Deprecated. use #getGroupIcon()
java.lang.String	getId()
java.lang.String	getName()	Gets human-readable name of options.
Style	getOptionsToSave()
OptionsGroup	getParent()
boolean	isEnabled()
boolean	isVisible()
void	loadOptions(Style style, boolean pluginsLoaded)
void	remove(OptionsGroup group)
protected void	resetCachedValues()
void	setEnabled(boolean enabled)
private void	setParent(OptionsGroup parent)
void	setVisible(boolean visible)
void	sortChildren(java.util.Comparator<OptionsGroup> comparator)

Methods inherited from class java.lang.Object

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

Field Detail

id

private final java.lang.String id

icon

private final javax.swing.Icon icon

visible

private boolean visible

enabled

private boolean enabled

parent

@CheckForNull
private OptionsGroup parent

children

private final java.util.List<OptionsGroup> children

ICON_ENVIRONMENT_OPTIONS

protected static javax.swing.Icon ICON_ENVIRONMENT_OPTIONS

Constructor Detail

OptionsGroup

protected OptionsGroup(java.lang.String id,
                       @CheckForNull
                       javax.swing.Icon icon,
                       boolean visible)

OptionsGroup

protected OptionsGroup(java.lang.String id,
                       boolean visible)

Method Detail

getId

public java.lang.String getId()

getGroupIcon

@CheckForNull
@OpenApi
public javax.swing.Icon getGroupIcon()

Returns icon to display with options.

Returns:

icon to display with options.

getIcon

@Deprecated
@CheckForNull
@OpenApi
public SwingImageIcon getIcon()

Deprecated.

use #getGroupIcon()

Returns icon to display with options.

Returns:

icon to display with options

createOptionsPanel

@CheckForNull
public abstract com.nomagic.magicdraw.ui.dialogs.options.BaseOptionsPanel createOptionsPanel()

Creates options panel for editing the properties.

Returns:

created options panel.

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getOptionsToSave

@CheckForNull
public Style getOptionsToSave()

firstInit

public void firstInit(boolean pluginsLoaded)

afterSave

public void afterSave()

loadOptions

public void loadOptions(Style style,
                        boolean pluginsLoaded)

beforeLoad

public void beforeLoad(boolean pluginsLoaded)

afterLoad

protected void afterLoad(@CheckForNull
                         com.nomagic.magicdraw.lic.MDVersion version,
                         boolean pluginsLoaded)

getName

@OpenApi
public java.lang.String getName()

Gets human-readable name of options.

Returns:

human-readable name of options.

getBanner

@CheckForNull
public com.nomagic.ui.banners.Banner getBanner()

getParent

@CheckForNull
public OptionsGroup getParent()

setParent

private void setParent(@CheckForNull
                       OptionsGroup parent)

add

public void add(OptionsGroup group)

remove

public void remove(OptionsGroup group)

getChildren

public java.util.List<OptionsGroup> getChildren()

sortChildren

public void sortChildren(java.util.Comparator<OptionsGroup> comparator)

resetCachedValues

protected void resetCachedValues()