Constructor Detail

• SwtMetawidget

  public SwtMetawidget(org.eclipse.swt.widgets.Composite parent,
               int style)

Method Detail

• setToInspect

  public void setToInspect(Object toInspect)

  Sets the Object to inspect.

  If setPath has not been set, or points to a previous setToInspect, sets it to point to the given Object.

• updateToInspectWithoutInvalidate

  public void updateToInspectWithoutInvalidate(Object toInspect)

  Updates the Object to inspect, without invalidating the previous inspection results.

  This is an internal API exposed for WidgetProcessor rebinding support. Clients should not call it directly.

• getToInspect

  public <T> T getToInspect()

  Gets the Object being inspected.

  Exposed for binding implementations.

  Returns:

  the object. Note this return type uses generics, so as to not require a cast by the caller (eg. Person p = getToInspect())

• setPath

  public void setPath(String path)

  Sets the path to be inspected.

• getInspectionPath

  public String getInspectionPath()

• setConfig

  public void setConfig(String config)

• setInspector

  public void setInspector(Inspector inspector)

• inspect

  public String inspect(Object toInspect,
               String type,
               String... names)

  Useful for WidgetBuilders to perform nested inspections (eg. for Collections).

• addInspectionResultProcessor

  public void addInspectionResultProcessor(InspectionResultProcessor<SwtMetawidget> inspectionResultProcessor)

• removeInspectionResultProcessor

  public void removeInspectionResultProcessor(InspectionResultProcessor<SwtMetawidget> inspectionResultProcessor)

• setInspectionResultProcessors

  public void setInspectionResultProcessors(InspectionResultProcessor<SwtMetawidget>... inspectionResultProcessors)

• setWidgetBuilder

  public void setWidgetBuilder(WidgetBuilder<org.eclipse.swt.widgets.Control,SwtMetawidget> widgetBuilder)

• addWidgetProcessor

  public void addWidgetProcessor(WidgetProcessor<org.eclipse.swt.widgets.Control,SwtMetawidget> widgetProcessor)

• removeWidgetProcessor

  public void removeWidgetProcessor(WidgetProcessor<org.eclipse.swt.widgets.Control,SwtMetawidget> widgetProcessor)

• setWidgetProcessors

  public void setWidgetProcessors(WidgetProcessor<org.eclipse.swt.widgets.Control,SwtMetawidget>... widgetProcessors)

• getWidgetProcessor

  public <T> T getWidgetProcessor(Class<T> widgetProcessorClass)

• setMetawidgetLayout

  public void setMetawidgetLayout(Layout<org.eclipse.swt.widgets.Control,org.eclipse.swt.widgets.Composite,SwtMetawidget> layout)

  Set the layout for this Metawidget.

  Named setMetawidgetLayout, rather than the usual setLayout, because SWT already defines a setLayout. Overloading SWT's setLayout was considered cute, but ultimately confusing and dangerous. For example, what should setLayout( null ) do?

• setBundle

  public void setBundle(ResourceBundle bundle)

• getLabelString

  public String getLabelString(Map<String,String> attributes)

  Returns a label for the given set of attributes.

  The label is determined using the following algorithm:

  • if attributes.get( "label" ) exists...
    • attributes.get( "label" ) is camel-cased and used as a lookup into getLocalizedKey( camelCasedLabel ). This means developers can initially build their UIs without worrying about localization, then turn it on later
    • if no such lookup exists, return attributes.get( "label" )
  • if attributes.get( "label" ) does not exist...
    • attributes.get( "name" ) is used as a lookup into getLocalizedKey( name )
    • if no such lookup exists, return attributes.get( "name" )

• getLocalizedKey

  public String getLocalizedKey(String key)

  Returns:

  null if no bundle, ???key??? if bundle is missing a key

• isReadOnly

  public boolean isReadOnly()

• setReadOnly

  public void setReadOnly(boolean readOnly)

• getMaximumInspectionDepth

  public int getMaximumInspectionDepth()

• setMaximumInspectionDepth

  public void setMaximumInspectionDepth(int maximumInspectionDepth)

• getValue

  public <T> T getValue(String... names)

  Gets the value from the Control with the given name.

  The value is returned as it was stored in the Control (eg. String for JTextField) so may need some conversion before being reapplied to the object being inspected. This obviously requires knowledge of which Control SwtMetawidget created, which is not ideal, so clients may prefer to use a binding WidgetProcessor instead.

  Returns:

  the value. Note this return type uses generics, so as to not require a cast by the caller (eg. String s = getValue(names))

• setValue

  public void setValue(Object value,
              String... names)

  Sets the Control with the given name to the specified value.

  Clients must ensure the value is of the correct type to suit the Control (eg. String for JTextField). This obviously requires knowledge of which Control SwtMetawidget created, which is not ideal, so clients may prefer to use a binding WidgetProcessor instead.

• getValueProperty

  public String getValueProperty(org.eclipse.swt.widgets.Control control)

  Returns the property used to get/set the value of the control.

  If the control is not known, returns null. Does not throw an Exception, as we want to fail gracefully if, say, someone tries to bind to a JPanel.

• getControl

  public <T extends org.eclipse.swt.widgets.Control> T getControl(String... names)

  Finds the Control with the given name.

• getFacet

  public Facet getFacet(String name)

• getCurrentLayoutComposite

  public org.eclipse.swt.widgets.Composite getCurrentLayoutComposite()

  This method is public for use by WidgetBuilders to attach Controls to the current Composite as defined by the Layout. This allows the Layout to introduce new Composites, such as for TabFolders.

• getLayout

  public org.eclipse.swt.widgets.Layout getLayout()

  Overrides:

  getLayout in class org.eclipse.swt.widgets.Composite

• getChildren

  public org.eclipse.swt.widgets.Control[] getChildren()

  Overrides:

  getChildren in class org.eclipse.swt.widgets.Composite

• newPipeline

  protected SwtMetawidget.Pipeline newPipeline()

  Instantiate the Pipeline used by this Metawidget.

  Subclasses wishing to use their own Pipeline should override this method to instantiate their version.

• getDefaultConfiguration

  protected String getDefaultConfiguration()

• invalidateInspection

  protected void invalidateInspection()

  Invalidates the current inspection result (if any) and invalidates the widgets.

  As an optimisation we only invalidate the widgets, not the entire inspection result, for some operations (such as adding/removing stubs, changing read-only etc.)

• invalidateWidgets

  protected void invalidateWidgets()

  Invalidates the widgets.

• buildWidgets

  protected void buildWidgets()

• layoutWidget

  protected void layoutWidget(org.eclipse.swt.widgets.Control control,
                  String elementName,
                  Map<String,String> attributes)

  Parameters:

  elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null

• endBuild

  protected void endBuild()

• initNestedMetawidget

  protected void initNestedMetawidget(SwtMetawidget nestedMetawidget,
                          Map<String,String> attributes)