Class EmbeddedDisplayWidget
- java.lang.Object
-
- org.csstudio.display.builder.model.Widget
-
- org.csstudio.display.builder.model.widgets.VisibleWidget
-
- org.csstudio.display.builder.model.widgets.MacroWidget
-
- org.csstudio.display.builder.model.widgets.EmbeddedDisplayWidget
-
public class EmbeddedDisplayWidget extends MacroWidget
Widget that shows another display inside itself
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EmbeddedDisplayWidget.Resize
Resize behavior
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_HEIGHT
static int
DEFAULT_WIDTH
static org.csstudio.display.builder.model.WidgetPropertyDescriptor<DisplayModel>
runtimeModel
static org.csstudio.display.builder.model.WidgetDescriptor
WIDGET_DESCRIPTOR
Widget descriptor-
Fields inherited from class org.csstudio.display.builder.model.Widget
BASE_WIDGET_VERSION, USER_DATA_REPRESENTATION, USER_DATA_RUNTIME, USER_DATA_SCRIPT_SUPPORT, USER_DATA_TOOLKIT_PARENT
-
-
Constructor Summary
Constructors Constructor Description EmbeddedDisplayWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.csstudio.display.builder.model.WidgetConfigurator
getConfigurator(org.csstudio.display.builder.model.Version persisted_version)
Obtain configurator.Macros
getEffectiveMacros()
Widget extends parent macrosWidgetProperty<?>
getProperty(java.lang.String name)
Get widget property.WidgetProperty<java.lang.String>
propFile()
WidgetProperty<java.lang.String>
propGroupName()
WidgetProperty<EmbeddedDisplayWidget.Resize>
propResize()
WidgetProperty<java.lang.Boolean>
propTransparent()
WidgetProperty<DisplayModel>
runtimePropEmbeddedModel()
-
Methods inherited from class org.csstudio.display.builder.model.widgets.MacroWidget
importPVName, propMacros
-
Methods inherited from class org.csstudio.display.builder.model.widgets.VisibleWidget
propTooltip, propVisible, runtimePropConnected
-
Methods inherited from class org.csstudio.display.builder.model.Widget
checkDisplayModel, checkProperty, checkProperty, clearUserData, expandPropertyNames, getDisplayModel, getID, getMacrosOrProperties, getName, getParent, getProperties, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getVersion, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Field Detail
-
DEFAULT_WIDTH
public static final int DEFAULT_WIDTH
- See Also:
- Constant Field Values
-
DEFAULT_HEIGHT
public static final int DEFAULT_HEIGHT
- See Also:
- Constant Field Values
-
WIDGET_DESCRIPTOR
public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
Widget descriptor
-
runtimeModel
public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<DisplayModel> runtimeModel
-
-
Method Detail
-
getProperty
public WidgetProperty<?> getProperty(java.lang.String name) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
Description copied from class:Widget
Get widget property.Meant for rules, scripts and similar code which does not know the exact widget type and thus fetches properties by name.
Supports access to complex properties by path name, for example "y_axes[1].minimum" to get the minimum property of the second Y axis of a plot.
To allow use of legacy scripts and rules, the widget implementation may override to handle deprecated property names.
Caller presumes that the widget actually has the requested property, otherwise throwing Exception.
- Overrides:
getProperty
in classWidget
- Parameters:
name
- Property name- Returns:
WidgetProperty
- Throws:
java.lang.IllegalArgumentException
- if property is unknownjava.lang.IndexOutOfBoundsException
- See Also:
Widget.checkProperty(String)
-
getEffectiveMacros
public Macros getEffectiveMacros()
Description copied from class:MacroWidget
Widget extends parent macros- Overrides:
getEffectiveMacros
in classMacroWidget
- Returns:
Macros
-
propFile
public WidgetProperty<java.lang.String> propFile()
- Returns:
- 'file' property
-
propResize
public WidgetProperty<EmbeddedDisplayWidget.Resize> propResize()
- Returns:
- 'resize' property
-
propGroupName
public WidgetProperty<java.lang.String> propGroupName()
- Returns:
- 'group_name' property
-
runtimePropEmbeddedModel
public WidgetProperty<DisplayModel> runtimePropEmbeddedModel()
- Returns:
- Runtime 'model' property for the embedded display
-
propTransparent
public WidgetProperty<java.lang.Boolean> propTransparent()
- Returns:
- 'transparent' property
-
getConfigurator
public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator(org.csstudio.display.builder.model.Version persisted_version) throws java.lang.Exception
Description copied from class:Widget
Obtain configurator.While typically using the default
WidgetConfigurator
, widget may provide a different configurator for reading older persisted date.- Overrides:
getConfigurator
in classWidget
- Parameters:
persisted_version
- Version of the persisted data.- Returns:
- Widget configurator for that version
- Throws:
java.lang.Exception
- if persisted version cannot be handled
-
-