NestableInputComponent (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.util
Interface NestableInputComponent

public interface NestableInputComponent

Defines contract that all embedded JCOMPONENTS must implement. IT can be attached to multiple variables. The VID statemeent is like:

JCOMPONENT(VAR1 VAR2 VAR3, fullpackage.ClassName)

Note: current VID framework implements only one var bindings.

Method Summary

String getValue(String variable)
          Get current component value

String getVerificationMessage(String variable)
          Tests current value validity and for valid values it returns null

void joinNest(VariableInputNest nest)
          Request to bind the component to container context.

void leaveNest()
          Request to terminate all connections with container and die (release all listeners, kill threads...).

void setHistoricalValue(String historicalValue)
          Deprecated. does not support multivalued NICes. Also there is already VariableInputNest.getValue()

void updatedVars(Map variables)
          Deprecated. there is already VariableInputNest.getCommandHashtable()

Method Detail

joinNest

public void joinNest(VariableInputNest nest)

Request to bind the component to container context. It's called once before the component is made visible.

getValue

public String getValue(String variable)

Get current component value

Parameters:: variable - name of variable in question

updatedVars

public void updatedVars(Map variables)

Deprecated. there is already VariableInputNest.getCommandHashtable()

Called with the updated map of variables.

Parameters:: variables - The map of variable values by their names

setHistoricalValue

public void setHistoricalValue(String historicalValue)

Deprecated. does not support multivalued NICes. Also there is already VariableInputNest.getValue()

Set a historical value. The component should adapt it's state accodring to the provided value.

Parameters:: historicalValue - The historical value.

getVerificationMessage

public String getVerificationMessage(String variable)

Tests current value validity and for valid values it returns null

Parameters:: variable - name of variable in question

leaveNest

public void leaveNest()

Request to terminate all connections with container and die (release all listeners, kill threads...).