Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.ui

Class MetisPreferenceSetView

java.lang.Object

io.github.tonywasher.joceanus.metis.ui.MetisPreferenceSetView

All Implemented Interfaces:

OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>, TethysUIComponent

Direct Known Subclasses:

PrometheusPreferenceSetView

public class MetisPreferenceSetView
extends Object
implements OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>, TethysUIComponent

Panel for editing a preference Set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	MetisPreferenceSetView.PreferenceElement	PreferenceElement.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	STR_COLON	Colon String.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetisPreferenceSetView(TethysUIFactory<?> pFactory, MetisPreferenceSet pPreferenceSet)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected MetisPreferenceSetView.PreferenceElement	allocatePreferenceElement(MetisPreferenceSet.MetisPreferenceItem pItem)	Allocate element.
protected void	determineFocus()	Determine Focus.
OceanusEventRegistrar<MetisPreferenceEvent>	getEventRegistrar()	Obtain registration object for listeners.
protected TethysUIFactory<?>	getFactory()	Obtain the GUI factory.
protected TethysUIGridPaneManager	getGrid()	Obtain the grid.
TethysUIComponent	getUnderlying()	Obtain the underlying component (if any).
(package private) boolean	hasChanges()	Does the Preference Set have changes.
protected void	notifyChanges()	Notify changes.
(package private) void	resetChanges()	Reset changes.
(package private) void	storeChanges()	Store changes.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent

getBorderPadding, getBorderTitle, getId, getNode, setBorderPadding, setBorderTitle, setEnabled, setPreferredHeight, setPreferredWidth, setVisible

Field Details

STR_COLON

protected static final String STR_COLON

Colon String.

See Also:

• Constant Field Values

Constructor Details

MetisPreferenceSetView

protected MetisPreferenceSetView(TethysUIFactory<?> pFactory,
 MetisPreferenceSet pPreferenceSet)

Constructor.

Parameters:

pFactory - the GUI factory

pPreferenceSet - the preference set

Method Details

getFactory

protected TethysUIFactory<?> getFactory()

Obtain the GUI factory.

Returns:

the factory

getGrid

protected TethysUIGridPaneManager getGrid()

Obtain the grid.

Returns:

the grid

toString

public String toString()

Overrides:

toString in class Object

getUnderlying

public TethysUIComponent getUnderlying()

Description copied from interface: TethysUIComponent

Obtain the underlying component (if any).

Specified by:

getUnderlying in interface TethysUIComponent

Returns:

the underlying component

getEventRegistrar

public OceanusEventRegistrar<MetisPreferenceEvent> getEventRegistrar()

Description copied from interface: OceanusEventRegistrar.OceanusEventProvider

Obtain registration object for listeners.

Specified by:

getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>

Returns:

the registrar

hasChanges

boolean hasChanges()

Does the Preference Set have changes.

Returns:

does the set have changes

resetChanges

void resetChanges()

Reset changes.

storeChanges

void storeChanges()
           throws OceanusException

Store changes.

Throws:

OceanusException - on error

notifyChanges

protected void notifyChanges()

Notify changes.

allocatePreferenceElement

protected MetisPreferenceSetView.PreferenceElement allocatePreferenceElement(MetisPreferenceSet.MetisPreferenceItem pItem)

Allocate element.

Parameters:

pItem - the preference item

Returns:

the element

determineFocus

protected void determineFocus()

Determine Focus.