org.pm4j.core.pm
Interface PmTabSet

All Superinterfaces:
java.lang.Comparable<PmObject>, PmDataInput, PmElement, PmObject, PmTreeNode
All Known Implementing Classes:
PmTabSetImpl

public interface PmTabSet
extends PmElement

A PM for a multi tab set.

The child PmElements are of a PmTabSet can be used to represent the content of tabs.

Child elements act as tab, simply if they are used in a tab view. See the documentation of the related views for more view technology related usage hints.

ATTENTION: Current JSF limitation:
The id (name) of the tab set should be unique within the PM tree.
If there are other PMs with the same identifier within the faces tree, the corresponding faces component can't be found.

This limitation should not be harmful if you use an expressive name for a named object or sub-element that acts as a tab set.

Author:
olaf boede

Field Summary
 
Fields inherited from interface org.pm4j.core.pm.PmObject
STYLE_CLASS_DISABLED, STYLE_CLASS_ERROR, STYLE_CLASS_INFO, STYLE_CLASS_REQUIRED, STYLE_CLASS_WARN
 
Method Summary
 boolean switchToTabPm(PmElement fromTab, PmElement toTab)
          This method gets called whenever the user or internal UI logic attempts to switch from one opened tab to another one.
 
Methods inherited from interface org.pm4j.core.pm.PmElement
getPmAttribute, getPmAttributes, getPmKey
 
Methods inherited from interface org.pm4j.core.pm.PmDataInput
commitBufferedPmChanges, isBufferedPmValueMode, isPmValueChanged, pmValidate, resetPmValues, rollbackBufferedPmChanges
 
Methods inherited from interface org.pm4j.core.pm.PmTreeNode
getNodeDetailsPm, getPmChildNodes, isPmTreeLeaf
 
Methods inherited from interface org.pm4j.core.pm.PmObject
accept, canSetPmTitle, compareTo, getPmConversation, getPmIconPath, getPmName, getPmParent, getPmProperty, getPmRelativeName, getPmShortTitle, getPmStyleClasses, getPmTitle, getPmTooltip, isPmEnabled, isPmReadonly, isPmValid, isPmVisible, setPmEnabled, setPmParent, setPmProperty, setPmTitle, setPmVisible
 

Method Detail

switchToTabPm

boolean switchToTabPm(PmElement fromTab,
                      PmElement toTab)
This method gets called whenever the user or internal UI logic attempts to switch from one opened tab to another one.

This method may prevent the tab switch operation by returning false.

ATTENTION: This method is not intended for overriding!
Please define specific tab switch logic by overriding PmTabSetImpl.switchToTabPmImpl(PmElement, PmElement).

Parameters:
fromTab - The currently opened tab.
toTab - The tab to switch to.
Returns:
true if the PM logic implementation allows the tab switch.
false if the PM logic implementation prevents the tab switch.