[GEF] 무작정 따라하기 - Part. 14 Ruler & Guide

정말 Ruler 와 Guide 에 대해서 똑부러지게 정리된 곳은 하나도 없었습니다...

그래서 GEF 예제와 중국인 아저씨 블로그로 대충 처리한게 얻어걸렸네요 ㅋㅋㅋ

시작합니다

초큼 복잡하기 때문에 순서를 정해서 처리를 해보겠습니다.
  - ActionBarContributor 에 액션과 메뉴에 등록
  - Ruler 관련 클래스 추가 (RulerProvider, Ruler, Guide)
  - Guide 관련 command 추가
  - ElementBase 에 Guide 관련 변수와 getter/setter 추가
  - GraphicalEditor 에 Ruler 를 설정
  - ElementEditLayoutPolicy 에 guide 관련 사항 수정
  - BodyElementPart 에 Adapter 설정

ActionBarContributor 수정
retargetAction 을 추가하고 메뉴바에 사용여부를 설정하는 것을 추가합니다.
public class FormWizardEditorActionBarContributor extends ActionBarContributor { @Override protected void buildActions() { ... addRetargetAction(new RetargetAction( GEFActionConstants.TOGGLE_RULER_VISIBILITY, GEFMessages.ToggleRulerVisibility_Label, IAction.AS_CHECK_BOX)); } ... @Override public void contributeToMenu(IMenuManager menuManager) { super.contributeToMenu(menuManager); MenuManager viewMenu = new MenuManager("View"); viewMenu.add(getAction(GEFActionConstants.TOGGLE_RULER_VISIBILITY)); } ... }


Ruler 관련 클래스의 추가
Logic 이라는 GEF 예제에서 가지고 왔습니다.
package kr.co.vicki.formwizard.rulers; import java.beans.PropertyChangeListener; import java.beans.PropertyChangeSupport; import java.io.Serializable; import java.util.Hashtable; import java.util.Map; import java.util.Set; import kr.co.vicki.formwizard.model.ElementBase; import org.eclipse.gef.EditPart; import org.eclipse.gef.requests.ChangeBoundsRequest; public class ElementGuide implements Serializable { /** * Property used to notify listeners when the parts attached to a guide are * changed */ public static final String PROPERTY_CHILDREN = "subparts changed"; /** * Property used to notify listeners when the guide is re-positioned */ public static final String PROPERTY_POSITION = "position changed"; static final long serialVersionUID = 1; protected PropertyChangeSupport listeners = new PropertyChangeSupport(this); private Map map; private int position; private boolean horizontal; /** * Empty default constructor */ public ElementGuide() { // empty constructor } /** * Constructor * * @param isHorizontal * <code>true</code> if the guide is horizontal (i.e., placed on * a vertical ruler) */ public ElementGuide(boolean isHorizontal) { setHorizontal(isHorizontal); } /** * @see PropertyChangeSupport#addPropertyChangeListener(java.beans.PropertyChangeListener) */ public void addPropertyChangeListener(PropertyChangeListener listener) { listeners.addPropertyChangeListener(listener); } /* * @TODO:Pratik use PositionConstants here */ /** * Attaches the given part along the given edge to this guide. The * LogicSubpart is also updated to reflect this attachment. * * @param part * The part that is to be attached to this guide; if the part is * already attached, its alignment is updated * @param alignment * -1 is left or top; 0, center; 1, right or bottom */ public void attachElement(ElementBase element, int alignment) { if (getMap().containsKey(element) && getAlignment(element) == alignment) return; getMap().put(element, alignment); ElementGuide parent = isHorizontal() ? element.getHorizontalGuide() : element .getVerticalGuide(); if (parent != null && parent != this) { parent.detachElement(element); } if (isHorizontal()) { element.setHorizontalGuide(this); } else { element.setVerticalGuide(this); } listeners.firePropertyChange(PROPERTY_CHILDREN, null, element); } /** * Detaches the given part from this guide. The LogicSubpart is also updated * to reflect this change. * * @param part * the part that is to be detached from this guide */ public void detachElement(ElementBase element) { if (getMap().containsKey(element)) { getMap().remove(element); if (isHorizontal()) { element.setHorizontalGuide(null); } else { element.setVerticalGuide(null); } listeners.firePropertyChange(PROPERTY_CHILDREN, null, element); } } /** * This methods returns the edge along which the given part is attached to * this guide. This information is used by * {@link org.eclipse.gef.examples.logicdesigner.edit.LogicXYLayoutEditPolicy * LogicXYLayoutEditPolicy} to determine whether to attach or detach a part * from a guide during resize operations. * * @param part * The part whose alignment has to be found * @return an int representing the edge along which the given part is * attached to this guide; 1 is bottom or right; 0, center; -1, top * or left; -2 if the part is not attached to this guide * @see org.eclipse.gef.examples.logicdesigner.edit.LogicXYLayoutEditPolicy#createChangeConstraintCommand(ChangeBoundsRequest, * EditPart, Object) */ public int getAlignment(ElementBase element) { if (getMap().get(element) != null) return ((Integer) getMap().get(element)).intValue(); return -2; } /** * @return The Map containing all the parts attached to this guide, and * their alignments; the keys are LogicSubparts and values are * Integers */ public Map getMap() { if (map == null) { map = new Hashtable(); } return map; } /** * @return the set of all the parts attached to this guide; a set is used * because a part can only be attached to a guide along one edge. */ public Set getParts() { return getMap().keySet(); } /** * @return the position/location of the guide (in pixels) */ public int getPosition() { return position; } /** * @return <code>true</code> if the guide is horizontal (i.e., placed on a * vertical ruler) */ public boolean isHorizontal() { return horizontal; } /** * @see PropertyChangeSupport#removePropertyChangeListener(java.beans.PropertyChangeListener) */ public void removePropertyChangeListener(PropertyChangeListener listener) { listeners.removePropertyChangeListener(listener); } /** * Sets the orientation of the guide * * @param isHorizontal * <code>true</code> if this guide is to be placed on a vertical * ruler */ public void setHorizontal(boolean isHorizontal) { horizontal = isHorizontal; } /** * Sets the location of the guide * * @param offset * The location of the guide (in pixels) */ public void setPosition(int offset) { if (position != offset) { int oldValue = position; position = offset; listeners.firePropertyChange(PROPERTY_POSITION, new Integer( oldValue), new Integer(position)); } } }
package kr.co.vicki.formwizard.rulers; import java.beans.PropertyChangeListener; import java.beans.PropertyChangeSupport; import java.io.Serializable; import java.util.ArrayList; import java.util.List; import org.eclipse.gef.rulers.RulerProvider; public class ElementRuler implements Serializable { public static final String PROPERTY_CHILDREN = "children changed"; public static final String PROPERTY_UNIT = "units changed"; static final long serialVersionUID = 1; protected PropertyChangeSupport listeners = new PropertyChangeSupport(this); private int unit; private boolean horizontal; private List guides = new ArrayList(); public ElementRuler(boolean isHorizontal) { this(isHorizontal, RulerProvider.UNIT_PIXELS); } public ElementRuler(boolean isHorizontal, int unit) { horizontal = isHorizontal; setUnit(unit); } public void addGuide(ElementGuide guide) { if (!guides.contains(guide)) { guide.setHorizontal(!isHorizontal()); guides.add(guide); listeners.firePropertyChange(PROPERTY_CHILDREN, null, guide); } } public void addPropertyChangeListener(PropertyChangeListener listener) { listeners.addPropertyChangeListener(listener); } // the returned list should not be modified public List getGuides() { return guides; } public int getUnit() { return unit; } public boolean isHidden() { return false; } public boolean isHorizontal() { return horizontal; } public void removeGuide(ElementGuide guide) { if (guides.remove(guide)) { listeners.firePropertyChange(PROPERTY_CHILDREN, null, guide); } } public void removePropertyChangeListener(PropertyChangeListener listener) { listeners.removePropertyChangeListener(listener); } public void setHidden(boolean isHidden) { } public void setUnit(int newUnit) { if (unit != newUnit) { int oldUnit = unit; unit = newUnit; listeners.firePropertyChange(PROPERTY_UNIT, oldUnit, newUnit); } } }
package kr.co.vicki.formwizard.rulers; import java.beans.PropertyChangeEvent; import java.beans.PropertyChangeListener; import java.util.ArrayList; import java.util.List; import kr.co.vicki.formwizard.rulers.commands.CreateGuideCommand; import kr.co.vicki.formwizard.rulers.commands.DeleteGuideCommand; import kr.co.vicki.formwizard.rulers.commands.MoveGuideCommand; import org.eclipse.gef.commands.Command; import org.eclipse.gef.rulers.RulerChangeListener; import org.eclipse.gef.rulers.RulerProvider; public class ElementRulerProvider extends RulerProvider { private ElementRuler ruler; private PropertyChangeListener rulerListener = new PropertyChangeListener() { public void propertyChange(PropertyChangeEvent evt) { if (evt.getPropertyName().equals(ElementRuler.PROPERTY_CHILDREN)) { ElementGuide guide = (ElementGuide) evt.getNewValue(); if (getGuides().contains(guide)) { guide.addPropertyChangeListener(guideListener); } else { guide.removePropertyChangeListener(guideListener); } for (int i = 0; i < listeners.size(); i++) { ((RulerChangeListener) listeners.get(i)) .notifyGuideReparented(guide); } } else { for (int i = 0; i < listeners.size(); i++) { ((RulerChangeListener) listeners.get(i)) .notifyUnitsChanged(ruler.getUnit()); } } } }; private PropertyChangeListener guideListener = new PropertyChangeListener() { public void propertyChange(PropertyChangeEvent evt) { if (evt.getPropertyName().equals(ElementGuide.PROPERTY_CHILDREN)) { for (int i = 0; i < listeners.size(); i++) { ((RulerChangeListener) listeners.get(i)) .notifyPartAttachmentChanged(evt.getNewValue(), evt .getSource()); } } else { for (int i = 0; i < listeners.size(); i++) { ((RulerChangeListener) listeners.get(i)) .notifyGuideMoved(evt.getSource()); } } } }; public ElementRulerProvider(ElementRuler ruler) { this.ruler = ruler; this.ruler.addPropertyChangeListener(rulerListener); List guides = getGuides(); for (int i = 0; i < guides.size(); i++) { ((ElementGuide) guides.get(i)) .addPropertyChangeListener(guideListener); } } public List getAttachedModelObjects(Object guide) { return new ArrayList(((ElementGuide) guide).getParts()); } public Command getCreateGuideCommand(int position) { return new CreateGuideCommand(ruler, position); } public Command getDeleteGuideCommand(Object guide) { return new DeleteGuideCommand((ElementGuide) guide, ruler); } public Command getMoveGuideCommand(Object guide, int pDelta) { return new MoveGuideCommand((ElementGuide) guide, pDelta); } public int[] getGuidePositions() { List guides = getGuides(); int[] result = new int[guides.size()]; for (int i = 0; i < guides.size(); i++) { result[i] = ((ElementGuide) guides.get(i)).getPosition(); } return result; } public Object getRuler() { return ruler; } public int getUnit() { return ruler.getUnit(); } public void setUnit(int newUnit) { ruler.setUnit(newUnit); } public int getGuidePosition(Object guide) { return ((ElementGuide) guide).getPosition(); } public List getGuides() { return ruler.getGuides(); } }


GuideCommands 추가
예제에서 가져온거라 머라 딱히 설명이 힘드네요;;;
package kr.co.vicki.formwizard.rulers.commands; import kr.co.vicki.formwizard.model.ElementBase; import kr.co.vicki.formwizard.rulers.ElementGuide; import org.eclipse.gef.commands.Command; public class ChangeGuideCommand extends Command { private ElementBase element; private ElementGuide oldGuide, newGuide; private int oldAlign, newAlign; private boolean horizontal; public ChangeGuideCommand(ElementBase element, boolean horizontalGuide) { super(); this.element = element; horizontal = horizontalGuide; } protected void changeGuide(ElementGuide oldGuide, ElementGuide newGuide, int newAlignment) { if (oldGuide != null && oldGuide != newGuide) { oldGuide.detachElement(element); } // You need to re-attach the part even if the oldGuide and the newGuide // are the same // because the alignment could have changed if (newGuide != null) { newGuide.attachElement(element, newAlignment); } } public void execute() { // Cache the old values oldGuide = horizontal ? element.getHorizontalGuide() : element .getVerticalGuide(); if (oldGuide != null) oldAlign = oldGuide.getAlignment(element); redo(); } public void redo() { changeGuide(oldGuide, newGuide, newAlign); } public void setNewGuide(ElementGuide guide, int alignment) { newGuide = guide; newAlign = alignment; } public void undo() { changeGuide(newGuide, oldGuide, oldAlign); } }
package kr.co.vicki.formwizard.rulers.commands; import kr.co.vicki.formwizard.rulers.ElementGuide; import kr.co.vicki.formwizard.rulers.ElementRuler; import org.eclipse.gef.commands.Command; public class CreateGuideCommand extends Command { private ElementGuide guide; private ElementRuler parent; private int position; public CreateGuideCommand(ElementRuler parent, int position) { super("Create guide"); this.parent = parent; this.position = position; } public boolean canUndo() { return true; } public void execute() { if (guide == null) guide = new ElementGuide(!parent.isHorizontal()); guide.setPosition(position); parent.addGuide(guide); } public void undo() { parent.removeGuide(guide); } }
package kr.co.vicki.formwizard.rulers.commands; import java.util.HashMap; import java.util.Iterator; import java.util.Map; import kr.co.vicki.formwizard.model.ElementBase; import kr.co.vicki.formwizard.rulers.ElementGuide; import kr.co.vicki.formwizard.rulers.ElementRuler; import org.eclipse.gef.commands.Command; public class DeleteGuideCommand extends Command { private ElementRuler parent; private ElementGuide guide; private Map oldParts; public DeleteGuideCommand(ElementGuide guide, ElementRuler parent) { super("Delete guide"); this.guide = guide; this.parent = parent; } public boolean canUndo() { return true; } public void execute() { oldParts = new HashMap(guide.getMap()); Iterator iter = oldParts.keySet().iterator(); while (iter.hasNext()) { guide.detachElement((ElementBase) iter.next()); } parent.removeGuide(guide); } public void undo() { parent.addGuide(guide); Iterator iter = oldParts.keySet().iterator(); while (iter.hasNext()) { ElementBase element = (ElementBase) iter.next(); guide.attachElement(element, ((Integer) oldParts.get(element)).intValue()); } } }
package kr.co.vicki.formwizard.rulers.commands; import java.util.Iterator; import kr.co.vicki.formwizard.model.ElementBase; import kr.co.vicki.formwizard.rulers.ElementGuide; import org.eclipse.draw2d.geometry.Rectangle; import org.eclipse.gef.commands.Command; public class MoveGuideCommand extends Command { private int pDelta; private ElementGuide guide; public MoveGuideCommand(ElementGuide guide, int positionDelta) { super("Move guide"); this.guide = guide; pDelta = positionDelta; } public void execute() { guide.setPosition(guide.getPosition() + pDelta); Iterator iter = guide.getParts().iterator(); while (iter.hasNext()) { ElementBase element = (ElementBase) iter.next(); Rectangle layout = element.getLayout().getCopy(); if (guide.isHorizontal()) { layout.y += pDelta; } else { layout.x += pDelta; } element.setLayout(layout); } } public void undo() { guide.setPosition(guide.getPosition() - pDelta); Iterator iter = guide.getParts().iterator(); while (iter.hasNext()) { ElementBase element = (ElementBase) iter.next(); Rectangle layout = element.getLayout().getCopy(); if (guide.isHorizontal()) { layout.y -= pDelta; } else { layout.x -= pDelta; } element.setLayout(layout); } } }



ElementBase 수정
위의 클래스에서 오류가 나는 부분이 있는데 수평, 수직 guide 와 관련된 변수를 추가합니다.
public class ElementBase implements IAdaptable { ... private ElementGuide verticalGuide, horizontalGuide; ... public ElementGuide getVerticalGuide() { return verticalGuide; } public void setVerticalGuide(ElementGuide verticalGuide) { this.verticalGuide = verticalGuide; } public ElementGuide getHorizontalGuide() { return horizontalGuide; } public void setHorizontalGuide(ElementGuide horizontalGuide) { this.horizontalGuide = horizontalGuide; } }



GraphicalEditor 수정 - Ruler 설정
public class FormWizardEditor extends GraphicalEditorWithFlyoutPalette { ... private RulerComposite rulerComp; ... @Override protected void createGraphicalViewer(Composite parent) { rulerComp = new RulerComposite(parent, SWT.NONE); super.createGraphicalViewer(rulerComp); rulerComp.setGraphicalViewer((ScrollingGraphicalViewer)getGraphicalViewer()); } @Override protected Control getGraphicalControl() { return rulerComp; } ... @Override protected void configureGraphicalViewer() { ... configureRuler(); } private void configureRuler() { GraphicalViewer viewer = getGraphicalViewer(); viewer.setProperty(RulerProvider.PROPERTY_VERTICAL_RULER, new ElementRulerProvider(new ElementRuler(false))); viewer.setProperty(RulerProvider.PROPERTY_HORIZONTAL_RULER, new ElementRulerProvider(new ElementRuler(true))); viewer.setProperty(RulerProvider.PROPERTY_RULER_VISIBILITY, true); IAction action = new ToggleRulerVisibilityAction(getGraphicalViewer()); getActionRegistry().registerAction(action); } ... }



EditLayoutPolicy 수정
public class ElementEditLayoutPolicy extends XYLayoutEditPolicy { @Override protected Command createChangeConstraintCommand(EditPart child, Object constraint) { return null; } @Override protected Command createChangeConstraintCommand( ChangeBoundsRequest request, EditPart child, Object constraint) { ElementChangeLayoutCommand command = new ElementChangeLayoutCommand(); ElementBase element = (ElementBase) child.getModel(); command.setModel(child.getModel()); command.setConstraint((Rectangle) constraint); Command result = command; if ((request.getResizeDirection() & PositionConstants.NORTH_SOUTH) != 0) { Integer guidePos = (Integer) request.getExtendedData().get(SnapToGuides.KEY_HORIZONTAL_GUIDE); if (guidePos != null) { result = chainGuideAttachmentCommand(request, model, result, true); } else if (model.getHorizontalGuide() != null) { int alignment = model.getHorizontalGuide().getAlignment(model); int edgeBeingResized = 0; if ((request.getResizeDirection() & PositionConstants.NORTH) != 0) edgeBeingResized = -1; else edgeBeingResized = 1; if (alignment == edgeBeingResized) result = result.chain(new ChangeGuideCommand(model, true)); } } if ((request.getResizeDirection() & PositionConstants.EAST_WEST) != 0) { Integer guidePos = (Integer)request.getExtendedData() .get(SnapToGuides.KEY_VERTICAL_GUIDE); if (guidePos != null) { result = chainGuideAttachmentCommand(request, element, result, false); } else if (element.getVerticalGuide() != null) { int alignment = element.getVerticalGuide().getAlignment(element); int edgeBeingResized = 0; if ((request.getResizeDirection() & PositionConstants.WEST) != 0) edgeBeingResized = -1; else edgeBeingResized = 1; if (alignment == edgeBeingResized) result = result.chain(new ChangeGuideCommand(element, false)); } } if (request.getType().equals(REQ_MOVE_CHILDREN) || request.getType().equals(REQ_ALIGN_CHILDREN)) { result = chainGuideAttachmentCommand(request, element, result, true); result = chainGuideAttachmentCommand(request, element, result, false); result = chainGuideDetachmentCommand(request, element, result, true); result = chainGuideDetachmentCommand(request, element, result, false); } return result; } protected Command chainGuideAttachmentCommand( Request request, ElementBase element, Command cmd, boolean horizontal) { Command result = cmd; // Attach to guide, if one is given Integer guidePos = (Integer)request.getExtendedData() .get(horizontal ? SnapToGuides.KEY_HORIZONTAL_GUIDE : SnapToGuides.KEY_VERTICAL_GUIDE); if (guidePos != null) { int alignment = ((Integer)request.getExtendedData() .get(horizontal ? SnapToGuides.KEY_HORIZONTAL_ANCHOR : SnapToGuides.KEY_VERTICAL_ANCHOR)).intValue(); ChangeGuideCommand cgm = new ChangeGuideCommand(element, horizontal); cgm.setNewGuide(findGuideAt(guidePos.intValue(), horizontal), alignment); result = result.chain(cgm); } return result; } protected Command chainGuideDetachmentCommand(Request request, ElementBase element, Command cmd, boolean horizontal) { Command result = cmd; // Detach from guide, if none is given Integer guidePos = (Integer)request.getExtendedData() .get(horizontal ? SnapToGuides.KEY_HORIZONTAL_GUIDE : SnapToGuides.KEY_VERTICAL_GUIDE); if (guidePos == null) result = result.chain(new ChangeGuideCommand(element, horizontal)); return result; } protected ElementGuide findGuideAt(int pos, boolean horizontal) { RulerProvider provider = ((RulerProvider)getHost().getViewer().getProperty( horizontal ? RulerProvider.PROPERTY_VERTICAL_RULER : RulerProvider.PROPERTY_HORIZONTAL_RULER)); return (ElementGuide) provider.getGuideAt(pos); } ... }



BodyElementPart 수정
public class BodyElementPart extends ElementPartBase { ... @Override public Object getAdapter(Class key) { if (key == SnapToHelper.class) { List<SnapToHelper> snaps = new ArrayList<SnapToHelper>(); Boolean b = (Boolean)getViewer().getProperty(RulerProvider.PROPERTY_RULER_VISIBILITY); if (b != null && b) snaps.add(new SnapToGuides(this)); if (snaps.size() == 0) return null; if (snaps.size() == 1) return snaps.get(0); SnapToHelper[] ss = snaps.toArray(new SnapToHelper[0]); return new CompoundSnapToHelper(ss); } return super.getAdapter(key); } }



복잡하고도 난해한 부분이었습니다. 나중에 실력이 좀 늘면 정확하게 하나하나씩 따져봐야겠네요~

참고자료 이클립스 홈 - http://www.eclipse.org/ GEF 프로젝트 홈 - http://www.eclipse.org/gef/ 이클립스 플러그인 카페 - http://cafe.naver.com/eclipseplugin psykokwak 블로그 - http://www.psykokwak.com/blog/index.php/gef 민물곰탱이의 이클립스 개발 이야기 - http://esterel-dev.tistory.com/ 少年壮志无烟抽 - http://www.cnblogs.com/bjzhanghao/archive/2005/04/21/142558.html GEF examples