Package annotation.userforms

Class UserFormSymbolModifier

java.lang.Object

PamView.symbol.modifier.SymbolModifier

annotation.userforms.UserFormSymbolModifier

public class UserFormSymbolModifier
extends SymbolModifier

User form symbol modifier for use in user form annotations. This will need modification before it can be used in a logger form directly.

Author:

Dougl

Field Summary

Fields inherited from class PamView.symbol.modifier.SymbolModifier

symbolModifierParams

Constructor Summary

Constructors

Constructor	Description
UserFormSymbolModifier(FormDescription formDescription, PamSymbolChooser symbolChooser)

Method Summary

Modifier and Type	Method	Description
JMenuItem	getModifierOptionsMenu()	Get a menu item which can be added to options menu to control symbol modifier settings.
SymbolData	getSymbolData(GeneralProjector projector, PamDataUnit dataUnit)	This is the symbol data to use if this modifier were to change everything.
SymbolModifierParams	getSymbolModifierParams()	Get the symbol modifier parameters associated with the symbol modifier.
void	setSymbolModifierParams(SymbolModifierParams symbolModifierParams)	Set the symbol modifier paramters.

Methods inherited from class PamView.symbol.modifier.SymbolModifier

canModify, getDialogPanel, getModifyableBits, getName, getOptionsPane, getSymbolChooser, getToolTipText, modifySymbol, setName, setSelectionBit, setToolTipText

Methods inherited from class java.lang.Object

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

Constructor Details

UserFormSymbolModifier

public UserFormSymbolModifier(FormDescription formDescription,
 PamSymbolChooser symbolChooser)

Method Details

getSymbolData

public SymbolData getSymbolData(GeneralProjector projector,
 PamDataUnit dataUnit)

Description copied from class: SymbolModifier

This is the symbol data to use if this modifier were to change everything. the Symbolchooser will actually be calling the modifySymbol function, which calls this, then based on which bits are set for modification, will transfer over the appropriate information.

Must be able to respond to a null projector and dataUnit for tree vies.

Specified by:

getSymbolData in class SymbolModifier

Returns:

getModifierOptionsMenu

public JMenuItem getModifierOptionsMenu()

Description copied from class: SymbolModifier

Get a menu item which can be added to options menu to control symbol modifier settings. by default, the menu item is only created if the getDialogPanel function returns non null, but this behaviour can be overridden for more bespoke solutions such as simple additional menu items, etc.

Overrides:

getModifierOptionsMenu in class SymbolModifier

Returns:

null or a menu item

getSymbolModifierParams

public SymbolModifierParams getSymbolModifierParams()

Description copied from class: SymbolModifier

Get the symbol modifier parameters associated with the symbol modifier.

Note that this function should create a new instance of the settings class if the settings class is null. This allows subclasses to override this function to return custom parameter objects.

Overrides:

getSymbolModifierParams in class SymbolModifier

Returns:

the symbol modifier parameters.

setSymbolModifierParams

public void setSymbolModifierParams(SymbolModifierParams symbolModifierParams)

Description copied from class: SymbolModifier

Set the symbol modifier paramters.

Overrides:

setSymbolModifierParams in class SymbolModifier

Parameters:

symbolModifierParams - - the symbol modifiers paramters.