Package com.pnfsoftware.jeb.client.api
Interface IUnitView
public interface IUnitView
Basic definition of a view, visually representing a
unit
. A client may have 0, 1,
or many views representing a given unit. Each view aggregates fragments representing documents
generated by the unit, such as texts, tables, trees, etc.-
Method Summary
Modifier and TypeMethodDescriptionGet the active fragment of the view.getFragmentLabel
(IUnitFragment fragment) Get the optional fragment label.List<? extends IUnitFragment>
Get the fragments of units represented by this view.getLabel()
Get the view label.getUnit()
Get the unit represented by this view.void
setActiveFragment
(IUnitFragment fragment) Set which fragment of the view should be active.void
setFocus()
Bring the current view into focus.void
setFragmentLabel
(IUnitFragment fragment, String label) Set the fragment label.void
Set the view label.
-
Method Details
-
getLabel
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
-
setLabel
Set the view label.- Parameters:
label
-
-
setFocus
void setFocus()Bring the current view into focus. If the view is hidden, it should be brought up front. -
getUnit
IUnit getUnit()Get the unit represented by this view.- Returns:
- the unit
-
getFragments
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
-
setActiveFragment
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).- Parameters:
fragment
-
-
getActiveFragment
IUnitFragment getActiveFragment()Get the active fragment of the view.- Returns:
-
getFragmentLabel
Get the optional fragment label.- Parameters:
fragment
-- Returns:
-
setFragmentLabel
Set the fragment label.- Parameters:
fragment
-label
-
-