Package com.pnfsoftware.jeb.client.api

Class UnitFragmentPosition

java.lang.Object

com.pnfsoftware.jeb.client.api.UnitFragmentPosition

public class UnitFragmentPosition
extends Object

Position in a unit fragment.

Constructor Summary

Constructors

Constructor	Description
UnitFragmentPosition(IUnit unit, IUnitFragment fragment, IGenericDocument doc, String address, IItem item)	Create a position descriptor.

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Get the active address in the unit fragment.
IGenericDocument	getDoc()	Get the document rendered by the fragment.
IUnitFragment	getFragment()	Get the UI fragment associated with this position.
IItem	getItem()	Get the active item in the unit fragment.
IUnit	getUnit()	Get the unit associated with this position.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UnitFragmentPosition

public UnitFragmentPosition(IUnit unit,
 IUnitFragment fragment,
 IGenericDocument doc,
 String address,
 IItem item)

Create a position descriptor.

Parameters:

unit - unit associated with the position

fragment - fragment associated with the position

doc - optional document rendered by the fragment

address - optional active unit address

item - optional active item

Method Details

getUnit

public IUnit getUnit()

Get the unit associated with this position.

Returns:

non-null unit

getFragment

public IUnitFragment getFragment()

Get the UI fragment associated with this position.

Returns:

non-null UI fragment

getDoc

public IGenericDocument getDoc()

Get the document rendered by the fragment.

Returns:

optional document (some fragments render unit information directly, without making use of documents)

getAddress

public String getAddress()

Get the active address in the unit fragment.

Returns:

optional active address in the unit fragment (in which case the unit likely inherits IAddressableUnit)

getItem

public IItem getItem()

Get the active item in the unit fragment.

Returns:

optional active item in the unit fragment (in which case the unit likely inherits IAddressableUnit)

toString

public String toString()

Overrides:

toString in class Object