Package io.guise.framework.platform

Interface DepictedObject

All Known Subinterfaces:
ActionControl, ActionValueControl<V>, ApplicationFrame, ArrangeContainer, Box, ButtonControl, CardContainer, CardControl, Component, CompositeComponent, Container, ContainerControl, ContentComponent, Control, DialogFrame<V>, EditComponent, FlyoverFrame, Frame, HeadingComponent, ImageComponent, InputFocusableComponent, InputFocusGroupComponent, LabelComponent, LabelDisplayableComponent, LayoutComponent, LayoutControl, LinkControl, ListSelectControl<V>, Menu, ModalComponent<M>, ModalFrame<R>, ModalNavigationPanel<R>, NavigationComponent, OptionDialogFrame<O>, Panel, PendingImageComponent, SectionComponent, SelectActionControl, SelectButtonControl, SelectControl<V>, SelectLinkControl, ToolButtonControl, ValueControl<V>, ValuedComponent<V>, Widget
All Known Implementing Classes:
AboutPanel, AbstractActionControl, AbstractActionValueControl, AbstractApplicationFrame, AbstractArrayCompositeComponent, AbstractBooleanSelectActionControl, AbstractBox, AbstractButtonControl, AbstractCardPanel, AbstractComponent, AbstractCompositeComponent, AbstractCompositeStateComponent, AbstractCompositeStateControl, AbstractContainer, AbstractContainerControl, AbstractContainerValueControl, AbstractControl, AbstractDepictedObject, AbstractDialogFrame, AbstractEditComponentTextControl, AbstractEditValueControl, AbstractEditValuePanel, AbstractEnumCompositeComponent, AbstractFlyoverFrame, AbstractFrame, AbstractImageComponent, AbstractLabel, AbstractLayoutComponent, AbstractLayoutControl, AbstractLayoutValueControl, AbstractLinkControl, AbstractListCompositeComponent, AbstractListSelectContainerControl, AbstractListSelectControl, AbstractMenu, AbstractModalFrame, AbstractModalNavigationPanel, AbstractMultipleCompositeComponent, AbstractOptionDialogFrame, AbstractPanel, AbstractSelectActionControl, AbstractSelectActionValueControl, AbstractSequenceTaskPanel, AbstractSingleCompositeComponent, AbstractTextControl, AbstractValueControl, AbstractValuedPanel, AccordionMenu, ArrangePanel, Audio, AutoNavigationPathBreadcrumbLinkPanel, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, BooleanValueControlSelectControl, BusyPanel, Button, CalendarControl, CalendarDialogFrame, CardPanel, CardTabControl, CheckControl, DateTimeControl, DateTimeFieldsControl, DefaultApplicationFrame, DefaultDialogFrame, DefaultFlyoverFrame, DefaultFrame, DefaultModalFrame, DefaultModalNavigationPanel, DropMenu, EditComponentLabelControl, EditComponentTextControl, Flash, GroupPanel, Heading, HeadingLink, Image, ImageActionControl, ImageBooleanSelectActionControl, Label, LayoutPanel, LikeButton, Link, ListControl, Message, MessageOptionDialogFrame, NamePanel, NavigationPathBreadcrumbLinkPanel, NotificationOptionDialogFrame, PasswordAuthenticationPanel, PendingImage, PendingImageActionControl, Picture, PlatformFileCollector, PlatformFileUploadPanel, ResourceCollectControl, ResourceImportControl, ScrollControl, SectionPanel, SelectableLabel, SelectButton, SelectLink, SequenceCardPanel, SliderControl, SpinnerControl, TabbedPanel, TabContainerControl, TabControl, Table, Table.DefaultCellMessage, TaskStateSelectLink, TextBox, TextControl, Toolbar, ToolButton, TreeControl, ValueSelectButton, ValueSelectLink
public interface DepictedObject
An object that can be depicted on some platform.
Author:
Garret Wilson

  • Method Details

    • getSession

      GuiseSession getSession()
      Returns:
      The Guise session that owns this object.

    • getDepictID

      long getDepictID()
      Returns:
      The object depiction identifier.

    • getDepictor

      Depictor<? extends DepictedObject> getDepictor()
      Returns:
      The depictor for this object.

    • exportTransfer

      Transferable<?> exportTransfer()
      Exports data from the depicted object. Each export strategy, from last to first added, will be asked to export data, until one is successful.
      Returns:
      The object to be transferred, or null if no data can be transferred.

    • processEvent

      void processEvent(PlatformEvent event)
      Processes an event from the platform. This method delegates to the currently installed depictor.
      Parameters:
      event - The event to be processed.
      Throws:
      IllegalArgumentException - if the given event is a relevant DepictEvent with a source of a different depicted object.
      See Also:

    • depict

      void depict() throws IOException
      Updates the depiction of the object. The depiction will be marked as updated. This method delegates to the currently installed depictor.
      Throws:
      IOException - if there is an error updating the depiction.
      See Also: