com.im.ijc.core.api.views
Interface IJCWidget

All Known Subinterfaces:

IJCWidget.DesignerHandle, IJCWidget.RendererProvider

public interface IJCWidget

A widget displayed in form. It can be bound to field(s) or static. An example of static widget is a label or containers for other widgets. Binding widgets are typically associated with one field but can use more than that (cf. table, sheet or charts). TODO P2 - javadoc

Nested Class Summary

static interface	IJCWidget.Breakable Extension to a widget that is notified when widget become invisible and visible again.
static interface	IJCWidget.Cacheable Interface helper to reset cached renderer's widget.
static interface	IJCWidget.Configurable Interface helper to save renderer's widget customizable settings.
static interface	IJCWidget.Customizable<S>
static interface	IJCWidget.DesignerHandle
static interface	IJCWidget.Editable Extension of IJCWidget which allows to invoke start editing of selected data.
static interface	IJCWidget.GroupCustomizable<N extends Node> Support for widget customization performed on multi-selection of widgets.
static interface	IJCWidget.HyperlinkAble Interface helper to follow hyperlinks on/from renderer's widget.
static interface	IJCWidget.Popupable Definition of popup for browse mode.
static interface	IJCWidget.Queryable Implementation of query support provided in widget lookup.
static interface	IJCWidget.Releaseable Interface to set widget releasable.
static interface	IJCWidget.RendererCallback Interface to set widget callback to renderer.
static interface	IJCWidget.RendererProvider
static interface	IJCWidget.Updateable Interface helper to update renderer's widget.
static interface	IJCWidget.Viewable Extension of IJCWidget which allows to show detail of the selected data.
static interface	IJCWidget.WidgetContainerHandle<S> Interface helper providing data about container widget.

Field Summary

static String	PROP_BOUND_FIELDS
static String	PROP_SELECTED_FIELDS
static String	PROP_VERTEX_STATE
static String	PROP_VIEW
static String	PROP_VIEW_MODE

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener)
List<? extends DFField>	getBoundFields() Returns fields bound by this widgets.
AbstractViewTopComponent	getForm()
Lookup	getLookup() Widget lookup contains implementation of inner interfaces that define various capabilities of this widget.
List<? extends DFField>	getSelectedFields() Return currently selected fields in the opened view.
DFResultSet.VertexState	getVertexState() Return this IJCWidget's active vertex state.
DFView	getView()
ViewMode	getViewMode()
boolean	isMultipleRow() TODO this method can be removed, it's mean only whether or not the component support field binding
void	removePropertyChangeListener(PropertyChangeListener listener)

Field Detail

PROP_VIEW_MODE

static final String PROP_VIEW_MODE

See Also:

Constant Field Values

PROP_VIEW

static final String PROP_VIEW

See Also:

Constant Field Values

PROP_BOUND_FIELDS

static final String PROP_BOUND_FIELDS

See Also:

Constant Field Values

PROP_VERTEX_STATE

static final String PROP_VERTEX_STATE

See Also:

Constant Field Values

PROP_SELECTED_FIELDS

static final String PROP_SELECTED_FIELDS

See Also:

Constant Field Values

Method Detail

getViewMode

ViewMode getViewMode()

getView

DFView getView()

getBoundFields

List<? extends DFField> getBoundFields()

Returns fields bound by this widgets.

Returns:

List of fields. Might be empty but never returns null.

getForm

AbstractViewTopComponent getForm()

isMultipleRow

boolean isMultipleRow()

TODO this method can be removed, it's mean only whether or not the component support field binding

getVertexState

DFResultSet.VertexState getVertexState()

Return this IJCWidget's active vertex state.

getSelectedFields

List<? extends DFField> getSelectedFields()

Return currently selected fields in the opened view. This property can change, so listen to PROP_SELECTED_FIELDS property changes if you need it.

getLookup

Lookup getLookup()

Widget lookup contains implementation of inner interfaces that define various capabilities of this widget.

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)