아주 오랜만에 이클립스 플러그인에 관한 글을 다시 적게 되었습니다. 연구실에 남아있을 마지막 2주일 동안 그 동안 못다뤘던 부분들을 정리하려 합니다. 오늘은 마법사에 대해서 다루겠습니다. 마법사(Wizard)가 무엇인지는 각종 개발툴을 써보셨다면 이미 잘 알고계실 것 같습니다. VICODE 사용자 메뉴얼을 존대말로 쓰다보니 탄력받아(?) 존대말로 쓰게 되었네요.
마법사는 여러 페이지로 구성되어 있습니다. 각 페이지는 프로젝트를 생성하는 등의 작업을 위한 일련의 단계를 표현합니다. 그리고 각 페이지는 자신에게 필요한 정보가 입력되었는지를 판단하여 마법사에게 알립니다. 마법사는 페이지의 상태에 따라 다음 페이지로의 이동가능 여부를 판단하여 UI에 반영하는 것이죠. 모든 페이지가 완료 상태에 도달하면 Finish 버튼이 활성화 되어 마법사를 종료할 수 있습니다. Finish 버튼이 클릭되면 마법사는 각 페이지에서 받은 정보를 바탕으로 원하는 작업을 수행하게 됩니다.
코드레벨에서 살펴보면 마법사는 마법사 클래스와 각 페이지에 해당하는 클래스의 집합으로 구성됩니다. 마법사 클래스는 페이지 클래스를 참조하고 있고 addpages() 함수에서 페이지 클래스를 마법사에 등록합니다.
지금부터는 코드를 가지고 상세구현 과정을 살펴보도록 하겠습니다. 이클립스 플러그인의 시작은 확장점입니다. 마법사를 추가할 수 있는 확장점은 총 3가지가 있는데, 이 글에서는 프로젝트 생성 마법사를 추가하는데 사용되는 org.eclipse.ui.newWizards를 사용하겠습니다. 다음코드는 확장을 정의한 plugin.xml 코드의 일부분입니다.
<extension
point=”org.eclipse.ui.newWizards“>
<category
id=”kr.ac.kaist.vicode”
name=”VICODE”/>
<wizard
canFinishEarly=”false”
category=”kr.ac.kaist.vicode”
class=”kr.ac.kaist.vicode.wizard.NewProjectWizard“
finalPerspective=”kr.ac.kaist.vicode.perspective”
hasPages=”true”
icon=”icons/esterel_image.gif”
id=”kr.ac.kaist.vicode.newprojectwizard”
name=”VICODE Project”
preferredPerspectives=”kr.ac.kaist.vicode.perspective”
project=”true”/>
</extension>
마법사 확장점에는 여러가지 속성이 있습니다. Perspective 관련 속성에는 VICODE perspective의 id를 정의하였습니다. canFinishEarly는 모든 페이지를 다 거치지 않아도 완료할 수 있는 마법사인지를 정의합니다. hasPages는 여러 페이지를 가진 마법사인지를 정의합니다. 예제로 보여드릴 VICODE 프로젝트 생성 마법사는 2페이지로 구성되어 있고 모든 페이지를 거쳐야 하므로 위의 코드와 같이 정의하였습니다.
먼저 마법사 클래스(NewProjectWizard)를 살펴보도록 하겠습니다.
{
private WizardNewProjectCreationPage mainPage;
private WizardInitialPage initialPage;
private IProject newProject;
{
createNewProject();
initialPage.finish(newProject);
return true;
}
{
mainPage = new WizardNewProjectCreationPage(“New VICODE Project (1/2)”);
mainPage.setDescription(“Create a new VICODE project in the workspace”);
mainPage.setTitle(“Create VICODE Project”);
initialPage = new WizardInitialPage(“New VICODE Project (2/2)”);
initialPage.setDescription(“You can specify top module name and communication event.”);
initialPage.setTitle(“Module declaration for hardware and Communication Event”);
addPage(mainPage);
addPage(initialPage);
}
프로젝트 마법사 클래스는 Wizard 클래스와 INewWizard 인터페이스를 상속합니다. 예제 마법사의 목표는 두 페이지에 걸쳐 정보를 받아 들인 후 프로젝트를 생성하는 것 입니다. 총 2페이지로 구성되어 있는데, 첫번째 페이지는 구현하지 않고 이미 작성된 프로젝트 생성 페이지를 가져다가 사용하였습니다. 이 페이지는 단순히 프로젝트 이름과 저장위치를 지정할 수 있도록 구성되어 있습니다. 두 번째 페이지는 VICODE 프로젝트를 생성하는데 있어 필요한 정보를 입력받기 위해 직접 구현한 페이지입니다.
addPages() 메서드에서는 각 페이지의 인스턴스를 생성하고 초기화한 후에 addPage() 메서드를 호출하여 마법사에 각 페이지를 등록합니다. Finish 버튼이 클릭되면 호출되는 performFinish() 메서드에서 마법사 완료시에 필요한 일들을 기술합니다. 실제 프로젝트가 생성되는 코드는 첨부파일을 참조하시기 바랍니다.
지금부터는 두번째 페이지에 해당하는 코드를 살펴 보겠습니다.
{
public void createControl(Composite parent)
{
Composite composite = new Composite(parent, SWT.NONE);
GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = 1;
composite.setLayout(gridLayout);
createModuleNameGroup(composite);
createCommunicationGroup(composite);
setControl(composite);
updatePageComplete();
setMessage(null);
setErrorMessage(null);
}
private void updatePageComplete()
{
setPageComplete(false);
// 페이지의 완결성 체크
if (moduleNameText.getText().equals(“”))
return;
// 페이지의 완결성 체크를 건너 뛰었다면 페이지를 완료상태로 변경
setPageComplete(true);
setMessage(null);
setErrorMessage(null);
}
마법사의 모든 페이지 클래스는 WizardPage 클래스를 상속합니다. UI를 정의하는 다른 클래스와 마찬가지로 createControll() 메서드에서 SWT로 사용자 인터페이스를 작성합니다. 마지막에 호출되는 메서드인 updatePageComplete()는 페이지에 필요한 정보가 입력되어 있는지를 판단하기 위해 제가 작성한 메서드 입니다. 이 메서드는 각 컨트롤에서 값이 변경될때마다 호출되어 페이지가 완료상태인지를 setPageComplete() 메서드를 호출하여 마법사에 알립니다.
이상으로 이클립스 플랫폼에서 마법사를 구현하는 방법에 대해서 말씀드렸습니다. 아래 첨부한 소스코드를 참조하시면 이해하시는데 도움이 될 것 같습니다.
이 글을 감사히 잘읽고 있습니다. 한가지 궁금한게 생겨서 이렇게 답글을 남깁니다.
위자드 생성시 위자드 페이지에 있는 옵션들 중에 하나를 선택할 경우 그 옵션들로 인해 폴더라던지 파일이 만들어지는 것이 달라지는데요. 그럼 폴더나 파일을 만들때 그 옵션을 선택을 하였는지 아님 다른 옵션을 선택하였는지를어떻게 판단할 수 있을까요?
위자드에서 파일이나 폴더를 바로 생성한다면 위자드 클래스의 멤버 필드에 UI에서 설정한 값을 가지고 있으면 되겠죠? 그렇지 않다면 프로젝트에 특화된 속성으로 설정 값을 가지고 있어야 추후에 파일 추가 위자드 등으로 파일을 추가할 때 옵션을 적용해서 파일을 생성할 수 있겠네요. 프로젝트의 특성을 구현하시려면 Property에 대해서 공부하셔야 할 것 같아요. 안타깝게도 블로그에는 그 부분에 대해서 정리해 놓지 않았네요. ^^;