Oxygen XML Editor 14.2 Author API

ro.sync.exml.workspace.api.standalone
Class ViewInfo

java.lang.Object
  extended by ro.sync.exml.workspace.api.standalone.ViewInfo

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class ViewInfo
extends java.lang.Object

Information about a view.

Since:
11.2

Constructor Summary
ViewInfo(java.lang.String viewID, javax.swing.JComponent component, java.lang.String title, javax.swing.Icon icon)
          Constructor
 
Method Summary
 javax.swing.JComponent getComponent()
          Get the current component this view will display
 javax.swing.Icon getIcon()
          Get the current view icon
 java.lang.String getTitle()
          Get the view title
 java.lang.String getViewID()
          Gets the ID of the view.
 boolean isCustomized()
          Check if the view information has been customized.
 void setComponent(javax.swing.JComponent component)
          Set a new component to be displayed in the view
 void setIcon(javax.swing.Icon icon)
          Set the current view icon
 void setTitle(java.lang.String title)
          Set a new view title.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewInfo

public ViewInfo(java.lang.String viewID,
                javax.swing.JComponent component,
                java.lang.String title,
                javax.swing.Icon icon)
Constructor

Parameters:
viewID - The unique view ID
component - The component which will be placed inside
title - Title for the view
icon - The view's icon
Method Detail

getViewID

public java.lang.String getViewID()
Gets the ID of the view.

Returns:
The ID of the view.

getComponent

public javax.swing.JComponent getComponent()
Get the current component this view will display

Returns:
Returns the component.

getTitle

public java.lang.String getTitle()
Get the view title

Returns:
Returns the title.

setComponent

public void setComponent(javax.swing.JComponent component)
Set a new component to be displayed in the view

Parameters:
component - The component to set.

setTitle

public void setTitle(java.lang.String title)
Set a new view title.

Parameters:
title - The title to set.

getIcon

public javax.swing.Icon getIcon()
Get the current view icon

Returns:
Returns the icon.

setIcon

public void setIcon(javax.swing.Icon icon)
Set the current view icon

Parameters:
icon - The icon to set.

isCustomized

public boolean isCustomized()
Check if the view information has been customized.

Returns:
true if the view information has been customized.

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.