|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILayoutInspector
Interface for edit part inspectors for handling of layout options. A layout inspector is always associated with a specific edit part instance.
Method Summary | |
---|---|
LayoutProviderData |
getContainerLayouterData()
Returns the layout provider descriptor for the container of the associated edit part. |
EditPart |
getContainerPart()
Returns the edit part that contains the associated edit part. |
Object |
getDefault(LayoutOptionData optionData)
Returns the default value for the associated diagram. |
IFigure |
getDrawingLayer()
Returns a layer figure for the associated diagram that can be used to draw additional information. |
TransactionalEditingDomain |
getEditingDomain()
Returns a transactional editing domain in which to perform model changes. |
LayoutProviderData |
getFocusLayouterData()
Returns the layout provider descriptor for the associated edit part. |
EObject |
getFocusModel()
Returns the domain model element that is associated with this inspector. |
EditPart |
getFocusPart()
Returns the edit part that is associated with this layout inspector. |
KOption |
getKOption(LayoutOptionData optionData,
boolean create)
Returns the currently stored KOption value for the given layout option. |
List<LayoutOptionData> |
getOptionData()
Returns a list of layout option descriptors that are available for the associated edit part. |
boolean |
hasChildren()
Returns true if the associated edit part has children that can be layouted. |
void |
initOptions()
Initialize available layout options for the associated edit part. |
void |
removeAllKOptions()
Removes all stored layout options from the associated edit part and its children. |
void |
removeKOption(LayoutOptionData optionData)
Removes any stored value for the given layout option. |
void |
setDefault(LayoutOptionData optionData,
Object value)
Sets the given option as default value for all elements of the associated diagram. |
Method Detail |
---|
void initOptions()
List<LayoutOptionData> getOptionData()
initOptions()
must be called before this method is used.
KOption getKOption(LayoutOptionData optionData, boolean create)
KOption
value for the given layout option.
initOptions()
must be called before this method is used.
optionData
- layout option datacreate
- if true and the KOption
is not available, a new instance is created and
returned
null
if there is no such value and create
is
falsevoid removeKOption(LayoutOptionData optionData)
initOptions()
must be called
before this method is used.
optionData
- layout option dataLayoutProviderData getFocusLayouterData()
initOptions()
must be called before this method is used.
EditPart getContainerPart()
initOptions()
must be called before this method is used.
LayoutProviderData getContainerLayouterData()
initOptions()
must be called before this method is used.
boolean hasChildren()
true
if the associated edit part has children that can be layouted.
void removeAllKOptions()
Object getDefault(LayoutOptionData optionData)
optionData
- layout option data
null
if no default value is set for
the diagramvoid setDefault(LayoutOptionData optionData, Object value)
optionData
- layout option datavalue
- new default valueEditPart getFocusPart()
EObject getFocusModel()
TransactionalEditingDomain getEditingDomain()
IFigure getDrawingLayer()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |