Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.component.frame

DialogFrame

The class is still in Beta and is subject to API changes.
Extends caplin.component.frame.ComponentFrame.
Instances of DialogFrame are used to wrap components displayed within floating windows. These are created automatically when caplin.component.frame.FrameManager#openDialog is invoked, but may also be created by composite components that embed other components within them.

Constructor Summary

Attributes Name and Description
caplin.component.frame.DialogFrame()

Method Summary

Attributes Name and Description
void resize(int nWidth, int nHeight)

Resize the dialog window.
void setClosable(boolean bClosable)

Sets whether the dialog can be closed or not.
void setHeading(String sHeading)

Sets the heading text for the dialog frame.
void setSubHeading(String sSubHeading)

Sets the sub heading text for the dialog frame.
Methods inherited from class caplin.component.frame.ComponentFrame:
addToMenu, close, getComponent, getFrameManager, getMenu, getTitleBarElement, setComponentModified, setTitle

Constructor Detail

► caplin.component.frame.DialogFrame()

Method Detail

► void resize(int nWidth, int nHeight)

Resize the dialog window.

Parameters
int nWidth The new width of the dialog.
int nHeight The new height of the dialog.

► void setClosable(boolean bClosable)

Sets whether the dialog can be closed or not.

Parameters
boolean bClosable True if the dialog can be closed, false otherwise.

► void setHeading(String sHeading)

Sets the heading text for the dialog frame.

Parameters
String sHeading the text which heading will be set to.

► void setSubHeading(String sSubHeading)

Sets the sub heading text for the dialog frame.

Parameters
String sSubHeading the text which sub-heading will be set to.