com.nomagic.magicdraw.patterns

Class AbstractPanelContainer

java.lang.Object

com.nomagic.magicdraw.patterns.AbstractPanelContainer

Direct Known Subclasses:

PatternPropertiesPanel

@OpenApiAll
public abstract class AbstractPanelContainer
extends java.lang.Object

This abstract class is implemented by design pattern. Implementation is used to get properties' panel and additional panels of pattern wizard.

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.swing.border.Border	BORDER_COMPOUND The compound titled border used for properties panel.
protected static javax.swing.border.Border	BORDER_EMPTY The empty border used in patterns ui.
protected static javax.swing.border.Border	PROPERTIES_BORDER The titled border used for properties panel.

Constructor Summary

Constructors

Constructor and Description
AbstractPanelContainer()

Method Summary

Modifier and Type	Method and Description
abstract void	applyChangesToProperties(AbstractPatternProperties properties) Change properties according the changes in the panels.
protected javax.swing.JPanel	createBorderPane(javax.swing.JComponent comp) Sets the border for component (page) in the wizard.
abstract javax.swing.JComponent	getAdditionalPanel(int index) Returns the additional panel at the given wizard index.
abstract int	getAdditionalPanelCount() Returns the number of additional panels(without main properties panel).
abstract javax.swing.JComponent	getPropertiesPanel() Returns the initial panel for a design pattern.
abstract void	reset() Clears the panel container.
abstract void	setPatternProperties(AbstractPatternProperties properties) Sets information from properties into the panels

Methods inherited from class java.lang.Object

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

Field Detail

BORDER_EMPTY

protected static final javax.swing.border.Border BORDER_EMPTY

The empty border used in patterns ui.

PROPERTIES_BORDER

protected static final javax.swing.border.Border PROPERTIES_BORDER

The titled border used for properties panel.

BORDER_COMPOUND

protected static final javax.swing.border.Border BORDER_COMPOUND

The compound titled border used for properties panel.

Constructor Detail

AbstractPanelContainer

public AbstractPanelContainer()

Method Detail

getAdditionalPanelCount

public abstract int getAdditionalPanelCount()

Returns the number of additional panels(without main properties panel). If pattern contains just main properties, this method must return 0.

Returns:

count of additional panels.

getPropertiesPanel

public abstract javax.swing.JComponent getPropertiesPanel()

Returns the initial panel for a design pattern. Initial panel is the panel with properties list, which appears when certain design pattern is selected.

Returns:

initial panel

getAdditionalPanel

public abstract javax.swing.JComponent getAdditionalPanel(int index)

Returns the additional panel at the given wizard index.

Parameters:

index - panel index in the wizard sequence.

Returns:

panel at given index.

setPatternProperties

public abstract void setPatternProperties(AbstractPatternProperties properties)

Sets information from properties into the panels

Parameters:

properties - the pattern properties.

reset

public abstract void reset()

Clears the panel container.

applyChangesToProperties

public abstract void applyChangesToProperties(AbstractPatternProperties properties)

Change properties according the changes in the panels.

Parameters:

properties - the pattern properties.

createBorderPane

protected javax.swing.JPanel createBorderPane(javax.swing.JComponent comp)

Sets the border for component (page) in the wizard.

Parameters:

comp - The border is set for the component.

Returns:

The returned value should be used instead of passed in source.