javax.swing
클래스 TransferHandler

java.lang.Object 
  javax.swing.TransferHandler

모든 구현된 인터페이스:

Serializable

public class TransferHandler
extends Object 
implements Serializable 

이 클래스는 Swing 컴퍼넌트에 대한 Transferable 전송 처리에 사용합니다. Transferable은 컷, 카피, 페이스트등을 통해서 클립보드에 보내는 데이터 또는 클립보드로부터 받는 데이터를 나타내기 위해서 사용합니다. 또, 드래그＆드롭 조작으로 컴퍼넌트로부터의 드래그 및 컴퍼넌트에의 드롭을 나타내기 위해서 사용합니다. Swing 에는 이 클래스의 구현에 의해 제공되는 기능을 사용하는 컷, 카피, 페이스트의 키보드 바인딩을 자동적으로 지원하는 기능이 준비되어 있습니다. 또, 드래그＆드롭에 대해서도와 같이 자동적으로 지원 됩니다. Swing 개발자는 주로 Swing 컴퍼넌트로 transferHandler 프로퍼티를 설정하는 것으로써, 전송의 시멘틱스를 지정하는 작업에 집중할 수 있습니다.

이 클래스는 생성자 프로퍼티명을 지정하는 것만으로 디폴트의 동작으로서 컴퍼넌트의 프로퍼티를 전송 하도록 구현됩니다. 예를 들어 클립보드나 드래그 & 드래그 조작에 의해 컴퍼넌트간에 foreground color를 전송 하려면, 캐릭터 라인 「foreground」를 사용해 TransferHandler를 구축합니다. 빌트인 지원은 getForeground에 의해 리턴된 컬러를 전송원으로서 사용해, setForeground를 전송 먼저 사용합니다.

자세한 것은 「The Java Tutorial」의 「How to Use Drag and Drop and Data Transfer」를 참조하십시오.

도입된 버전 :

1.4

필드 개요

static int	COPY 「copy」의 전송 액션을 나타내는 int 입니다.
static int	COPY_OR_MOVE 「copy」또는 「move」의 소스 액션 기능을 나타내는 int 입니다.
static int	MOVE 「move」의 전송 액션을 나타내는 int 입니다.
static int	NONE 전송 액션을 하지 않는 것을 나타내는 int 입니다.

생성자 개요

protected	TransferHandler () 서브 클래스의 간이 생성자 입니다.
	TransferHandler (String property) 클립보드 또는 드래그＆드롭 조작에 의해 컴퍼넌트간의 Java Bean 프로퍼티를 전송 할 수 있는 전송 핸들러를 구축합니다.

메서드 개요

boolean	canImport (JComponent comp, DataFlavor [] transferFlavors) 컴퍼넌트가 실제로 일련의 데이타플레이버 의 임포트를 시도하기 전에 데이타플레이버 의 임포트를 받아들일지 어떨지를 나타냅니다.
protected Transferable	createTransferable (JComponent c) 데이터 전송의 소스로서 사용하는 Transferable을 작성합니다.
void	exportAsDrag (JComponent comp, InputEvent e, int action) Swing 드래그 지원를 개시합니다.
protected void	exportDone (JComponent source, Transferable data, int action) 데이터의 export 후에 호출합니다.
void	exportToClipboard (JComponent comp, Clipboard clip, int action) 지정된 컴퍼넌트가 지정된 클립보드에 전송 합니다.
static Action	getCopyAction () 「copy」조작과 같이 동작하는 Action을 리턴합니다.
static Action	getCutAction () 「cut」조작과 같이 동작하는 Action을 리턴합니다.
static Action	getPasteAction () 「paste」조작과 같이 동작하는 Action을 리턴합니다.
int	getSourceActions (JComponent c) 소스가 지원하는 전송 액션의 종류를 리턴합니다.
Icon	getVisualRepresentation (Transferable t) 전송의 외관을 설정하는 객체를 리턴합니다.
boolean	importData (JComponent comp, Transferable t) 클립보드 또는 DND 드롭 조작으로부터 컴퍼넌트에 전송 합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

필드의 상세

NONE

public static final int NONE

전송 액션을 하지 않는 것을 나타내는 int 입니다.

관련 항목:

정수 필드값

COPY

public static final int COPY

「copy」의 전송 액션을 나타내는 int 입니다. 데이터가 클립보드에 카피되었을 때, 또는 드래그＆드롭 조작으로 다른 장소에 카피되었을 때에 사용됩니다.

관련 항목:

정수 필드값

MOVE

public static final int MOVE

「move」의 전송 액션을 나타내는 int 입니다. 데이터가 클립보드에 이동 (컷)되었을 때, 또는 드래그＆드롭 조작으로 다른 장소에 이동되었을 때에 사용됩니다.

관련 항목:

정수 필드값

COPY_OR_MOVE

public static final int COPY_OR_MOVE

「copy」또는 「move」의 소스 액션 기능을 나타내는 int 입니다.

관련 항목:

정수 필드값

생성자 상세

TransferHandler

public TransferHandler(String  property)

클립보드 또는 드래그＆드롭 조작에 의해 컴퍼넌트간의 Java Bean 프로퍼티를 전송 할 수 있는 전송 핸들러를 구축합니다.

파라미터:

property - 전송 하는 프로퍼티의 이름. 다른 종류의 전송을 처리하는 서브 클래스 등, 전송 핸들러에 관련된 프로퍼티가 없는 경우는 null

TransferHandler

protected TransferHandler()

서브 클래스의 간이 생성자 입니다.

메서드의 상세

getCutAction

public static Action  getCutAction()

「cut」조작과 같이 동작하는 Action을 리턴합니다. 즉, ActionEvent 소스인 JComponent에 관련된 TransferHandler로 MOVE인수를 사용해 exportToClipboard를 호출합니다.

반환값:

cut Action

getCopyAction

public static Action  getCopyAction()

「copy」조작과 같이 동작하는 Action을 리턴합니다. 즉, ActionEvent 소스인 JComponent에 관련된 TransferHandler로 COPY인수를 사용해 exportToClipboard를 호출합니다.

반환값:

cut Action

getPasteAction

public static Action  getPasteAction()

「paste」조작과 같이 동작하는 Action을 리턴합니다. 즉, ActionEvent 소스인 JComponent에 관련된 TransferHandler로 importData를 호출합니다.

반환값:

cut Action

exportAsDrag

public void exportAsDrag(JComponent  comp,
                         InputEvent  e,
                         int action)

Swing 드래그 지원를 개시합니다. 컴퍼넌트로 dragEnabled 프로퍼티가 설정되어 있는 경우, javax.swing.plaf.basic 패키지의 다양한 UI 구현으로부터, 이 메서드가 호출됩니다. UI 커스텀 구현으로부터 호출해, Swing 드래그 지원를 사용할 수 있습니다. 또, JComponent 서브 클래스로서 기술되는 Swing 확장으로부터 호출해, Swing 드래그 지원 의 기능을 이용할 수 있습니다.

이 메서드의 호출이 돌아오는 시점에서 전송이 완료하고 있을 필요는 없습니다. 즉, 이 메서드의 호출에의해 드롭의 대기를 방해할 수 있을 것은 없습니다. 전송은, java.awt.dnd 도구 의 Swing 구현을 사용해 실행되어 개발자가 그 이상 처리를 추가할 필요는 없습니다. 전송이 완료하면, exportDone 메서드가 호출됩니다.

파라미터:

comp - 전송 데이터를 보관 유지하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandler를 공유하기 위해서 사용하는 인수

e - 전송을 트리거 한 이벤트

action - 최초로 요구된 전송 액션. 값은 COPY 또는 MOVE로 드래그 조작중으로 변경되는 일도 있다

exportToClipboard

public void exportToClipboard(JComponent  comp,
                              Clipboard  clip,
                              int action)
                       throws IllegalStateException 

지정된 컴퍼넌트가 지정된 클립보드에 전송 합니다. 이 메서드는 컴퍼넌트의 액션 맵에 등록되어 있는 디폴트의 컷 액션 또는 카피 액션으로 호출합니다.

전송은, java.awt.datatransfer 도구를 사용해 실행되어 개발자가 그 이상 처리를 추가할 필요는 없습니다. 데이터 전송이 모두 완료하면, 이 메서드가 복귀하기 전에 발생한 액션으로 exportDone 메서드가 호출됩니다. 데이터를 클립보드에 붙이려고 했을 때에 클립보드를 사용할 수 없는 경우는 Clipboard.setContents(Transferable, ClipboardOwner) 에 의해 Throw 된 IllegalStateException가 이 메서드를 개입시켜 전파 됩니다. 다만, 일관성을 유지하기 위해서 exportDone는 우선 NONE 라고 하는 액션으로 호출합니다.

파라미터:

comp - 전송 데이터를 보관 유지하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandler를 공유하기 위해서 사용하는 인수

clip - 데이터의 전송처의 클립보드

action - 최초로 요구된 전송 액션. 값은 COPY 또는 MOVE. 실행되는 조작은 getSourceActions 에 한 전송 기능이라고 요구된 액션에 한 전송 기능의 공통 부분. 요구된 액션이 지원 되어 있지 않은 경우, 공통 액션은 NONE

예외:

IllegalStateException - 클립보드가 현재 사용할 수 없는 경우

관련 항목:

Clipboard.setContents(Transferable, ClipboardOwner)

importData

public boolean importData(JComponent  comp,
                          Transferable  t)

클립보드 또는 DND 드롭 조작으로부터 컴퍼넌트에 전송 합니다. Transferable은 컴퍼넌트에 임포트 되는 데이터를 나타냅니다.

파라미터:

comp - 전송을 수신하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandler를 공유하기 위해서 사용하는 인수

t - 임포트 하는 데이터

반환값:

데이터가 컴퍼넌트에 삽입되었을 경우는 true, 그렇지 않은 경우는 false

canImport

public boolean canImport(JComponent  comp,
                         DataFlavor [] transferFlavors)

컴퍼넌트가 실제로 일련의 데이타플레이버 의 임포트를 시도하기 전에 데이타플레이버 의 임포트를 받아들일지 어떨지를 나타냅니다.

파라미터:

comp - 전송을 수신하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandlers를 공유하기 위해서 사용하는 인수

transferFlavors - 유효한 데이터 형식

반환값:

데이터를 컴퍼넌트에 삽입할 수 있는 경우는 true, 그렇지 않은 경우는 false

getSourceActions

public int getSourceActions(JComponent  c)

소스가 지원하는 전송 액션의 종류를 리턴합니다. 가변이 아닌 모델도 존재해, 그러한 모델에서는 COPY 전송 액션만을 사용할 수 있습니다.

파라미터:

c - 전송 데이터를 보관 유지하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandler를 공유하기 위해서 사용하는 인수

반환값:

전송 프로퍼티가 발견되었을 경우는 COPY, 그렇지 않은 경우는 NONE. 반환값이 NONE인 경우, 해당의 컴퍼넌트로부터의 전송은 모두 무효

getVisualRepresentation

public Icon  getVisualRepresentation(Transferable  t)

전송의 외관을 설정하는 객체를 리턴합니다. 이 메서드는 드래그 조작중에 피드백을 제공하는 경우와 비주얼 표시되는 클립보드의 구현으로 전송을 표현하는 경우에 편리합니다. Icon인터페이스의 구현에서는 그래픽 클립이나 알파 레벨을 변경할 수 없습니다.자식아이콘의 구현은 구형일 필요는 없고, 경계의 구형을 모두 페인트 할 필요도 없습니다. 또,자식아이콘의 페인트 메서드를 호출하는 논리에서는 모든 비트가 페인트 되고 있는 것을 상정 해서는 안됩니다. 이 메서드의 반환값으로서는 null도 용서되어 비주얼 표현이 설정되어 있지 않은 것을 나타냅니다. 그 경우, 호출 논리에서는 Transferable를 자유롭게 나타낼 수가 있습니다.

null이 돌려주고졌을 경우, 디폴트의 Swing 논리에서는 알파 합성된 드래그 애니메이션은 실행되지 않습니다.

파라미터:

t - 전송 되는 데이터. createTransferable 메서드에 의해 작성이 끝난 상태이라고 상정

반환값:

디폴트의 비주얼 표현이 없는 것을 나타내는 null

createTransferable

protected Transferable  createTransferable(JComponent  c)

데이터 전송의 소스로서 사용하는 Transferable을 작성합니다. 전송 하는 데이터의 표현을 리턴합니다. 컴퍼넌트의 프로퍼티가 null인 경우는 null을 리턴합니다.

파라미터:

c - 전송 데이터를 보관 유지하는 컴퍼넌트. 복수의 컴퍼넌트로 TransferHandler를 공유하기 위해서 사용하는 인수

반환값:

전송 하는 데이터의 표현. c에 관련된 프로퍼티가 null인 경우는 null

exportDone

protected void exportDone(JComponent  source,
                          Transferable  data,
                          int action)

데이터의 export 후에 호출합니다. 이 메서드는 액션이 MOVE인 경우에 전송 된 데이터를 삭제합니다.

MOVE는 이 구현에 지원 되는 액션이 아니기 때문에 이 메서드의 구현에서는 아무것도 행해지지 않습니다. getSourceActions에는 MOVE가 포함되지 않습니다.

파라미터:

source - 데이터의 소스인 컴퍼넌트

data - 전송 된 데이터. 액션이 NONE인 경우는 null

action - 실제로 실행된 액션