Class MetadataSummary

Object
Widget
MetadataSummary
All Implemented Interfaces:
Localized
@DefaultProperty("metadata") public class MetadataSummary extends Widget
A panel showing a summary of metadata.
Since:
1.1

  • Field Details

  • Constructor Details

    • MetadataSummary

      public MetadataSummary()
      Creates an initially empty metadata overview.

  • Method Details

    • getView

      public final Region getView()
      Returns the region containing the visual components managed by this Metadata­Summary. The subclass is implementation dependent and may change in any future version.
      Specified by:
      get­View in class Widget
      Returns:
      the region to show.

    • setMetadata

      public void setMetadata(Resource resource)
      Fetches the metadata in a background thread and delegates to set­Metadata(Metadata) when ready.
      Parameters:
      resource - the resource for which to show metadata, or null.

    • setMetadata

      public final void setMetadata(Metadata metadata)
      Sets the content of this pane to the given metadata. This is a convenience method for setting metadata­Property value.
      Parameters:
      metadata - the metadata to show, or null.
      See Also:

    • getMetadata

      public final Metadata getMetadata()
      Returns the metadata currently shown, or null if none. This is a convenience method for fetching metadata­Property value.
      Returns:
      the metadata currently shown, or null if none.
      See Also:

    • setError

      public final void setError(Throwable exception)
      Clears the metadata panel and write instead an exception report.
      Parameters:
      exception - the exception that occurred.

    • getLocale

      public final Locale getLocale()
      Returns the locale used by this widget for controls and messages.
      Specified by:
      get­Locale in interface Localized
      Overrides:
      get­Locale in class Widget
      Returns:
      the locale for controls in this widget.