Package com.inductiveautomation.factorypmi.designer.palette.model

Class PaletteImpl

java.lang.Object

javax.swing.AbstractListModel

com.inductiveautomation.factorypmi.designer.palette.model.PaletteImpl

All Implemented Interfaces:

ResourceListener, Palette, Serializable, ListModel

public class PaletteImpl
extends AbstractListModel
implements Palette, ResourceListener

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaletteImpl.SingleObjectSelectionModel<R>	Implementation copied (and simplified) from DefaultSingleSelectionModel and modified to handle objects, not ints.

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	PALETTE_RESOURCE_TYPE
static DataFlavor	PALETTEITEM_DATAFLAVOR

Fields inherited from class javax.swing.AbstractListModel

listenerList

Constructor Summary

Constructors

Constructor	Description
PaletteImpl(VisionDesignerInterface visionContext)

Method Summary

Modifier and Type	Method	Description
void	addAuxiliaryAction(Action action)	An action that may be added to the palette.
void	addGroup(PaletteItemGroup group)
PaletteItemGroup	addGroup(String name)	Adds a plugin palette tab
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	clearSelection()	Clears the selection so that nothing is pending a drop.
List<Action>	getAuxiliaryActions()
List<CustomPaletteItemGroup>	getCustomPalettes()	Retrieves a list of custom palette item groups
Object	getElementAt(int index)	Returns the PaletteItemGroup at the given location
PaletteItemGroup	getGroup(String name)	Returns the PaletteItemGroup with the given name, or null if no such group exists
PaletteItemGroup	getGroupAt(int index)
com.inductiveautomation.factorypmi.designer.palette.model.PaletteImpl.PaletteHandler	getImportExportHandler()
ResourceFilter	getResourceFilter()	Get the ResourceFilter used to filter resources this listener cares about.
PaletteItem	getSelectedItem()	Get the selected, or "hot" item that is waiting to be dropped.
PaletteImpl.SingleObjectSelectionModel<PaletteItem>	getSelectionModel()
int	getSize()	The number of palette item groups.
protected void	initializeStaticPaletteGroups()	Loads the static components from palette.xml
boolean	isItemSelected()	Returns true if an item is selected.
void	removeGroup(PaletteItemGroup group)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	rename(PaletteItemGroup paletteItemGroup, String newName)
void	resourcesCreated(String projectName, List<ChangeOperation.CreateResourceOperation> resources)
void	resourcesDeleted(String projectName, List<ChangeOperation.DeleteResourceOperation> signatures)
void	resourcesModified(String projectName, List<ChangeOperation.ModifyResourceOperation> resources)
void	sanitizeName(PaletteItemGroup group)
void	setEnabled(boolean b)	Enables/disables all palette item groups en-masse.
String	toString()
void	update(List<Resource> changed)	Updates the custom palettes as according to the given diff

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.resourcecollection.ResourceListener

manifestChanged, onAfterChanges, onBeforeChanges

Field Details

PALETTE_RESOURCE_TYPE

public static final ResourceType PALETTE_RESOURCE_TYPE

PALETTEITEM_DATAFLAVOR

public static DataFlavor PALETTEITEM_DATAFLAVOR

Constructor Details

PaletteImpl

public PaletteImpl(VisionDesignerInterface visionContext)
            throws SerializationException

Throws:

SerializationException

Method Details

initializeStaticPaletteGroups

protected void initializeStaticPaletteGroups()

Loads the static components from palette.xml

addAuxiliaryAction

public void addAuxiliaryAction(Action action)

Description copied from interface: Palette

An action that may be added to the palette. Only supported by the collapsible palette

Specified by:

addAuxiliaryAction in interface Palette

getAuxiliaryActions

public List<Action> getAuxiliaryActions()

getElementAt

public Object getElementAt(int index)

Returns the PaletteItemGroup at the given location

Specified by:

getElementAt in interface ListModel

getSize

public int getSize()

The number of palette item groups.

Specified by:

getSize in interface ListModel

isItemSelected

public boolean isItemSelected()

Returns true if an item is selected. This means that the item is "hot" - waiting to be dropped onto a window.

getSelectedItem

public PaletteItem getSelectedItem()

Get the selected, or "hot" item that is waiting to be dropped.

clearSelection

public void clearSelection()

Clears the selection so that nothing is pending a drop.

Specified by:

clearSelection in interface Palette

setEnabled

public void setEnabled(boolean b)

Enables/disables all palette item groups en-masse.

getGroup

public PaletteItemGroup getGroup(String name)

Description copied from interface: Palette

Returns the PaletteItemGroup with the given name, or null if no such group exists

Specified by:

getGroup in interface Palette

getGroupAt

public PaletteItemGroup getGroupAt(int index)

addGroup

public PaletteItemGroup addGroup(String name)

Description copied from interface: Palette

Adds a plugin palette tab

Specified by:

addGroup in interface Palette

addGroup

public void addGroup(PaletteItemGroup group)

Specified by:

addGroup in interface Palette

sanitizeName

public void sanitizeName(PaletteItemGroup group)

getCustomPalettes

public List<CustomPaletteItemGroup> getCustomPalettes()

Retrieves a list of custom palette item groups

removeGroup

public void removeGroup(PaletteItemGroup group)

rename

public void rename(PaletteItemGroup paletteItemGroup,
 String newName)

getResourceFilter

@Nonnull
public ResourceFilter getResourceFilter()

Description copied from interface: ResourceListener

Get the ResourceFilter used to filter resources this listener cares about. Default is to care about all resources.

Specified by:

getResourceFilter in interface ResourceListener

Returns:

the ResourceFilter used to filter resources this listener cares about.

resourcesDeleted

public void resourcesDeleted(String projectName,
 List<ChangeOperation.DeleteResourceOperation> signatures)

Specified by:

resourcesDeleted in interface ResourceListener

resourcesCreated

public void resourcesCreated(String projectName,
 List<ChangeOperation.CreateResourceOperation> resources)

Specified by:

resourcesCreated in interface ResourceListener

resourcesModified

public void resourcesModified(String projectName,
 List<ChangeOperation.ModifyResourceOperation> resources)

Specified by:

resourcesModified in interface ResourceListener

update

public void update(List<Resource> changed)

Updates the custom palettes as according to the given diff

toString

public String toString()

Overrides:

toString in class Object

getSelectionModel

public PaletteImpl.SingleObjectSelectionModel<PaletteItem> getSelectionModel()

getImportExportHandler

public com.inductiveautomation.factorypmi.designer.palette.model.PaletteImpl.PaletteHandler getImportExportHandler()

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
 PropertyChangeListener listener)