Package com.im.ijc.core.api.views

Interface IJCWidget

  • All Known Subinterfaces:
    IJCWidget.DesignerHandle, IJCWidget.RendererProvider
    public interface IJCWidget
    A widget displayed in an IJC view.

    It can be bound to one or more fields or can be static. An example of static widget is a label or containers for other widgets which are not bound to any fields. Bound widgets are typically associated with one field but can use more than that (cf. table, sheet or charts).

    • Field Detail

      • PROP_SELECTED_FIELDS

        static final java.lang.String PROP_SELECTED_FIELDS
        Property name used when selected fields are changed. E.g. when column selection in the table widget has changed.
        See Also:
        Constant Field Values

    • Method Detail

      • getViewMode

        ViewMode getViewMode()
        Returns:
        active mode of this widget. The mode is changed when user switches it in IJC session, for example by clicking on Design or Browse mode buttons. See PROP_VIEW_MODE property if you are interested in listening on changes.

      • getID

        java.lang.String getID()
        Returns:
        unique identifier of this widget. The context of uniqueness is currently within the view to which the designer handle belongs.

      • getView

        com.im.df.api.ddl.DFView getView()
        Returns view to which this widget belongs.
        Returns:
        the view

      • getBoundFields

        java.util.List<? extends com.im.df.api.ddl.DFField> getBoundFields()
        Returns fields bound by this widgets.
        Returns:
        List of fields. Might be empty but never returns null.

      • isMultipleRow

        boolean isMultipleRow()
        Returns:
        whether a widget is capable of displaying values from more then one row. Example of such widgets are tables, charts, molecule matrix, etc. On the opposite side are e.g. text fields, checkboxes, ..., which are examples of single row only widgets.

      • getVertexState

        com.im.df.api.dml.DFResultSet.VertexState getVertexState()
        Widget can be bound to fields from more then one DFResultSet.VertexState. This method returns "master" VertexState of the widget. Which is selected as master VertexState depends on semantics of particular widget implementations.
        Returns:
        this IJCWidget's master VertexState. Might be null.
        See Also:
        getVertexState(DFField)

      • getVertexState

        com.im.df.api.dml.DFResultSet.VertexState getVertexState​(com.im.df.api.ddl.DFField field)
        Returns VertexState which is mapped to an entity which contains the given field.
        Parameters:
        field - the field for which VertexState is to be found
        Returns:
        the VertexState. Might be null.
        See Also:
        getVertexState()

      • getSelectedFields

        java.util.List<? extends com.im.df.api.ddl.DFField> getSelectedFields()
        Return currently selected fields in this widget. What exactly are those depends on individual widgets implementations. For example table might return fields representing columns for currently selected cells. Text field might simply return the field it represents.

        This property can change, so listen to PROP_SELECTED_FIELDS property changes if you need it.

        Returns:
        currently selected fields

      • getLookup

        org.openide.util.Lookup getLookup()
        Widget lookup contains implementation of inner interfaces that define various capabilities of this widget.
        Returns:
        the lookup

      • addPropertyChangeListener

        void addPropertyChangeListener​(java.beans.PropertyChangeListener listener)

      • removePropertyChangeListener

        void removePropertyChangeListener​(java.beans.PropertyChangeListener listener)