Package org.eclipse.graphiti.pattern
Interface IPattern
- All Superinterfaces:
IAdd,ICreate,ICreateInfo,IDelete,IDirectEditing,ILayout,IMoveShape,IRemove,IResizeShape,IUpdate
- All Known Implementing Classes:
AbstractPattern,IdPattern,TypedPattern
public interface IPattern
extends ICreate, IAdd, IDelete, IRemove, IUpdate, ILayout, IResizeShape, IMoveShape, IDirectEditing
The Interface IPattern marks a pattern for handling shapes. Please see the
information in
AbstractPattern.-
Field Summary
Fields inherited from interface org.eclipse.graphiti.func.IDirectEditing
TYPE_CUSTOM, TYPE_DROPDOWN, TYPE_DROPDOWN_READ_ONLY, TYPE_MULTILINETEXT, TYPE_NONE, TYPE_TEXT -
Method Summary
Modifier and TypeMethodDescriptionadd(IAddContext context) Clients must override this method to provide the functionality to add an existing domain object to a diagram.booleancanAdd(IAddContext context) Clients must override this method to indicate the framework that this pattern can add a domain object to the diagram.voidcompleteInfo(IDirectEditingInfo info, Object bo) Complete the directEditing info.voidcompleteInfo(IDirectEditingInfo info, Object bo, String keyProperty) Complete the directEditing info.Gets the create description.Gets the create name.Provides configuration object, which describes the resize behavior.booleanhasDoneChanges(Class<?> actionType) Is queried by the framework after a pattern has been executed to find out if this pattern should appear in the undo stack.booleanisMainBusinessObjectApplicable(Object mainBusinessObject) This method must be implemented by the pattern user.booleanDetermines whether the pattern supports the creation of new business objects from the palette.voidSets the feature provider.Methods inherited from interface org.eclipse.graphiti.func.ICreateInfo
getCreateImageId, getCreateLargeImageIdMethods inherited from interface org.eclipse.graphiti.func.IDelete
canDelete, delete, isDeleteAbort, postDelete, preDeleteMethods inherited from interface org.eclipse.graphiti.func.IDirectEditing
canDirectEdit, checkValueValid, completeValue, getEditingType, getInitialValue, getPossibleValues, getProposalSupport, getValueProposals, isAutoCompletionEnabled, isCompletionAvailable, setValue, stretchFieldToFitTextMethods inherited from interface org.eclipse.graphiti.func.IMoveShape
canMoveShape, moveShapeMethods inherited from interface org.eclipse.graphiti.func.IRemove
canRemove, isRemoveAbort, postRemove, preRemove, removeMethods inherited from interface org.eclipse.graphiti.func.IResizeShape
canResizeShape, resizeShapeMethods inherited from interface org.eclipse.graphiti.func.IUpdate
canUpdate, update, updateNeeded
-
Method Details
-
isPaletteApplicable
boolean isPaletteApplicable()Determines whether the pattern supports the creation of new business objects from the palette. Setting this tofalsewill suppress the creation of a palette item for this pattern.- Returns:
trueif the pattern supports theICreatemethods and a palette item should be generated
-
getCreateName
String getCreateName()Gets the create name.- Specified by:
getCreateNamein interfaceICreateInfo- Returns:
- name for UI representation
-
getCreateDescription
String getCreateDescription()Gets the create description.- Specified by:
getCreateDescriptionin interfaceICreateInfo- Returns:
- description for UI representation
-
setFeatureProvider
Sets the feature provider.- Parameters:
fp- the new feature provider
-
isMainBusinessObjectApplicable
This method must be implemented by the pattern user. The main pictogram element of the pattern is linked with the main business object.- Parameters:
mainBusinessObject- the main business object- Returns:
- True, if this pattern is responsible for the main business object
-
completeInfo
Complete the directEditing info. This information is needed to switch automatically into the direct editing mode. (e.g. after creation of a new object)- Parameters:
info- the directEditing infobo- the business object
-
completeInfo
Complete the directEditing info. This information is needed to switch automatically into the direct editing mode. (e.g. after creation of a new object)- Parameters:
info- the directEditing infobo- the business objectkeyProperty- the key property
-
add
Clients must override this method to provide the functionality to add an existing domain object to a diagram. Corresponds to theIAdd.add(IAddContext)method. The default implementation simply does nothing and returnsnull. -
canAdd
Clients must override this method to indicate the framework that this pattern can add a domain object to the diagram. Corresponds to theIAdd.canAdd(IAddContext)method. The default implementation simply returnsfalse. -
getResizeConfiguration
Provides configuration object, which describes the resize behavior.- Parameters:
context- the resizing context- Returns:
- the resize configuration object
-
hasDoneChanges
Is queried by the framework after a pattern has been executed to find out if this pattern should appear in the undo stack. By default all patterns should appear there (see implementation in AbstractPattern), but single pattern may decide to override this behavior. Note that this is a dynamic attribute of the pattern that is queried each time after the pattern has been executed.IMPORTANT NOTE: The implementor of the feature is responsible for correctly implementing this method! It will lead to inconsistencies if this method returns
falsealthough the pattern did changes.- Parameters:
actionType- the followings types are currently supported:IDelete.class, IRemove.class- Returns:
trueif the last action of the pattern from this action type should appear in the undo stack,falseotherwise- Since:
- 0.9
-