public interface

IUnitView

com.pnfsoftware.jeb.client.api.IUnitView

Class Overview

Basic definition of a view, visually representing a unit. A client may have 0, 1, or many views representing a given unit.

Summary

Public Methods
abstract IUnitFragment getActiveFragment()
Get the active fragment of the view.
abstract String getFragmentLabel(IUnitFragment fragment)
Get the optional fragment label.
abstract List<? extends IUnitFragment> getFragments()
Get the fragments of units represented by this view.
abstract String getLabel()
Get the view label.
abstract IUnit getUnit()
Get the unit represented by this view.
abstract void setActiveFragment(IUnitFragment fragment)
Set which fragment of the view should be active.
abstract void setFocus()
Bring the current view into focus.
abstract void setFragmentLabel(IUnitFragment fragment, String label)
Set the fragment label.
abstract void setLabel(String label)
Set the view label.

Public Methods

public abstract IUnitFragment getActiveFragment ()

Get the active fragment of the view.

public abstract String getFragmentLabel (IUnitFragment fragment)

Get the optional fragment label.

public abstract List<? extends IUnitFragment> getFragments ()

Get the fragments of units represented by this view. Fragments can be used to present documents generated by the unit, or display regions or various representations of a unit. A view should have at least one fragment, even though that fragment may physically occupy the entire view.

Returns
  • a list of fragments

public abstract String getLabel ()

Get the view label. Typically, the view label is used to briefly describe a view and may be displayed in a title bar.

Returns
  • the label

public abstract IUnit getUnit ()

Get the unit represented by this view.

Returns
  • the unit

public abstract void setActiveFragment (IUnitFragment fragment)

Set which fragment of the view should be active. The active fragment is the primary one and/or is visible and has the focus (assuming the holding view is itself visible).

public abstract void setFocus ()

Bring the current view into focus. If the view is hidden, it should be brought up front.

public abstract void setFragmentLabel (IUnitFragment fragment, String label)

Set the fragment label.

public abstract void setLabel (String label)

Set the view label.