Package io.jmix.reportsui.screen.report.wizard.step

Class StepFragment

java.lang.Object

io.jmix.ui.screen.ScreenFragment

io.jmix.reportsui.screen.report.wizard.step.StepFragment

All Implemented Interfaces:

FrameOwner

Direct Known Subclasses:

DetailsStepFragment, QueryStepFragment, RegionsStepFragment, SaveStepFragment

public abstract class StepFragment
extends ScreenFragment

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.screen.ScreenFragment

ScreenFragment.AfterInitEvent, ScreenFragment.AttachEvent, ScreenFragment.DetachEvent, ScreenFragment.InitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected boolean	validateBeforeNext
protected boolean	validateBeforePrev

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor	Description
StepFragment()

Method Summary

Modifier and Type	Method	Description
void	afterShow()	Entry point for adding functionality after the fragment is shown
void	beforeHide()	Entry point for adding functionality before hiding the fragment
void	beforeShow()	Entry point for adding functionality before showing the fragment
abstract String	getCaption()	Sets the caption for the wizard screen
protected String	getDefaultRequiredMessage(String name)
abstract String	getDescription()	Sets the description for the wizard screen
void	initFragment()
boolean	isValidateBeforeNext()
boolean	isValidateBeforePrev()
List<String>	validateFragment()

Methods inherited from class io.jmix.ui.screen.ScreenFragment

addAfterInitListener, addAttachEventListener, addDetachEventListener, addInitListener, fireEvent, getApplicationContext, getEventHub, getExtensions, getFragment, getHostController, getHostScreen, getId, getScreenData, getUiEventListeners, init, setApplicationContext, setExtensions, setFragment, setHostController, setId, setScreenData, setUiEventListeners

Methods inherited from class java.lang.Object

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

Field Details

messages

@Autowired
protected Messages messages

messageTools

@Autowired
protected MessageTools messageTools

metadata

@Autowired
protected Metadata metadata

validateBeforeNext

protected boolean validateBeforeNext

validateBeforePrev

protected boolean validateBeforePrev

Constructor Details

StepFragment

public StepFragment()

Method Details

getCaption

public abstract String getCaption()

Sets the caption for the wizard screen

Returns:

caption

getDescription

public abstract String getDescription()

Sets the description for the wizard screen

Returns:

description

beforeHide

public void beforeHide()

Entry point for adding functionality before hiding the fragment

beforeShow

public void beforeShow()

Entry point for adding functionality before showing the fragment

afterShow

public void afterShow()

Entry point for adding functionality after the fragment is shown

initFragment

public void initFragment()

validateFragment

public List<String> validateFragment()

isValidateBeforeNext

public boolean isValidateBeforeNext()

isValidateBeforePrev

public boolean isValidateBeforePrev()

getDefaultRequiredMessage

protected String getDefaultRequiredMessage(String name)