com.aelitis.azureus.ui.swt.skin
Interface SWTSkinObject

All Superinterfaces:
PluginUISWTSkinObject
All Known Subinterfaces:
SWTSkinObjectText
All Known Implementing Classes:
SWTSkinObjectBasic, SWTSkinObjectBrowser, SWTSkinObjectButton, SWTSkinObjectCheckbox, SWTSkinObjectCombo, SWTSkinObjectContainer, SWTSkinObjectExpandBar, SWTSkinObjectExpandItem, SWTSkinObjectImage, SWTSkinObjectImage2, SWTSkinObjectSash, SWTSkinObjectSeparator, SWTSkinObjectSlider, SWTSkinObjectTab, SWTSkinObjectTabFolder, SWTSkinObjectText1, SWTSkinObjectText2, SWTSkinObjectTextbox, SWTSkinObjectToggle

public interface SWTSkinObject
extends PluginUISWTSkinObject

Author:
TuxPaper

Method Summary
 void addListener(SWTSkinObjectListener listener)
           
 void dispose()
           
 String getConfigID()
          Retrieve the Config ID which is ID in the skin config file.
 org.eclipse.swt.widgets.Control getControl()
          Retrieve the associated SWT Control used by the skin object
 Object getData(String id)
           
 boolean getDefaultVisibility()
           
 SWTSkinObjectListener[] getListeners()
           
 SWTSkinObject getParent()
           
 SWTSkinProperties getProperties()
           
 SWTSkin getSkin()
           
 String getSkinObjectID()
          Retrieve the Skin Object ID that represents this object.
 SkinView getSkinView()
           
 String getSuffix()
           
 String getTooltipID(boolean walkup)
           
 String getType()
          Retrieve the type of widget.
 String getViewID()
           
 boolean isDebug()
           
 boolean isDisposed()
           
 boolean isVisible()
           
 void layoutComplete()
           
 void relayout()
           
 void removeListener(SWTSkinObjectListener listener)
           
 void setBackground(String sConfigID, String sSuffix)
           
 void setData(String id, Object data)
           
 void setDebug(boolean b)
           
 void setDefaultVisibility()
           
 void setObfusticatedImageGenerator(ObfusticateImage obfusticatedImageGenerator)
           
 void setProperties(SWTSkinProperties skinProperties)
           
 void setSkinView(SkinView sv)
           
 void setTooltipID(String id)
           
 void setVisible(boolean visible)
           
 String switchSuffix(String suffix)
          Convenience method for switching suffix using defaults
 String switchSuffix(String suffix, int level, boolean walkUp)
           
 String switchSuffix(String suffix, int level, boolean walkUp, boolean walkDown)
           
 void triggerListeners(int eventType)
           
 void triggerListeners(int eventType, Object params)
           
 

Method Detail

getControl

org.eclipse.swt.widgets.Control getControl()
Retrieve the associated SWT Control used by the skin object

Returns:
SWT Control

getType

String getType()
Retrieve the type of widget.

Returns:
TODO Move widget types to SWTSkinObject

getSkinObjectID

String getSkinObjectID()
Retrieve the Skin Object ID that represents this object. Typically the same as getConfigID(), however, may be different if a config id is used to make independant copies

Returns:
An unique Skin Object ID

getConfigID

String getConfigID()
Retrieve the Config ID which is ID in the skin config file.

Returns:
Config ID

getParent

SWTSkinObject getParent()

getSkin

SWTSkin getSkin()

setVisible

void setVisible(boolean visible)

isVisible

boolean isVisible()

setDefaultVisibility

void setDefaultVisibility()

setBackground

void setBackground(String sConfigID,
                   String sSuffix)
Parameters:
sConfigID -
sSuffix -

switchSuffix

String switchSuffix(String suffix,
                    int level,
                    boolean walkUp)
Parameters:
suffix -
level -
walkUp - TODO
Returns:
TODO

switchSuffix

String switchSuffix(String suffix,
                    int level,
                    boolean walkUp,
                    boolean walkDown)

switchSuffix

String switchSuffix(String suffix)
Convenience method for switching suffix using defaults

Parameters:
suffix -
Returns:

getSuffix

String getSuffix()
Returns:

setProperties

void setProperties(SWTSkinProperties skinProperties)
Parameters:
properties -

getProperties

SWTSkinProperties getProperties()
Returns:

addListener

void addListener(SWTSkinObjectListener listener)

removeListener

void removeListener(SWTSkinObjectListener listener)

getListeners

SWTSkinObjectListener[] getListeners()
Returns:

getViewID

String getViewID()

triggerListeners

void triggerListeners(int eventType)
Parameters:
eventType -

triggerListeners

void triggerListeners(int eventType,
                      Object params)
Parameters:
eventType -
params -

dispose

void dispose()
Since:
3.0.1.3

setTooltipID

void setTooltipID(String id)
Parameters:
id -
Since:
3.0.4.3

getDefaultVisibility

boolean getDefaultVisibility()
Returns:
Since:
3.0.5.3

getData

Object getData(String id)

setData

void setData(String id,
             Object data)

isDisposed

boolean isDisposed()
Returns:
Since:
3.1.1.1

isDebug

boolean isDebug()
Returns:
Since:
3.1.1.1

getTooltipID

String getTooltipID(boolean walkup)
Parameters:
walkup -
Returns:
Since:
3.1.1.1

setDebug

void setDebug(boolean b)
Parameters:
b -
Since:
3.1.1.1

relayout

void relayout()

layoutComplete

void layoutComplete()

setObfusticatedImageGenerator

void setObfusticatedImageGenerator(ObfusticateImage obfusticatedImageGenerator)

getSkinView

SkinView getSkinView()

setSkinView

void setSkinView(SkinView sv)