|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPattern
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.ICreate |
---|
EMPTY |
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 | |
---|---|
PictogramElement |
add(IAddContext context)
Clients must override this method to provide the functionality to add an existing domain object to a diagram. |
boolean |
canAdd(IAddContext context)
Clients must override this method to indicate the framework that this pattern can add a domain object to the diagram. |
void |
completeInfo(IDirectEditingInfo info,
Object bo)
Complete the directEditing info. |
void |
completeInfo(IDirectEditingInfo info,
Object bo,
String keyProperty)
Complete the directEditing info. |
String |
getCreateDescription()
Gets the create description. |
String |
getCreateName()
Gets the create name. |
IResizeConfiguration |
getResizeConfiguration(IResizeShapeContext context)
Provides configuration object, which describes the resize behavior. |
boolean |
hasDoneChanges(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. |
boolean |
isMainBusinessObjectApplicable(Object mainBusinessObject)
This method must be implemented by the pattern user. |
boolean |
isPaletteApplicable()
Determines whether the pattern supports the creation of new business objects from the palette. |
void |
setFeatureProvider(IFeatureProvider fp)
Sets the feature provider. |
Methods inherited from interface org.eclipse.graphiti.func.ICreate |
---|
canCreate, create |
Methods inherited from interface org.eclipse.graphiti.func.ICreateInfo |
---|
getCreateImageId, getCreateLargeImageId |
Methods inherited from interface org.eclipse.graphiti.func.IDelete |
---|
canDelete, delete, isDeleteAbort, postDelete, preDelete |
Methods inherited from interface org.eclipse.graphiti.func.IRemove |
---|
canRemove, isRemoveAbort, postRemove, preRemove, remove |
Methods inherited from interface org.eclipse.graphiti.func.IUpdate |
---|
canUpdate, update, updateNeeded |
Methods inherited from interface org.eclipse.graphiti.func.ILayout |
---|
canLayout, layout |
Methods inherited from interface org.eclipse.graphiti.func.IResizeShape |
---|
canResizeShape, resizeShape |
Methods inherited from interface org.eclipse.graphiti.func.IMoveShape |
---|
canMoveShape, moveShape |
Methods inherited from interface org.eclipse.graphiti.func.IDirectEditing |
---|
canDirectEdit, checkValueValid, completeValue, getEditingType, getInitialValue, getPossibleValues, getProposalSupport, getValueProposals, isAutoCompletionEnabled, isCompletionAvailable, setValue, stretchFieldToFitText |
Method Detail |
---|
boolean isPaletteApplicable()
false
will
suppress the creation of a palette item for this pattern.
true
if the pattern supports the ICreate
methods and a palette item should be generatedString getCreateName()
getCreateName
in interface ICreateInfo
String getCreateDescription()
getCreateDescription
in interface ICreateInfo
void setFeatureProvider(IFeatureProvider fp)
fp
- the new feature providerboolean isMainBusinessObjectApplicable(Object mainBusinessObject)
mainBusinessObject
- the main business object
void completeInfo(IDirectEditingInfo info, Object bo)
info
- the directEditing infobo
- the business objectvoid completeInfo(IDirectEditingInfo info, Object bo, String keyProperty)
info
- the directEditing infobo
- the business objectkeyProperty
- the key propertyPictogramElement add(IAddContext context)
IAdd.add(IAddContext)
method. The default implementation
simply does nothing and returns null
.
add
in interface IAdd
context
- The add context holding information about the added domain
object.
boolean canAdd(IAddContext context)
IAdd.canAdd(IAddContext)
method. The default
implementation simply returns false
.
canAdd
in interface IAdd
context
- The add context holding information about the added domain
object.
true
, if the domain object can be added,
false
otherwise.IResizeConfiguration getResizeConfiguration(IResizeShapeContext context)
context
- the resizing context
boolean hasDoneChanges(Class<?> actionType)
IMPORTANT NOTE: The implementor of the feature is responsible for
correctly implementing this method! It will lead to inconsistencies if
this method returns false
although the pattern did changes.
actionType
- the followings types are currently supported:
IDelete.class, IRemove.class
true
if the last action of the pattern from this
action type should appear in the undo stack, false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |