public interface DetailViewTab
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INIT_ADAPTER_FOR_DYNAMIC_PAGE_URL
Parameter which determines that the tab adapter should be initialized in
order to get dynamically generated page URL -
DetailViewTabAdapter.findDynamicallyGeneratedPageURL() . |
Modifier and Type | Method and Description |
---|---|
boolean |
appliesTo(Item item)
Check if tab is applicable for current displayed item
|
java.lang.String |
getAdapterClass()
Adapter class name.
|
java.lang.String |
getAdapterId()
Adapter instance ID.
|
DetailTabContext |
getDetailsTabContext()
Get context for tab in detail view
|
java.lang.String |
getImageURL()
Image to be displayed with title for a tab
|
java.lang.String |
getLayout()
HTML file to be displayed inside tab in detail view
|
java.lang.String |
getProfileId() |
java.lang.String |
getTabId()
Get Tab ID.Used while checking visibility
|
java.lang.String |
getTitle()
Title to be displayed for tab in Detail View
|
void |
initAdapterFor(ActionContext detailViewActionContext,
DetailViewTabAdapter tabAdapter)
Initialize adapter with corresponding item.
|
void |
initAdapterForDynPageUrl(ActionContext detailViewActionContext,
DetailViewTabAdapter tabAdapter)
Initialize adapter with corresponding item in order to get the
dynamically generated page URL.
|
boolean |
isModified()
Check if properties are modified
|
boolean |
isReadOnly()
Check if properties are modifiable
|
boolean |
isValid()
Check if tab page validation passed
|
boolean |
isVisible(Item item)
Check for visibility of tab
|
void |
reset()
Reset values in respective Adapters
|
void |
revertProperties()
Rollback from recent changes from user
|
void |
setDetailsTabContext(DetailTabContext detailsTabContext)
Set context for tab in detail view
|
void |
setModified(boolean value)
Mark the Tab Adapter as modified/unmodified
|
void |
setReadOnly(boolean isReadOnly)
Set read only flag for tab in detail view.
|
void |
storeValues()
Store changes from layout in model
|
static final java.lang.String INIT_ADAPTER_FOR_DYNAMIC_PAGE_URL
DetailViewTabAdapter.findDynamicallyGeneratedPageURL()
.java.lang.String getTabId()
java.lang.String getTitle()
boolean isValid()
void setModified(boolean value)
java.lang.String getImageURL()
java.lang.String getLayout()
void initAdapterFor(ActionContext detailViewActionContext, DetailViewTabAdapter tabAdapter)
detailViewActionContext
- Detail view contexttabAdapter
- Adpater for the layoutvoid initAdapterForDynPageUrl(ActionContext detailViewActionContext, DetailViewTabAdapter tabAdapter)
DetailViewTabAdapter.findDynamicallyGeneratedPageURL()
will be
called immediately after.detailViewActionContext
- Detail view contexttabAdapter
- Adpater for the layoutjava.lang.String getAdapterClass()
java.lang.String getAdapterId()
boolean appliesTo(Item item) throws java.lang.Exception
item
- Item displayed in detail viewjava.lang.Exception
boolean isVisible(Item item)
boolean isModified()
boolean isReadOnly()
void setReadOnly(boolean isReadOnly)
isReadOnly
- void storeValues()
void revertProperties()
void reset()
void setDetailsTabContext(DetailTabContext detailsTabContext)
detailsTabContext
- DetailTabContext getDetailsTabContext()
java.lang.String getProfileId()